MyBatis中灵活的主键自增功能使用及其原理详解

<setting name="useGeneratedKeys" value="true"/>

<insert id="addUser_A" parameterType="User" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO `user`
    (`name`,`email`,`age`,`sex`,`schoolName`)
    VALUES
    (#{name},#{email},#{age},#{sex},#{schoolName})
</insert>

<insert id="addUser_B" parameterType="User">
    <selectKey resultType="java.lang.Integer" keyProperty="id" order="AFTER">
        SELECT LAST_INSERT_ID()
    </selectKey>
    INSERT INTO `user`
    (`name`,`email`,`age`,`sex`,`schoolName`)
    VALUES
    (#{name},#{email},#{age},#{sex},#{schoolName})
</insert>

// 处理SelectKey节点，在这里会将KeyGenerator加入到Configuration.keyGenerators中
processSelectKeyNodes(id, parameterTypeClass, langDriver);

// 原注释：此时，<selectKey> 和 <include> 节点均已被解析完毕并被删除
// 进行SQL解析
KeyGenerator keyGenerator;
String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;
keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);
// 判断是否已经有解析好的KeyGenerator
if (configuration.hasKeyGenerator(keyStatementId)) {
  keyGenerator = configuration.getKeyGenerator(keyStatementId);
} else {
  // 全局或者本语句只要启用自动key生成，则使用key生成
  keyGenerator = context.getBooleanAttribute("useGeneratedKeys",
      configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))
      ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
}

<insert id="addUser_D" parameterType="User">
    INSERT INTO `user`
    (`name`,`email`,`age`,`sex`,`schoolName`)
    VALUES
    (#{name},#{email},#{age},#{sex},#{schoolName})
</insert>

User user04 = new User("李二壮", 0, "KEYUAN SCHOOL");

// 使用NoKeyGenerator，即不使用主键自增功能
System.out.println("before insert :" + user04.toString());
result = session.insert("com.github.yeecode.mybatisdemo.dao.UserDao.addUser_D", user04);
System.out.println("insert result : " + result);
System.out.println("after insert :" + user04.toString());

<insert id="addUser_A" parameterType="User" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO `user`
    (`name`,`email`,`age`,`sex`,`schoolName`)
    VALUES
    (#{name},#{email},#{age},#{sex},#{schoolName})
</insert>

public void processBatch(MappedStatement ms, Statement stmt, Object parameter) {
  // 拿到主键的属性名
  final String[] keyProperties = ms.getKeyProperties();
  if (keyProperties == null || keyProperties.length == 0) {
    // 没有主键则无需操作
    return;
  }
  // 调用Statement对象的getGeneratedKeys方法获取自动生成的主键值
  try (ResultSet rs = stmt.getGeneratedKeys()) {
    // 获取输出结果的描述信息
    final ResultSetMetaData rsmd = rs.getMetaData();
    final Configuration configuration = ms.getConfiguration();
    if (rsmd.getColumnCount() < keyProperties.length) {
      // 主键数目比结果的总字段数目还多，则发生了错误。
      // 但因为此处是获取主键这样的附属操作，因此忽略错误，不影响主要工作
    } else {
      // 调用子方法，将主键值赋给实参
      assignKeys(configuration, rs, rsmd, keyProperties, parameter);
    }
  } catch (Exception e) {
    throw new ExecutorException("Error getting generated key or setting result to parameter object. Cause: " + e, e);
  }
}

/**
 * 数据插入前进行的操作
 * @param executor 执行器
 * @param ms 映射语句对象
 * @param stmt Statement对象
 * @param parameter SQL语句实参对象
 */
@Override
public void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {
  if (executeBefore) {
    processGeneratedKeys(executor, ms, parameter);
  }
}

/**
 * 数据插入后进行的操作
 * @param executor 执行器
 * @param ms 映射语句对象
 * @param stmt Statement对象
 * @param parameter SQL语句实参对象
 */
@Override
public void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {
  if (!executeBefore) {
    processGeneratedKeys(executor, ms, parameter);
  }
}

// 用户生成主键的SQL语句的特有标志，该标志会追加在用于生成主键的SQL语句的id的后方
public static final String SELECT_KEY_SUFFIX = "!selectKey";
// 插入前执行还是插入后执行
private final boolean executeBefore;
// 用户生成主键的SQL语句
private final MappedStatement keyStatement;

/**
 + 执行一段SQL语句后获取一个值，然后将该值赋给Java对象的自增属性
 *
 + @param executor 执行器
 + @param ms 插入操作的SQL语句（不是生成主键的SQL语句）
 + @param parameter 插入操作的对象
 */
private void processGeneratedKeys(Executor executor, MappedStatement ms, Object parameter) {
  try {
    // keyStatement为生成主键的SQL语句；keyStatement.getKeyProperties()拿到的是要自增的属性
    if (parameter != null && keyStatement != null && keyStatement.getKeyProperties() != null) {
      // 要自增的属性
      String[] keyProperties = keyStatement.getKeyProperties();
      final Configuration configuration = ms.getConfiguration();
      final MetaObject metaParam = configuration.newMetaObject(parameter);
      if (keyProperties != null) {
        // 为生成主键的SQL语句创建执行器keyExecutor。
        // 原注释：不要关闭keyExecutor，因为它会被父级的执行器关闭
        Executor keyExecutor = configuration.newExecutor(executor.getTransaction(), ExecutorType.SIMPLE);
        // 执行SQL语句，得到主键值
        List<Object> values = keyExecutor.query(keyStatement, parameter, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);
        // 主键值必须唯一
        if (values.size() == 0) {
          throw new ExecutorException("SelectKey returned no data.");
        } else if (values.size() > 1) {
          throw new ExecutorException("SelectKey returned more than one value.");
        } else {
          MetaObject metaResult = configuration.newMetaObject(values.get(0));
          if (keyProperties.length == 1) {
            // 要自增的主键只有一个，为其赋值
            if (metaResult.hasGetter(keyProperties[0])) {
              // 从metaResult中用getter得到主键值
              setValue(metaParam, keyProperties[0], metaResult.getValue(keyProperties[0]));
            } else {
              // 可能返回的直接就是主键值本身
              setValue(metaParam, keyProperties[0], values.get(0));
            }
          } else {
            // 要把执行SQL得到的值赋给多个属性
            handleMultipleProperties(keyProperties, metaParam, metaResult);
          }
        }
      }
    }
  } catch (ExecutorException e) {
    throw e;
  } catch (Exception e) {
    throw new ExecutorException("Error selecting key or setting result to parameter object. Cause: " + e, e);
  }
}