MyBatis—insert语句返回主键和selectKey标签

本文已同步至个人博客 liaosi's blog - MyBatis—insert语句返回主键和selectKey标签

往数据库中插入一条记录后，有时候我们需要这条记录的主键，用于后续的操作。如果在插入后再去查一次数据库，显然不够优雅和效率，MyBatis中已经有了insert后返回主键的功能，下面就主要讲几种不同情况的具体做法。

1.主键自增的情况

对于MySQL和Sql Server这种支持主键自增的数据库，可以设置useGeneratedKeys="true"和keyProperty。例如现在有一个表 tbl_employee，表有id，name，age，create_time四个字段，MyBatis映射文件中可以写成如下：

        INSERT INTO tbl_employee(name, age, create_time)
        VALUES(#{name}, #{age}, #{createTime})

useGeneratedKeys="true"：使用自动生成的主键
keyProperty：指定主键是(javaBean的)哪个属性。

useGeneratedKeys:
(insert and update only) This tells MyBatis to use the JDBC getGeneratedKeys method to retrieve keys generated internally by the database (e.g.auto increment fields in RDBMS like MySQL or SQL Server). Default: false

keyProperty:
(insert and update only) Identifies a property into which MyBatis will set the key value returned by getGeneratedKeys , or by a selectKey child element of the insert statement. Default: unset .
Can be a comma separated list of property names if multiple generated columns are expected.

2.Oracle中用Sequence获取主键

对于Oracle数据库，当要用到自增字段时，需要用到Sequence，假设我们现在已经创建了一个名字为SEQ_ADMIN的 Sequence，在MyBatis中的映射文件中可以结合selectKey标签使用。

    
    SELECT SEQ_ADMIN.NEXTVAL FROM DUAL
    
    INSERT INTO tbl_employee(id, name, age, create_time) 
    VALUES(#{id}, #{name}, #{age}, #{createTime})

order="BEFORE"表示SELECT SEQ_ADMIN.NEXTVAL FROM DUAL在 INSERT 语句执行之前先对id进行赋值。相反的，order还可以设置成AFTER，表示在INSERT语句执行完后，再查询一次slectKey标签中的语句，并赋值到Javabean的keyProperty的那个属性上。

源码分析

从源码上来分析，在BaseStatementHandler里面有生成generateKeys，主要是执行:

protected void generateKeys(Object parameter) {  
    KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();  
    ErrorContext.instance().store();  
    keyGenerator.processBefore(executor, mappedStatement, null, parameter);  
    ErrorContext.instance().recall();  
}  

processBefore，表示执行前处理，对应mapper里面的selectKey中的order="BEFORE"属性，先执行查询key，并设置到参数对象中。
在各个声明处理器中，update有代码：

KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();  
keyGenerator.processAfter(executor, mappedStatement, ps, parameterObject);

processAfter，表示执行后处理，对应mapper里面的selectKey中的order="AFTER"属性,表示执行后，再查一遍key，设置到参数对象中。