MyBatis获取自增主键

在日常开发业务中，有许多需要和id属性进行关联的其他数据，需要返回新增之后该条数据所对应的主键信息。对于MyBatis的自增主键，在执行insert语句之前，MySQL数据库会自动生成一个自增主键。在insert执行之后，通过MySQL的函数 LAST_INSERT_ID() 来获取刚刚插入记录的自增主键（即取出最后一个主键）。

1、selectKey标签

使用MyBatis提供的<selectKey>标签配置获取自增主键，在映射文件中可以配置以下信息：

<!-- 新增用户 -->
<insert id="insertUser" parameterType="com.pjb.mybatis.po.User">
    <selectKey keyProperty="userId" order="AFTER" resultType="java.lang.Integer">
        SELECT LAST_INSERT_ID()
    </selectKey>
    INSERT INTO tb_user(user_name,blog_url,remark)
    VALUES(#{userName},#{blogUrl},#{remark})
</insert>

在<insert>标签中添加<selectKey>标签对，其中放置了一个SQL函数 SELECT LAST_INSERT_ID() ，用于查询MySQL的最后一个自增主键。其中order参数表示该SQL函数相对于insert语句的执行时间，是在其之前（before）还是之后（after）。resultType即是该SQL函数执行的结果对应的数据类型。程序执行完insert之后，就可以在测试类中，从user对象中直接拿到该id的信息（取出的主键信息会放置在输入参数user对象中）。

【示例】新增用户信息，并返回该条数据对应的自增主键。

（1）创建用户信息持久化类（User.java）。

package com.pjb.mybatis.po;

/**
 * 用户信息的持久化类
 * @author pan_junbiao
 **/
public class User
{
    private int userId; //用户编号
    private String userName; //'用户姓名'
    private String blogUrl; //博客地址
    private String remark; //备注

    //省略getter与setter方法...
}

（2）配置SQL映射文件。

<!-- 新增用户 -->
<insert id="insertUser" parameterType="com.pjb.mybatis.po.User">
    <selectKey keyProperty="userId" order="AFTER" resultType="java.lang.Integer">
        SELECT LAST_INSERT_ID()
    </selectKey>
    INSERT INTO tb_user(user_name,blog_url,remark)
    VALUES(#{userName},#{blogUrl},#{remark})
</insert>

（3）编写执行方法。

/**
 * 新增用户
 * @author pan_junbiao
 */
@Test
public void insertUser()
{
    DataConnection dataConnection = new DataConnection();
    SqlSession sqlSession = dataConnection.getSqlSession();
    //创建新用户
    User user = new User();
    user.setUserName("pan_junbiao的博客");
    user.setBlogUrl("https://blog.csdn.net/pan_junbiao");
    user.setRemark("您好，欢迎访问 pan_junbiao的博客");
    //执行新增方法
    int result = sqlSession.insert("test.insertUser",user);
    //提交
    sqlSession.commit();
    //打印结果
    System.out.println("执行结果：" + result);
    System.out.println("自增主键：" + user.getUserId());
    sqlSession.close();
}

执行结果：

 

2、useGeneratedKeys属性、keyProperty属性

还有一种获取自增主键的方式，就是在<insert>标签中添加useGeneratedKeys属性和keyProperty属性，其中useGeneratedKeys属性表示使用自增主键，而keyProperty属性是Java包装类对象的属性名。配置如下：

<!-- 新增用户 -->
<insert id="insertUser" useGeneratedKeys="true" keyProperty="userId" parameterType="com.pjb.mybatis.po.User">
    INSERT INTO tb_user(user_name,blog_url,remark)
    VALUES(#{userName},#{blogUrl},#{remark})
</insert>

进行完上面的设置，MyBatis执行完insert语句后，会自动将自增长id值赋给对象User的属性userId，然后在逻辑处理层就可以通过User类的get方法获取该自增主键值。

 

3、非自增主键

关于非自增主键信息的获取，例如uuid类型和Oracle的序列主键nextval，它们都是在insert之前生成的，其实就是执行了SQL的uuid()方法及nextval()方法，所以SQL映射文件的配置与上面的配置类似，依然使用<selectKey>标签对，但是order属性被设置为before（因为是在insert之前执行），resultType根据主键实际类型设定。

uuid配置如下：

<selectKey keyProperty="userId" order="BEFORE" resultType="java.lang.String">
    SELECT uuid()
</selectKey>

Oracle序列配置如下：

<selectKey keyProperty="userId" order="BEFORE" resultType="java.lang.String">
    SELECT 序列名.nextval() FROM DUAL
</selectKey>