MybatisPlus通用参数处理解析 mybatis-plus in

我们在进行表设计时一般都会设计一些通用字段，如记录的生成时间(createDateTime)、更新时间(updateDateTime)等。如果在每个执行更新和插入操作的地方都设置这些通用字段，则会造成很多的冗余代码。基于这点考虑，MybatisPlus对Mabatis框架进行了扩展，当执行批量插入和更新时，利用MetaObjectHandler对通用字段进行处理。那么mybatis plus是如何实现这一扩展的呢？接下来给大家娓娓道来。

要理清MybatisPlus如何及何时利用MetaObjectHandler对Mybatis完成了扩展，需要首先理清，mybatis是如何执行一条sql语句的。我们知道SqlSession是Mybatis的对外功能接口，它通过Executor来完成一系列核心功能，如动态sql语句生成和查询的缓存等。Executor通过StatmentHandler来处理与JDBC的statment的交互；StatmentHandler则通过ParameterHandler来完成参数的类型处理，通过ResultSetHandler来完成结果集与Java对象的映射。如下为DefaultSqlSession的update方法实现，其调用executor的update方法：

//SqlSession执行SQL过程
@Override
  public int update(String statement, Object parameter) {
    try {
      dirty = true;
      MappedStatement ms = configuration.getMappedStatement(statement);
   // SqlSession调用Excecutor完成数据库更新操作
      return executor.update(ms, wrapCollection(parameter));
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error updating database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

Executor为接口，抽象类BaseExecutor实现了该接口，并实现模板方法update，该方法调用了抽象方法doUpdate；Executor的实现类如BatchExecutor，实现该方法，并在其中生成StatmentHandler对象，如下：

//生成StatementHandler过程
@Override
public int doUpdate(MappedStatement ms, Object parameterObject) throws SQLException {
  final Configuration configuration = ms.getConfiguration();
  // 看这里
  final StatementHandler handler = configuration.newStatementHandler(this, ms, parameterObject, RowBounds.DEFAULT, null, null);
  final BoundSql boundSql = handler.getBoundSql();
  final String sql = boundSql.getSql();
      ......
}

Mybatis提供了StatementHandler接口的基础实现类BaseStatementHandler，该类内部会生成ParameterHandler，实现如下：

//生成ParameterHandler过程
protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    ....
    //看这里
    this.parameterHandler = configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
    this.resultSetHandler = configuration.newResultSetHandler(executor, mappedStatement, rowBounds, parameterHandler, resultHandler, boundSql);
  }

org.apache.ibatis.session.Configuration#newParameterHandler实现如下：

//方法newParameterHandler的实现
public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
return parameterHandler;
}

方法mappedStatement.getLang返回LanguageDriver，而MybatisPlus实现了MybatisXMLLanguageDriver，其扩展了mybatis的XMLLanguageDriver ，重写了
createParameterHandler方法，生成MybatisDefaultParameterHandler，代码如下：

//生成MybatisDefaultParameterHandler
@Override
   public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject,
                                                  BoundSql boundSql) {
       /* 使用自定义 ParameterHandler */
       return new MybatisDefaultParameterHandler(mappedStatement, parameterObject, boundSql);
   }

MybatisPlus正是通过 MybatisDefaultParameterHandler实现对Mybatis的扩展的。processBatch方法通过GlobalConfigUtils.getMetaObjectHandler获取MetaObjectHandler抽象类，如下代码：

//获取MetaObjectHandler
protected static Object processBatch(MappedStatement ms, Object parameterObject) {
        //检查parameterObject
        if (null == parameterObject) {
            return null;
        }
        boolean isFill = false;
        // 全局配置是否配置填充器
        MetaObjectHandler metaObjectHandler = GlobalConfigUtils.getMetaObjectHandler(ms.getConfiguration());
        /* 只处理插入或更新操作 */
        if (ms.getSqlCommandType() == SqlCommandType.INSERT) {
            isFill = true;
        } else if (ms.getSqlCommandType() == SqlCommandType.UPDATE
                && metaObjectHandler.openUpdateFill()) {
            isFill = true;
        }
        if (isFill) {
            ...
                return populateKeys(metaObjectHandler, tableInfo, ms, parameterObject);
           ...
  
    }

在populateKeys方法中会调用MetaObjectHandler的insertFill方法和updateFill方法，代码如下：

//调用MetaObjectHandler的方法
protected static Object populateKeys(MetaObjectHandler metaObjectHandler, TableInfo tableInfo,
                                         MappedStatement ms, Object parameterObject) {
               ...
            // 插入填充
            if (metaObjectHandler.openInsertFill()) {
                metaObjectHandler.insertFill(metaObject);
            }
        } else if (ms.getSqlCommandType() == SqlCommandType.UPDATE && metaObjectHandler.openUpdateFill()) {
            // 更新填充
            metaObjectHandler.updateFill(metaObject);
        }
        return metaObject.getOriginalObject();
    }

我们通过重写MetaObjectHandler的insertFill方法和updateFill方法，实现对参数处理的扩展。