MyBatis+MySQL 返回插入的主键ID

需求：使用MyBatis往MySQL数据库中插入一条记录后，需要返回该条记录的自增主键值。

 

方法：在mapper中指定keyProperty属性，示例如下：

Xml代码  

1. <insert id="insertAndGetId" useGeneratedKeys="true" keyProperty="uId" parameterType="com.chenzhou.mybatis.User">  
2.     insert into user(userName,password,comment)  
3.     values(#{userName},#{password},#{comment})  
4. </insert>  

 如上所示，我们在insert中指定了keyProperty="uId"，其中uId代表插入的User对象的主键属性。

如果mybaities报错无法识别这个uId,我们需要查看这个uid是否在返回对象实体类里，名称是否相同。最好和数据库主键名相同，如果还是不行，把uId改成（传入对象）.uId 比如user.uId

我们使用这种方式需要知其然也有知其所以然。

1.insert 属性详解：

 parameterType ，入参的全限定类名或类型别名

   keyColumn ，设置数据表自动生成的主键名。对特定数据库（如PostgreSQL），若自动生成的主键不是第一个字段则必须设置

   keyProperty ，默认值unset，用于设置getGeneratedKeys方法或selectKey子元素返回值将赋值到领域模型的哪个属性中

   useGeneratedKeys ，取值范围true|false(默认值)，设置是否使用JDBC的getGenereatedKeys方法获取主键并赋值到keyProperty设置的领域模型属性中。MySQL和SQLServer执行auto-generated key field，因此当数据库设置好自增长主键后，可通过JDBC的getGeneratedKeys方法获取。但像Oralce等不支持auto-generated key field的数据库就不能用这种方法获取主键了

   statementType ，取值范围STATEMENT,PREPARED（默认值）,CALLABLE

   flushCache ，取值范围true(默认值)|false，设置执行该操作后是否会清空二级缓存和本地缓存

   timeout ，默认为unset（依赖jdbc驱动器的设置），设置执行该操作的最大时限，超时将抛异常

   databaseId ，取值范围oracle|mysql等，表示数据库厂家，元素内部可通过`<if test="_databaseId = 'oracle'">`来为特定数据库指定不同的sql语句

2.数据库需要支持自增主键(mysql、sqlserver)

使用insert、update标签中的useGeneratedKeys、keyProperty来获取主键返回值，useGeneratedKeys设置为true，keyProperty设置为主键对应实体类的属性值，如果是联合主键那么属性名用逗号隔开；insert时，返回的是新增记录的主键值、update时返回的时更新记录的主键值

useGeneratedKeys="true" keyProperty="id"

 <insert id="insertSelective" parameterType="testmaven.entity.User" useGeneratedKeys="true" keyProperty="id">
  insert into user(name,age) values (#{name,jdbcType=VARCHAR},#{age,jdbcType=INTEGER}) 
 </insert>

同理，如果插入多条记录，只要设置了useGeneratedKeys、keyProperty，同样可以获取主键；

<insert id="insertBatch"  useGeneratedKeys="true" keyProperty="id">
      insert into user(name,age) values
      <foreach collection="list" separator=","  item="item">
         (#{item.name,jdbcType=VARCHAR},#{item.age,jdbcType=INTEGER}) 
      </foreach>
  </insert>

3.非mysql数据库，数据库不支持自增主键（oracle）

在数据库不支持自增主键情况下，需要使用selectKey来返回插入的主键值。

---

selectKey属性

<selectKey resultType="java.lang.Integer" order="AFTER" keyProperty="id">
            select last_insert_id() as id
 </selectKey>

属性名	作用
resultType	selectKey指定sql返回值类型
order	执行顺序，after，表示后执行；before，表示限制性
keyProperty	主键对应实体类中的属性名字

---

插入记录后，获取主键（如mysql）

selectKey中的order=after，代表先执行insert into，后执行selectKey。此处利用mysql的last_insert_id函数来获取最后一条记录的id

<insert id="insert" parameterType="com.mycat.test.model.Test">
        INSERT INTO test(name) VALUES(#{name,jdbcType=VARCHAR})
        <selectKey resultType="java.lang.Integer" order="AFTER" keyProperty="id">
            select last_insert_id() as id
        </selectKey>
    </insert>

插入记录前，获取主键（如oracle）

注意，selectKey中的order=before，代表先执行selectKey，后执行insert into。此处利用sequence先获取id值，设置到sql中，然后返回主键。

<insert id="insert" parameterType="com.mycat.test.model.Test">
        INSERT INTO test(id,name) VALUES(#{id,jdbcType=INTEGER},
        #{name,jdbcType=VARCHAR})
        <selectKey resultType="java.lang.Integer" 
          order="before" keyProperty="id">
            select xx_sequence.nextval from dual
        </selectKey>
    </insert>