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

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

环境：

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

CREATE TABLE `user` (
	`id` INT(11) NOT NULL AUTO_INCREMENT,
	`user_name` VARCHAR(32) NULL DEFAULT NULL,
	`pass_word` VARCHAR(16) NULL DEFAULT NULL,
	`address` VARCHAR(16) NULL DEFAULT NULL,
	PRIMARY KEY (`id`)
)
COLLATE='utf8_general_ci'
ENGINE=InnoDB
;

DO

public class UserScope implements Serializable{

    /**
     * 姓名
     */
    private String userName;
    /**
     * 主键ID
     */
    private Integer id;
    /**
     * 密码
     */
    private String passWord;
    /**
     * 地址
     */
    private String address;
}

省略getter、setter。

DAO

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

    @Override
    public int addUserSelectKey(UserScope userScope){

        this.getSqlSession().insert("userMapper.insertSelectKey",userScope);
        System.out.println(userScope);
        return userScope.getId();//获取自增长主键值
    }

Mapper.xml

    
        insert user(user_name,pass_word,address) values (#{userName},#{passWord},#{address})
    
    
        
            select LAST_INSERT_ID()
        
        insert user(user_name,pass_word,address) values (#{userName},#{passWord},#{address})
    

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

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

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

DefaultSqlSession

  @Override
  public int update(String statement, Object parameter) {
    try {
      dirty = true;
      //这里是根据命名空间和ID获取要执行的sql的信息	
      MappedStatement ms = configuration.getMappedStatement(statement);
      return executor.update(ms, wrapCollection(parameter));//执行sql
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error updating database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

BaseExecutor

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

SimpleExecutor

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

PreparedStatementHandler

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

StatementHandler的UML图如下

KeyGenerator

和KeyGenerator相关的UML类图如下：

我们可以看到KeyGenerator有三个实现类：NoKeyGenerator、Jdbc3KeyGenerator、SelectKeyGenerator。NoKeyGenerator表示是没有设置返回自增长主键值的插入操作，

Jdbc3KeyGenerator表示处理useGeneratedKeys的方式组装sql，SelectKeyGenerator是使用的方式组装sql结果。下面我们来分析Jdbc3KeyGenerator这个类。

Jdbc3KeyGenerator

  public void processBatch(MappedStatement ms, Statement stmt, Collection