MyBatis中主键回填的两种实现方式

心已赠人 2022-02-15 06:44 258阅读 0赞

主键回填其实是一个非常常见的需求，特别是在数据添加的过程中，我们经常需要添加完数据之后，需要获取刚刚添加的数据 id，无论是 Jdbc 还是各种各样的数据库框架都对此提供了相关的支持，本文我就来和和大家分享下数据库主键回填在 MyBatis 中的两种实现思路。

# 原生写法 #

框架来源于我们学过的基础知识，主键回填实际上是一个在 JDBC 中就被支持的写法，有的小伙伴可能不知道这一点，因此这里我先来说说在 JDBC 中如何实现主键回填。

JDBC 中实现主键回填其实非常容易，主要是在构造 PreparedStatement 时指定需要主键回填，然后在插入成功后，查询刚刚插入数据的 id ，示例代码如下：

public int insert(Person person) { 
        Connection con = null;
        PreparedStatement ps = null;
        ResultSet rs = null;
        con = DBUtils.getConnection();
        ps = con.prepareStatement("INSERT INTO person(username,password,money) VALUES(?,?,?)", PreparedStatement.RETURN_GENERATED_KEYS);
        ps.setObject(1, person.getUsername());
        ps.setObject(2, person.getPassword());
        ps.setObject(3, person.getMoney());
        int i = ps.executeUpdate();
        rs = ps.getGeneratedKeys();
        int id = -1;
        if (rs.next()) { 
            id = rs.getInt(1);
        }
        return id;
    }

和普通的插入 SQL 不同之处主要体现在两个地方：

1.  第一个是构造 PreparedStatement 时，多了一个参数，指定了需要主键回填。
2.  在更新操作执行完成之后，调用 getGeneratedKeys ，然后又会获取到一个 ResultSet 对象，从这个游标集中就可以获取到刚刚插入数据的id。

这个是原生的写法，在 MyBatis 中，对此需求提供了两种不同的实现方案，下面分别来看。

# 框架写法 #

一般情况下，主键有两种生成方式：

1.  主键自增长
2.  自定义主键（一般可以使用UUID，或者类UUID）

如果是第二种，主键一般是在Java代码中生成，然后传入数据库执行插入操作，如果是第一个主键自增长，此时，Java 可能需要知道数据添加成功后的主键。

MyBatis 的基本用法就无需多说了，这也不是本文的重点，我们还是来看看 MyBatis 中主键回填的两种不同实现方式吧！

## 方式一 ##

第一种方式比较简单，也是松哥推荐的一种实现方式：

<insert id="insertBook" useGeneratedKeys="true" keyProperty="id">
        insert into t_book (b_name,author) values (#{name},#{author});
    </insert>

这种方式比较简单，就是在插入节点上添加 useGeneratedKeys 属性，同时设置接收回传主键的属性。配置完成后，我们执行一个插入操作，插入时传入一个对象，插入完成后，这个对象的 id 就会被自动赋值，值就是刚刚插入成功的id。

松哥推荐大家使用这种方式，原因很简单，这种方式实现简便省事。

## 方式二 ##

第二种方式则是利用MySQL自带的 `last_insert_id()` 函数查询刚刚插入的id，示例代码如下：

<insert id="insertBook">
        <selectKey keyProperty="id" resultType="java.lang.Integer">
            SELECT LAST_INSERT_ID()
        </selectKey>
        insert into t_book (b_name,author) values (#{ name},#{ author});
    </insert>

这种方式是在 insert 节点中添加 selectKey 来实现主键回填，实际上这种方式的功能更加丰富，因为 selectKey 节点中的 SQL 我们既可以在插入之前执行，也可以在插入之后执行（通过设置节点的 Order 属性为 AFTER 或者 BEFORE 可以实现），具体什么时候执行，还是要看具体的需求，如果是做主键回填，我们当然需要在插入 SQL 执行之后执行 selectKey 节点中的 SQL。

注意第二种方式一样也要通过设置 keyProperty 来指定将查询到的数据绑定到哪个属性上。

# 总结 #

好了，本文向大家介绍了 MyBatis 中主键回填的两种方式，大家有没有 get 到呢？有问题欢迎留言讨论。

关注公众号【江南一点雨】，专注于 Spring Boot+微服务，定期视频教程分享，关注后回复 Java ，领取松哥为你精心准备的 Java 干货！  
![javaboy.jpg][]

[javaboy.jpg]: /images/20220215/39674df12db248ea867fda90b90b9dfe.png