深入浅出mybatis之返回主键ID

秒速五厘米 2022-04-22 04:12 309阅读 0赞

![722072-20180521151159514-1353367771.png][]

## 目录 ##

*  [添加单一记录时返回主键ID][ID]
    
     *  [在映射器中配置获取记录主键值][Link 1]
     *  [获取新添加记录主键字段值][Link 2]
 *  [添加批量记录时返回主键ID][ID 1]
 *  [获取主键ID实现原理][ID 2]

添加记录后获取主键ID，这是一个很常见的需求，特别是在一次前端调用中需要插入多个表的场景。  
除了添加单条记录时获取主键值，有时候可能需要获取批量添加记录时各记录的主键值，MyBatis从3.3.1版本开始支持批量添加记录并返回各记录主键字段值。

## 添加单一记录时返回主键ID ##

添加一条记录时返回主键值，在xml映射器和接口映射器中都可以实现。

### 在映射器中配置获取记录主键值 ###

*  xml映射器

在定义xml映射器时设置属性useGeneratedKeys值为true，并分别指定属性keyProperty和keyColumn为对应的数据库记录主键字段与Java对象的主键属性。

<mapper namespace="org.chench.test.mybatis.mapper">
        
        <insert id="insertOneTest" parameterType="org.chench.test.mybatis.model.Test" useGeneratedKeys="true" keyProperty="id" keyColumn="id" >
            insert into test(name,descr,url,create_time,update_time) 
            values(#{name},#{descr},#{url},now(),now())
        </insert>
    </mapper>

*  接口映射器

在接口映射器中通过注解`@Options`分别设置参数useGeneratedKeys，keyProperty，keyColumn值

// 返回主键字段id值
    @Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
    @Insert("insert into test(name,descr,url,create_time,update_time) values(#{name},#{descr},#{url},now(),now())")
    Integer insertOneTest(Test test);

### 获取新添加记录主键字段值 ###

需要注意的是，在MyBatis中添加操作返回的是记录数并非记录主键id。因此，如果需要获取新添加记录的主键值，需要在执行添加操作之后，直接读取Java对象的主键属性。

Integer rows = sqlSession.getMapper(TestMapper.class).insertOneTest(test);
    System.out.println("rows = " + rows); // 添加操作返回记录数
    System.out.println("id = " + test.getId()); // 执行添加操作之后通过Java对象获取主键属性值

## 添加批量记录时返回主键ID ##

如果希望执行批量添加并返回各记录主键字段值，只能在xml映射器中实现，在接口映射器中无法做到。

<insert id="insertBatchTest" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO test(name,descr,url,create_time,update_time) VALUES
            <foreach collection="list" separator="," item="t">
            (#{t.name},#{t.descr},#{t.url},now(),now())
            </foreach>
    </insert>

可以看到，执行批量添加并返回记录主键值的xml映射器配置，跟添加单条记录时是一致的。不同的地方仅仅是使用了foreach元素构建批量添加语句。

## 获取主键ID实现原理 ##

需要注意的是，不论在xml映射器还是在接口映射器中，添加记录的主键值并非添加操作的返回值。实际上，在MyBatis中执行添加操作时只会返回当前添加的记录数。

package org.apache.ibatis.executor.statement;
    public class PreparedStatementHandler extends BaseStatementHandler {
        @Override
        public int update(Statement statement) throws SQLException {
            PreparedStatement ps = (PreparedStatement) statement;
            // 真正执行添加操作的SQL语句
            ps.execute();
            int rows = ps.getUpdateCount();
            Object parameterObject = boundSql.getParameterObject();
            KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
            // 在执行添加操作完毕之后，再处理记录主键字段值
            keyGenerator.processAfter(executor, mappedStatement, ps, parameterObject);
            // 添加记录时返回的是记录数，而并非记录的主键字段值
            return rows;
        }
    }

顺便看一下MyBatis添加操作的时序图：  
![722072-20180521151223539-5574235.png][]

跟踪时序图执行步骤可以看到，MyBatis最终是通过MySQL驱动程序获取到了新添加的记录主键值。

【参考】  
https://github.com/mybatis/mybatis-3/pull/350 Support insert multiple rows and write-back id.More about insert multipl...  
https://www.zhihu.com/question/21153827 mybatis 批量插入如何返回每个条记录的自生成主键？  
https://blog.csdn.net/jiangeeq/article/details/55047116 Mybatis批量插入返回插入成功后的主键id  
https://blog.csdn.net/top\_code/article/details/52404345 MyBatis 3.3.1 批量插入多行回写自增id

作者：[后端开发技术随笔][Link 3]  
出处：[http://www.cnblogs.com/nuccch/][Link 3]  
声明：本文版权归作者和博客园共有，欢迎转载，但请在文章页面明显位置给出原文连接。

[722072-20180521151159514-1353367771.png]: /images/20220422/45797d8c1fe6482ba01944bcb3ac3aff.png
[ID]: https://www.cnblogs.com/nuccch/p/9067305.html#%E6%B7%BB%E5%8A%A0%E5%8D%95%E4%B8%80%E8%AE%B0%E5%BD%95%E6%97%B6%E8%BF%94%E5%9B%9E%E4%B8%BB%E9%94%AEid
[Link 1]: https://www.cnblogs.com/nuccch/p/9067305.html#%E5%9C%A8%E6%98%A0%E5%B0%84%E5%99%A8%E4%B8%AD%E9%85%8D%E7%BD%AE%E8%8E%B7%E5%8F%96%E8%AE%B0%E5%BD%95%E4%B8%BB%E9%94%AE%E5%80%BC
[Link 2]: https://www.cnblogs.com/nuccch/p/9067305.html#%E8%8E%B7%E5%8F%96%E6%96%B0%E6%B7%BB%E5%8A%A0%E8%AE%B0%E5%BD%95%E4%B8%BB%E9%94%AE%E5%AD%97%E6%AE%B5%E5%80%BC
[ID 1]: https://www.cnblogs.com/nuccch/p/9067305.html#%E6%B7%BB%E5%8A%A0%E6%89%B9%E9%87%8F%E8%AE%B0%E5%BD%95%E6%97%B6%E8%BF%94%E5%9B%9E%E4%B8%BB%E9%94%AEid
[ID 2]: https://www.cnblogs.com/nuccch/p/9067305.html#%E8%8E%B7%E5%8F%96%E4%B8%BB%E9%94%AEid%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86
[722072-20180521151223539-5574235.png]: /images/20220422/736b11d58feb42aaade39f9cd81fb3be.png
[Link 3]: http://www.cnblogs.com/nuccch/