MyBatis获取自增长ID

官方文档：http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html#insert_update_and_delete

 

在使用关系型数据库MySQL、SQL Server时，会有使用自增长主键的情况，为了获取到数据库内部自动生成的主键，可以使用useGeneratedKeys属性、<selectKey>标签的方式；而对于Oracle这种不支持自增长主键的数据库来说，则使用<selectKey>标签查询SEQUENCE序列的方式来获取到主键。

 

一.XML方式

1. 属性说明

• useGeneratedKeys：（仅对 insert 和 update 有用）这会让MyBatis使用JDBC的getGeneratedKeys方法获取自增长ID，默认值false
• keyProperty：（仅对 insert 和 update 有用）唯一标记一个属性。MyBatis会通过getGeneratedKeys的返回值或者通过insert元素下的<selectKey>标签设置它的键值。若希望得到多个生成的列，用逗号分隔属性名称。

2. 获取方式

(1). MySQL、SQL Server数据库

方式一：useGeneratedKeys属性

useGeneratedKeys设置true，默认false；keyProperty设置生成的自增长值所绑定的属性，如参数对象User有id属性，设置keyProperty="id"即会将值绑定到参数对象User对应的属性上。

<insert id="saveUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
	insert into t_user (user_name, user_sex) values (#{user_name, #{user_sex}})
</insert>

Service层测试代码：

User user = new User();
user.setUser_name("姓名");
user.setUser_sex(1);
userMapper.saveUser(user);
System.out.println("id：" + user.getId());// 获取自增长id

方式二：<selectKey>标签

通过<selectKey>标签，属性解释：order="AFTER"（默认值BEFORE）：先执行插入语句，之后执行selectKey标签的SQL，同时User的id会被设置。

<insert id="saveUser" parameterType="User">  
    <selectKey keyProperty="id" resultType="int" order="AFTER">  
        select LAST_INSERT_ID()  
    </selectKey>  
    insert t_user (user_name, user_sex) 
    values (#{user_name}, #{user_sex})  
</insert>  

测试代码同方式一

 

selectKey 元素描述如下：

<selectKey
  keyProperty="id"
  resultType="int"
  order="BEFORE"
  statementType="PREPARED">

selectKey属性

属性	描述
keyProperty	selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
keyColumn	匹配属性的返回结果集中的列名称。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
resultType	结果的类型。MyBatis 通常可以推算出来，但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型，包括字符串。如果希望作用于多个生成的列，则可以使用一个包含期望属性的 Object 或一个 Map。
order	这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 - 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。
statementType	与前面相同，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 语句的映射类型，分别代表 PreparedStatement 和 CallableStatement 类型。

(2). Oracle数据库

通过<selectKey>查询SEQUENCE序列，并设置到参数对象对应属性上。

 

二.注解方式

1. @Options注解

对应于XML方式中的使用useGeneratedKeys属性，配置属性一致，只是改成了注解方式

@Insert("insert into t_user(user_name, user_sex) values(#{user_name}, #{user_sex})")
@Options(useGeneratedKeys = true, keyProperty = "id")
public int save(User user);

2. @SelectKey注解

对应于XML方式中的<selectKey>标签

@Insert("insert into t_user(user_name, user_sex) values(#{user_name}, #{user_sex})")
@SelectKey(keyProperty = "id", resultType = int.class, before = false,
	statement = "select LAST_INSERT_ID()"
)
public int save(User user);