深入浅出 MyBatis 之返回主键 ID

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

0x01：添加单一记录时返回主键ID

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

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

• xml映射器

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

<mapper namespace="org.chench.test.mybatis.mapper">
    <!-- 插入数据:返回记录主键id值 -->
    <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对象获取主键属性值

0x02：添加批量记录时返回主键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 元素构建批量添加语句。

0x03：获取主键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 添加操作的时序图：

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

喜欢，在看