1. 概述

很多时候我们在使用mybatis执行insert操作时，需要返回插入数据的主键信息，默认情况下是mybatis返回的是影响或者说符合过滤条件的行数，而不会返回主键信息，这是由jdbc驱动决定的。

jdbc默认情况下，执行update、delete或者insert操作，可以通过getUpdateCount()方法来获取更新、删除和插入的“行数”，其实这个行数不是真正的更新、删除和插入的行数，而是受到影响的行数，特别是update和delete，他们实际返回的是符合过滤条件的行数，如果要返回真实行数，需要设置jdbc链接参数：

useAffectedRows=true  #例如jdbc:mysql://192.168.231.7:3306/test?useAffectedRows=true

而mybatis正是调用了这个一个方法，作为update、delete和insert的返回值。既然返回值不是id，那如何获取插入数据的id呢？在mybatis中主要有三种方法。

说明：以下所说的都是针对mysql而言。

2. useGeneratedKeys方式

2.1 xml配置

通过在xml文件的insert标签中设置useGeneratedKeys和keyProperty两个属性，mybatis会自动将自增主键的值赋值到keyProperty设置的实体属性上。例如：

 <insert id="insert" parameterType="com.test.UserDO" useGeneratedKeys="true" keyProperty="catId">
     insert into user (name, age,address)
     values (#{name,jdbcType=CHAR}, #{age,jdbcType=INT},#{address,jdbcType=CHAR})
</insert>

设置步骤：

• 设置useGeneratedKeys="true"
• 设置keyProperty="xx"，其中xx代表的是实体类对应的属性名称。

使用注意事项：

• 必须是自增主键，不支持自增逐渐的数据库无法使用，例如oracle。

2.2 注解配置

除了通过xml方式配置，还可以通过注解方式配置，只需要在接口方法上添加@Options注解即可，配置如下：

@Options(useGeneratedKeys = true, keyProperty = "id")

完整配置如下：

@Insert("insert into test(xxx,xxx,xxx) values (xxx,xxx,xxx)")
@Options(useGeneratedKeys = true, keyProperty = "id")
void insert(TestDO testDO);

2.3 原理

当mybatis设置了useGeneratedKeys时，表示使用数据库的自增主键。在jdbc驱动程序中，Statement接口中（PreparedStatement也继承了Statement）有一个getGeneratedKeys方法，此方法将返回当前插入数据的自增主键。例如以下代码：

Class.forName("com.mysql.cj.jdbc.Driver");
Connection connection = DriverManager.getConnection("jdbc:mysql://192.168.231.7:3306/test","root","root");
Statement statement = connection.createStatement();
boolean res = statement.execute("INSERT INTO  user ( name, age,address) VALUES ('xiaoming3', 11,'北京海淀')",Statement.RETURN_GENERATED_KEYS);
ResultSet generatedKeys = statement.getGeneratedKeys();
while (generatedKeys.next()){
       System.out.println(generatedKeys.getInt(1));
    }

通过getGeneratedKeys获取主键的前提有两个：

• 数据库必须是自增主键
• 执行execute方法中必须添加Statement.RETURN_GENERATED_KEYS参数，否则程序将出现错误。

我们在使用useGeneratedKeys=true时，mybatis将使用Statement.RETURN_GENERATED_KEYS方式执行sql语句，然后将获取的ResultSet中的主键值赋值给我们指定的keyProperty变量。

3. selectKey+last_insert_id方式

3.1 xml配置

通过在insert标签中配置selectKey标签，执行select last_insert_id的方式来获取主键的配置如下：

<insert id="insert" parameterType="com.test.UserDO" useGeneratedKeys="true" keyProperty="catId">
    <selectKey keyProperty="catId" resultType="long" order="AFTER">
        select last_insert_id();
    </selectKey>
    insert into user (name, age,address)
     values (#{name,jdbcType=CHAR}, #{age,jdbcType=INT},#{address,jdbcType=CHAR})
</insert>

selectKey参数解释：

• keyProperty：对应的实体类属性名称。
• resultType：返回数据类型。
• order：这个是一个非常关键的属性，表示和insert语句之间的执行顺序，order=“AFTER”，表示在执行insert语句后执行selectKey的内容，如果是BEFORE，则相反。

3.2 注解配置

通过注解方式配置如下：

@Insert("insert into test(xxx,xxx,xxx) values (xxx,xxx,xxx)")
@SelectKey(statement = "select last_insert_id()", keyProperty = "id", before = false, resultType = Long.class)
void insert(UserDO user);

参数说明：

• statement：执行的sql语句。
• keyProperty：实体类对应的属性。
• before：这个属性和xml配置中的order作用一样，如果before等于false，表示先执行insert；否则表示先执行select。

3.3 原理

SelectKey方式的原理比较简单，它是使用了mysql的last_insert_id()函数。这个函数有两种使用方式，一种是无参数的，一种是有参数的。

如果此函数没有参数，表示一个连接使用AUTO_INCREMENT定义的列最近一次执行insert语句插入的第一个值。怎么理解这句话呢？

• 如果一个连接是新建立的，使用一个连接执行一条insert操作，那么将返回插入的自增主键。
• 如果一个连接是新建立的，使用一个连接同时执行多条insert插入（可以理解为一个事务中多个insert），那么返回的是第一个插入语句对应的自增主键。
• 如果一个连接不是新建立的（我们一般使第三方数据源，c3p0或者druid等，这个时候是使用的连接池），如果你在程序中执行了insert，那么肯定是返回的肯定是最新插入一条的自增主键；如果你没有执行insert，而是直接执行了select last_insert_id，那么它将返回以前执行的最后一个插入的自增主键。
• 还有一种情况，那就是一个连接，没有执行过任何操作，你直接使用它执行select last_insert_id，那么返回值是啥呢？官方文档说的是一个不可预测的值，但是通过实验，基本返回的都是0。

注意：主键必须是AUTO_INCREMENT。

具体的话可以参考官方文档，并按照官方文档上的说明进行实践操作。

[官方文档] https://dev.mysql.com/doc/refman/8.0/en/information-functions.html#function_last-insert-id

4. 自定义方式

自定义方式也是使用selectKey，不过获取主键的方式不再使用select last_insert_id，而是通过自定义的方式从数据库中获取主键，例如：你的表中记录了每个表的主键的最大值，每次插入的时候都需要从表中获取最新的id，然后执行插入。这种方式和上面的selectKey方式最大的不同是先执行select，获取到主键后在执行insert。只要把上面的配置稍微改动即可：

<insert id="insert" parameterType="com.test.UserDO" useGeneratedKeys="true" keyProperty="catId">
    <selectKey keyProperty="catId" resultType="long" order="AFTER">
        <![CDATA[ 这里变成获取主键的select语句 ]]>
    </selectKey>
    insert into user (id,name, age,address)
     values (#{id},#{name,jdbcType=CHAR}, #{age,jdbcType=INT},#{address,jdbcType=CHAR})
</insert>

不足之处，多多指教