前言
在上一篇文章中我们分析了StatementHandler的源码，本文我们会分析Mybatis中四大接口之一的ParameterHandler的源码部分
源码
ParameterHandler.java
参数处理器，用来给PreparedStatement设置参数的
接口定义
public interface ParameterHandler {
// 获取当前执行实际传入的参数
Object getParameterObject();
// 给PreparedStatement设置参数
void setParameters(PreparedStatement ps)
throws SQLException;
}
接口定义好了，活就需要有人来做了，下面看看ParameterHandler接口有哪些实现
DefaultParameterHandler.java
Mybatis仅仅提供了一个实现类，我们直接看其源码
看其实现类的源码之前，我们先设想一下，如果是让你自己来实现这个接口，你的实现中应该有哪些属性呢? 确定实现有哪些属性之前我们先仔细分析一下接口中定义的方法，接口方法只有两个，一个获取当前实际执行的参数对象，注意是这种形式的（{{"phone", "15800000000"}, {"param1", "15800000000"}}）
所以实现中必然需要有一个属性，类似下面所示
// 当前实际执行前的参数对象
private final Object parameterObject;
除此之外的另一个接口方法是为PreparedStatement对象设置动态运行参数，既然是设置参数，我就需要拿到整个MappedStatement对象以及BoundSql对象，通过BoundSql我就可以得到带有?号的sql语句，当前传递的参数以及整个sql语句的参数映射关系List<ParameterMapping>，(这个映射关系尤为重要，可以说是ParameterHandler实现的关键)，通过参数映射关系我就可以准确的找到哪个参数对应哪个TypeHandler，以及该参数是入参还是出参类型，其javaType是什么，jdbcType是什么等等信息
ok，分析到这里基本上差不多了，我们还是直接看源码吧
public class DefaultParameterHandler implements ParameterHandler {
// 属性
// 持有typeHandler注册器
private final TypeHandlerRegistry typeHandlerRegistry;
// 持有MappedStatement实例，这是一个静态的xml的一个数据库操作节点的静态信息而已
private final MappedStatement mappedStatement;
// 持有当前操作传入的实际参数
private final Object parameterObject;
// 动态语言被执行后的结果sql
private final BoundSql boundSql;
private final Configuration configuration;
// 构造函数
public DefaultParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
this.mappedStatement = mappedStatement;
this.configuration = mappedStatement.getConfiguration();
this.typeHandlerRegistry = mappedStatement.getConfiguration().getTypeHandlerRegistry();
this.parameterObject = parameterObject;
this.boundSql = boundSql;
}
// 实现方法
@Override
public Object getParameterObject() {
return parameterObject;
}
@Override
public void setParameters(PreparedStatement ps) {
ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
// 1. 获取boundSql中的参数映射信息列表
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
if (parameterMappings != null) {
// 1.1. 遍历参数映射列表，这个列表信息就是我们xml文件中定义的某个查询语句的所有参数映射信息，注意这个List中的参数映射元素的顺序是和真实xml中sql的参数顺序对应的
for (int i = 0; i < parameterMappings.size(); i++) {
ParameterMapping parameterMapping = parameterMappings.get(i);
// 1.2. 只有入参类型才会设置PreparedStatement
if (parameterMapping.getMode() != ParameterMode.OUT) {
Object value;
// 取出参数名，这里比如说是'phone'
String propertyName = parameterMapping.getProperty();
if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params
value = boundSql.getAdditionalParameter(propertyName);
} else if (parameterObject == null) {
value = null;
} else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
value = parameterObject;
} else {
// 1.3. 这一步的工作就是从当前实际传入的参数中获取到指定key（'phone'）的value值，比如是'15800000000'
MetaObject metaObject = configuration.newMetaObject(parameterObject);
value = metaObject.getValue(propertyName);
}
// 2. 获取该参数对应的typeHandler
TypeHandler typeHandler = parameterMapping.getTypeHandler();
// 2.1. 获取该参数对应的jdbcType
JdbcType jdbcType = parameterMapping.getJdbcType();
if (value == null && jdbcType == null) {
jdbcType = configuration.getJdbcTypeForNull();
}
try {
// 3. 重点是调用每个参数对应的typeHandler的setParameter方法为该ps设置正确的参数值
typeHandler.setParameter(ps, i + 1, value, jdbcType);
} catch (TypeException e) {
throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
} catch (SQLException e) {
throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
}
}
}
}
}
}
这里截取一个运行时的debug信息看一下就知道了
至此我们可以知道，每一次的调用查询（数据库查询，不走Mybatis缓存），Executor在执行doQuery的时候都会创建一个StatementHandler实例，每个StatementHandler在实例化的时候，都会创建并持有两个处理器即ParameterHandler和ResultSetHandler
这样statementHandler就可以利用ParameterHandler完成预处理语句的参数化设置，以及结果查询出来以后再利用ResultSetHandler处理结果集
这里我们再次贴一下BaseStatementHandler的构造函数部分源码
// BaseStatementHandler.java
// ...
protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
// 省略其他属性设置...
// 1. parameterHandler
this.parameterHandler = configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
// 2. resultSetHandler
this.resultSetHandler = configuration.newResultSetHandler(executor, mappedStatement, rowBounds, parameterHandler, resultHandler, boundSql);
}
我们看下parameterHandler的创建过程，可以看到是利用了configuration
// Configuration.java
// ...
// new一个参数化处理器
public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
// 1. 内部就是调用了DefaultParameterHandler的构造方法，new了一个实例返回
ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
// 2. 看到这里，又是Mybatis的插件，提供给开发人员拦截ParameterHandler的调用逻辑
parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
return parameterHandler;
}
代码分析至此，我们简单总结一下
当真实的数据库查询被执行时，
SimpleExecutor执行器会通过configuration对象new出一个StatementHandler出来，后续的所有操作都是利用这个statementHandler来完成，这个handler实际上是返回了经过开发人员自定义插件的代理类，可以基于此处自定义插件当statementHandler实例有了以后，我们需要创建出真实的JDBC
Statement实例，此处调用了statementHandler的prepare方法(此处可自定义插件拦截哦)实现，根据handler的类型不同则会创建不同的JDBCStatement实例返回，这里简单的提一下，如果是ReuseExecutor不会为同一个BoundSql中的sql语句创建多个prepareStatement返回，而是在内部维护一个Map<String, Statement>来重用Statement实例当statement实例返回时，就会进行
参数化设置（如果是一个Statement实例而非PrepareStatement实例，参数化设置方法的内部就不作任何处理），调用statementHandler的parameterize方法完成，由于我们每个statementHandler都持有两个处理器即ParameterHandler和ResultSetHandler，这个时候就是ParameterHandler上场的时候了，PrepareStatementHandler类型的handler在参数化方法内部就是委托给了ParameterHandler，调用了其setParameters方法进行参数化设置，而setParameters方法的核心实现就是拿到当前调用的boundSql实例中的parameterMappings集合和parameterObject实例，通过遍历这个集合，对所有入参类型(ParameterMode.IN)的参数进行逐个获取其参数对应的TypeHandler，再利用TypeHandler的setParameter方法对当前的preparedStatement实例进行参数化设置，而设置需要的参数值就是从parameterObject中获取的当参数设置完成以后，statementHandler又拿到了调用权，开始调用
query/update(Statement)方法执行数据库操作，不同的handler则有不同的实现，比如SimpleStatementHandler就是调用的Statement.execute(sql)执行，而PreparedStatementHandler则是直接ps.execute()执行即可数据库执行完成后，就拿到了
结果集，这个时候就是ResultSetHandler发挥的时候了，下文我们会继续分析ResultSetHandler的源码
