MyBatis获取自增长主键值的两种方式及源码浅析

昨天在做项目的时候遇到了一个坑，没错，就是获取MyBatis自增长主键值的坑。因为之前一直用ibatis，所以惯性的用了ibatis的写法，结果返回的值一直是1（受影响的行数）。于是去翻了翻MyBatis的源码，发现它把主键值放到了参数对象上，获取主键值需要用参数对象去get主键值。真是坑。我先把解决办法放出来，然后再接着分析MyBatis的源码是怎么做的。

环境：

数据库MySql、User表，主键设置为自增长。

[sql]

1. CREATE TABLE `user` (
2.     `id` INT(11) NOT NULL AUTO_INCREMENT,
3.     `user_name` VARCHAR(32) NULL DEFAULT NULL,
4.     `pass_word` VARCHAR(16) NULL DEFAULT NULL,
5.     `address` VARCHAR(16) NULL DEFAULT NULL,
6.     PRIMARY KEY (`id`)
7. )
8. COLLATE='utf8_general_ci'
9. ENGINE=InnoDB
10. ;

DO

[java]

1. public class UserScope implements Serializable{
3.     /**
4.      * 姓名
5.      */
6.     private String userName;
7.     /**
8.      * 主键ID
9.      */
10.     private Integer id;
11.     /**
12.      * 密码
13.      */
14.     private String passWord;
15.     /**
16.      * 地址
17.      */
18.     private String address;
19. }

省略getter、setter。

DAO

[java]

1. @Override
2. public void addUser(UserScope userScope) {
3.     this.getSqlSession().insert("userMapper.addUser",userScope);
4. }

[java]

1. @Override
2. public int addUserSelectKey(UserScope userScope){
4.     this.getSqlSession().insert("userMapper.insertSelectKey",userScope);
5.     System.out.println(userScope);
6.     return userScope.getId();//获取自增长主键值
7. }

Mapper.xml

[html]

1. <mapper namespace="userMapper">
2.     <insert id="addUser" parameterType="userScope" useGeneratedKeys="true" keyProperty="id">
3.         insert user(user_name,pass_word,address) values (#{userName},#{passWord},#{address})
4.     </insert>
5.     <insert id="insertSelectKey" parameterType="userScope">
6.         <selectKey keyProperty="id" resultType="int">
7.             select LAST_INSERT_ID()
8.         </selectKey>
9.         insert user(user_name,pass_word,address) values (#{userName},#{passWord},#{address})
10.     </insert>
11. </mapper>

上面写了两种方式用来获取自增长主键。一种是使用useGemeratedKeys，一种是使用<selectKey/>的方式。这两种方式获取自增长主键的ID的方式是一样的。都是从参数对象中获取自增长主键值。下面我们来根据源码来看一下MyBatis是怎么做的。

MyBatis插入操作获取自增长主键的时序图

我们先跳过前面的SqlSessionTemplate直接进入到DefaultSqlSession中

DefaultSqlSession

[java]

1. @Override
2. public int update(String statement, Object parameter) {
3.   try {
4.     dirty = true;
5.     //这里是根据命名空间和ID获取要执行的sql的信息<span style="white-space:pre">    </span>
6.     MappedStatement ms = configuration.getMappedStatement(statement);
7.     return executor.update(ms, wrapCollection(parameter));//执行sql
8.   } catch (Exception e) {
9.     throw ExceptionFactory.wrapException("Error updating database.  Cause: " + e, e);
10.   } finally {
11.     ErrorContext.instance().reset();
12.   }
13. }

BaseExecutor

[java]

1. @Override
2. public int update(MappedStatement ms, Object parameter) throws SQLException {
3.   ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());//记录操作信息，如果有异常的话，会从这里取异常信息
4.   if (closed) {
5.     throw new ExecutorException("Executor was closed.");
6.   }
7.   clearLocalCache();//清空本地缓存
8.   return doUpdate(ms, parameter);//执行sql
9. }

SimpleExecutor

[java]

1. public int doUpdate(MappedStatement ms, Object parameter) throws SQLException {
2.   Statement stmt = null;
3.   try {
4.     Configuration configuration = ms.getConfiguration();
5.     StatementHandler handler = configuration.newStatementHandler(this, ms, parameter, RowBounds.DEFAULT, null, null);//获取执行sql的Statement
6.     stmt = prepareStatement(handler, ms.getStatementLog());//封装StatementHandler的信息。打开连接、事务是否超时等。
7.     return handler.update(stmt);//执行sql
8.   } finally {
9.     closeStatement(stmt);
10.   }
11. }

PreparedStatementHandler

[java]

1. public int update(Statement statement) throws SQLException {
2.   PreparedStatement ps = (PreparedStatement) statement;
3.   ps.execute();//这里是调用的JDBC4PreparedStatement执行sql
4.   int rows = ps.getUpdateCount();//获取受影响的行数，也就是调用插入操作的时候返回的真正值。
5.   Object parameterObject = boundSql.getParameterObject();//获取参数对象
6.   KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();//判断是那种KeyGenerator
7.   keyGenerator.processAfter(executor, mappedStatement, ps, parameterObject);//根据KeyGenerator去set主键值
8.   return rows;
9. }

StatementHandler的UML图如下

KeyGenerator

和KeyGenerator相关的UML类图如下：

我们可以看到KeyGenerator有三个实现类：NoKeyGenerator、Jdbc3KeyGenerator、SelectKeyGenerator。NoKeyGenerator表示是没有设置返回自增长主键值的插入操作，
Jdbc3KeyGenerator表示处理useGeneratedKeys的方式组装sql，SelectKeyGenerator是使用<SelectKey/>的方式组装sql结果。下面我们来分析Jdbc3KeyGenerator这个类。

Jdbc3KeyGenerator

[java]

1. public void processBatch(MappedStatement ms, Statement stmt, Collection<Object> parameters) {
2.   ResultSet rs = null;
3.   try {
4.     rs = stmt.getGeneratedKeys();//获取执行结果值
5.     final Configuration configuration = ms.getConfiguration();
6.     final TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
7.     final String[] keyProperties = ms.getKeyProperties();//获取设置的keyProperty
8.     final ResultSetMetaData rsmd = rs.getMetaData();
9.     TypeHandler<?>[] typeHandlers = null;
10.     if (keyProperties != null && rsmd.getColumnCount() >= keyProperties.length) {//如果设置了keyProperty，则在参数对象中放入处理之后的结果值
11.       for (Object parameter : parameters) {
12.         // there should be one row for each statement (also one for each parameter)
13.         if (!rs.next()) {
14.           break;
15.         }
16.         final MetaObject metaParam = configuration.newMetaObject(parameter);
17.         if (typeHandlers == null) {
18.           typeHandlers = getTypeHandlers(typeHandlerRegistry, metaParam, keyProperties, rsmd);//keyProperty设置的字段类型的处理器
19.         }
20.         populateKeys(rs, metaParam, keyProperties, typeHandlers);//在参数对象中设置keyProperty的字段值
21.       }
22.     }

[java]

1. private void populateKeys(ResultSet rs, MetaObject metaParam, String[] keyProperties, TypeHandler<?>[] typeHandlers) throws SQLException {
2.   for (int i = 0; i < keyProperties.length; i++) {
3.     TypeHandler<?> th = typeHandlers[i];
4.     if (th != null) {
5.       Object value = th.getResult(rs, i + 1);
6.       metaParam.setValue(keyProperties[i], value);//在参数对象中设置keyProperty的字段值
7.     }
8.   }
9. }

[java]

1. public void setValue(String name, Object value) {
2.   PropertyTokenizer prop = new PropertyTokenizer(name);
3.   if (prop.hasNext()) {
4.     MetaObject metaValue = metaObjectForProperty(prop.getIndexedName());
5.     if (metaValue == SystemMetaObject.NULL_META_OBJECT) {
6.       if (value == null && prop.getChildren() != null) {
7.         // don't instantiate child path if value is null
8.         return;
9.       } else {
10.         metaValue = objectWrapper.instantiatePropertyValue(name, prop, objectFactory);
11.       }
12.     }
13.     metaValue.setValue(prop.getChildren(), value);
14.   } else {
15.     objectWrapper.set(prop, value);//在参数对象中设置keyProperty的字段值（根据反射来操作的）
16.   }
17. }

上面的objectWrapper为BeanWrapper，我们直接进入到BeanWrapper中。

[java]

1. private void setBeanProperty(PropertyTokenizer prop, Object object, Object value) {
2.   try {
3.     Invoker method = metaClass.getSetInvoker(prop.getName());
4.     Object[] params = {value};
5.     try {
6.       method.invoke(object, params);//设置参数对象的值
7.     }

对象组装器的类图如下：主要有对象组装器、集合组装器、Map组装器

这里的method为SetFieldInvoker。invoke的方法代码如下：

[java]

1. public Object invoke(Object target, Object[] args) throws IllegalAccessException, InvocationTargetException {
2.   field.set(target, args[0]);//这个field对象就是java.lang.reflect.Field对象。
3.   return null;
4. }

Invoker的类图如下：

批量插入：

MyBatis3.4.0之后已经支持批量插入并获取自增主键值了。例子如下：

[java]

1. public void addUserBatch(List<UserScope> list) {
3.     this.getSqlSession().insert("userMapper.addUserBatch",list);
4.     System.out.println(Arrays.toString(list.toArray()));
5. }

[java]

1. <insert id="addUserBatch" parameterType="java.util.List" useGeneratedKeys="true" keyProperty="id" keyColumn="id">
2.   insert user(user_name,pass_word,address) values
3.   <foreach collection="list" item="item" separator=",">
4.       ( #{item.userName},#{item.passWord},#{item.address} )
5.   </foreach>
6. </insert>

主键值已经设置到了list集合的对象中了，获取方法和普通插入的获取方式一样。

（文/木叶之荣）

本文来源：http://blog.csdn.net/zknxx/article/details/53558850