前文回顾:
在上一篇文章中我们学习了SqlSession、MappedStatment以及Executor。并且分析了其作用,最终得出结论Myabtis对于数据库的操作还是基于JDBC,也就是说Mybatis其实就是对JDBC的封装。今天我们继续分析其他的核心对象。
Mybatis源码学习(三):核心对象分析(二)
一、StatmentHandler
1、简介
StatmentHandler是Statement处理器,用于封装了JDK自带的Statement(java.sql包下),并且提供了一系列的数据库操作。
2、源码分析
StatementHandler是一个接口,定义了若干数据库操作,例如获取Statement、批操作、更新、查询等等,这里我们以其中的一个实现SimpleStatementHandler,以query操作为例来分析其源码。
@Override
public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
//获取Mapper绑定的SQL
String sql = boundSql.getSql();
//执行SQL
statement.execute(sql);
//处理结果集
return resultSetHandler.<E>handleResultSets(statement);
}
在这里就可以看出StatementHandler底层是包装了Statement,并以Statement来执行数据库操作。执行完成之后使用ResultSetHandler来处理结果集。就是这么的简单,核心代码:statement.execute(sql);采用的是Jdk自带的Statement,这和我们平时写JDBC是一样的。
二、ResultSetHandler
1、简介
在以前JDBC编程中,当我们使用Statement执行了数据库操作之后会去处理ResultSet将数据库查询出来的数据映射到Java实体类中。既然Myabtis是对JDBC的分装,那么肯定也会有这么一步。这里直接给出结论,在Mybatis中使用ResultHandler来处理结果集。
2、源码分析
public interface ResultSetHandler {
<E> List<E> handleResultSets(Statement stmt) throws SQLException;
<E> Cursor<E> handleCursorResultSets(Statement stmt) throws SQLException;
void handleOutputParameters(CallableStatement cs) throws SQLException;
}
和之前大多数核心对象一样,ResultSetHandler也是一个接口,在ResultSetHandler接口中定义了3个方法。分别是处理List结果集、处理游标、处理输出参数。和之前一样我们也找一个实现类来探究Myabtis是如何处理查询出来的结果集的。我们以最常用的处理List结果集来分析
public List<Object> handleResultSets(Statement stmt) throws SQLException {
ErrorContext.instance().activity("handling results").object(mappedStatement.getId());
final List<Object> multipleResults = new ArrayList<Object>();
int resultSetCount = 0;
//获取ResultSet
ResultSetWrapper rsw = getFirstResultSet(stmt);
//核心代码===========================================
List<ResultMap> resultMaps = mappedStatement.getResultMaps();
int resultMapCount = resultMaps.size();
validateResultMapsCount(rsw, resultMapCount);
while (rsw != null && resultMapCount > resultSetCount) {
ResultMap resultMap = resultMaps.get(resultSetCount);
handleResultSet(rsw, resultMap, multipleResults, null);
rsw = getNextResultSet(stmt);
cleanUpAfterHandlingResultSet();
resultSetCount++;
}
//核心代码===========================================
//省略 ResultSet处理(逻辑和ResultMap基本上一致)
return collapseSingleResultList(multipleResults);
}
核心步骤分析:
1、通过Statement获取原始的ResultSet并且包装成ResultSetWrapper对象:
ResultSetWrapper rsw = getFirstResultSet(stmt);
2、获取MappedStatment包含的ResultMap(也就是我们自己定义的ResultMap,结果映射):
List resultMaps = mappedStatement.getResultMaps();
3、处理结果集
handleResultSet(rsw, resultMap, multipleResults, null);
进入handleResultSet方法
private void handleResultSet(ResultSetWrapper rsw, ResultMap resultMap, List<Object> multipleResults, ResultMapping parentMapping) throws SQLException {
try {
//判断是否有 父类映射
if (parentMapping != null) {
handleRowValues(rsw, resultMap, null, RowBounds.DEFAULT, parentMapping);
} else {
//是否额外定义了resultHandler,一般为null
if (resultHandler == null) {
//获取默认处理器
DefaultResultHandler defaultResultHandler = new DefaultResultHandler(objectFactory);
//处理原始数据(核心)
handleRowValues(rsw, resultMap, defaultResultHandler, rowBounds, null);
multipleResults.add(defaultResultHandler.getResultList());
} else {
handleRowValues(rsw, resultMap, resultHandler, rowBounds, null);
}
}
} finally {
// issue #228 (close resultsets)
closeResultSet(rsw.getResultSet());
}
}
核心代码:** handleRowValues(rsw, resultMap, defaultResultHandler, rowBounds, null);继续进入方法**
public void handleRowValues(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping) throws SQLException {
//判断是否有嵌套的ResultMap
if (resultMap.hasNestedResultMaps()) {
ensureNoRowBounds();
checkResultHandler();
handleRowValuesForNestedResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
} else {
//解析简单ResultMap
handleRowValuesForSimpleResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
}
}
继续进入handleRowValuesForSimpleResultMap方法
private void handleRowValuesForSimpleResultMap(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping)
throws SQLException {
DefaultResultContext<Object> resultContext = new DefaultResultContext<Object>();
skipRows(rsw.getResultSet(), rowBounds);
while (shouldProcessMoreRows(resultContext, rowBounds) && rsw.getResultSet().next()) {
ResultMap discriminatedResultMap = resolveDiscriminatedResultMap(rsw.getResultSet(), resultMap, null);
Object rowValue = getRowValue(rsw, discriminatedResultMap);
storeObject(resultHandler, resultContext, rowValue, parentMapping, rsw.getResultSet());
}
}
这部分代中最关键的就是getRowValue,顾名思义该方法是用来获取原始值,其他的代码都是为这个方法做铺垫。那么直接进入getRowValue。
private Object getRowValue(ResultSetWrapper rsw, ResultMap resultMap) throws SQLException {
final ResultLoaderMap lazyLoader = new ResultLoaderMap();
Object rowValue = createResultObject(rsw, resultMap, lazyLoader, null);
if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) {
final MetaObject metaObject = configuration.newMetaObject(rowValue);
boolean foundValues = this.useConstructorMappings;
if (shouldApplyAutomaticMappings(resultMap, false)) {
foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, null) || foundValues;
}
foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, null) || foundValues;
foundValues = lazyLoader.size() > 0 || foundValues;
rowValue = foundValues || configuration.isReturnInstanceForEmptyRow() ? rowValue : null;
}
return rowValue;
}
这部分代码了解即可,我们不需要对处理的过程十分熟悉,只要知道在Myabtis中处理结果集靠的是ResultSetHandler。
三、ParameterHandler
1、简介
在上一小节我们分析了Mybatis是如何处理结果集的(通过ResultSetHandler),对于SQL语句来说我们经常会用到一些查询条件,例如查询年龄大于20的人 Select * From t_person Where age>20,很多时候这个查询条件并不是直接写死在SQL里,而是通过参数的形式传递。例如我们经常能看到
Person selectById(@Param(“id”)**int **id); =》 select * from t_person where id = ?
这里id被作为参数传递,那么这个id最终是如何拼接到SQL里的呢。继续会到DefaultResultSetHandler中,我们可以找到一个名为ParameterHandler的属性,从命名中就可以看出该类(接口)
2、源码分析
package org.apache.ibatis.executor.parameter;
import java.sql.PreparedStatement;
import java.sql.SQLException;
/**
* A parameter handler sets the parameters of the {@code PreparedStatement}
*
* @author Clinton Begin
*/
public interface ParameterHandler {
Object getParameterObject();
void setParameters(PreparedStatement ps)
throws SQLException;
}
ParameterHandler源码非常简单总共就2个方法,获取参数和设置参数。同时ParameterHandler也只有一个实现了,DefaultParameterHandler。我们继续分析
@Override
public void setParameters(PreparedStatement ps) {
ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
if (parameterMappings != null) {
for (int i = 0; i < parameterMappings.size(); i++) {
ParameterMapping parameterMapping = parameterMappings.get(i);
if (parameterMapping.getMode() != ParameterMode.OUT) {
Object value;
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 {
MetaObject metaObject = configuration.newMetaObject(parameterObject);
value = metaObject.getValue(propertyName);
}
TypeHandler typeHandler = parameterMapping.getTypeHandler();
JdbcType jdbcType = parameterMapping.getJdbcType();
if (value == null && jdbcType == null) {
jdbcType = configuration.getJdbcTypeForNull();
}
//省略try/catch
/**
* 核心方法:设置参数
*/
typeHandler.setParameter(ps, i + 1, value, jdbcType);
}
}
}
}
(对于源码学习我们不需要知道每一行都是干嘛的,只要知道其中几个核心的方法即可,因为作为框架是有非常多的在我们看来没有意义的封装,以及一些列的参数校验)
在上面的代码中经过一些列的校验、判断最终来的 typeHandler.setParameter(ps, i + 1, value, jdbcType); 这里是给SQL设置参数的。继续进入
@Override
public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
if (parameter == null) {
if (jdbcType == null) {
throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters.");
}
try {
//设置为Null的值
ps.setNull(i, jdbcType.TYPE_CODE);
} catch (SQLException e) {
throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . " +
"Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. " +
"Cause: " + e, e);
}
} else {
try {
//设置不为Null的值
setNonNullParameter(ps, i, parameter, jdbcType);
} catch (Exception e) {
throw new TypeException("Error setting non null for parameter #" + i + " with JdbcType " + jdbcType + " . " +
"Try setting a different JdbcType for this parameter or a different configuration property. " +
"Cause: " + e, e);
}
}
}
我们以setNonNullParameter为例,可以看到setNonNullParameter有许多的子类,不同的子类处理不类型的参数,由此我们也可以得知,如果需要实现自定义类型的类型转换,只需要继承TypeHandler并重写setParameter方法即可
四、总结
至此Mybatis核心对象的分析已经结束,我们已经对Mybatis有个大致的了解。这里做个总结
1、Configuration:我们所编写的xml配置被Mybatis封装成为Configuration对象。
2、SqlSession:SQL会话以门面模式提供给使用者数据库相关操作。
3、Executor:执行器,用于执行数据库操作
4、StatmentHandler:底层是封装了Statment(java.sql)
6、ParameterHandler:处理我们传入参数
7、TypeHandler:类型处理器,用于将数据库类型转为java类型
8、ResultSetHandler:用于处理结果集
下一篇文章我们会以一个查询语句来Debug整个过程。最后还想说的是,对于源码学习不能追求每一行代码都清楚,只需要知道框架核心,学习其思想即可。希望对你有所帮助。