数据读写的本质
不管是哪种ORM框架,数据读写其本质都是对JDBC的封装,其目的主要都是简化JDBC的开发流程,进而让开发人员更关注业务。下面是JDBC的核心流程:
- 注册 JDBC 驱动(Class.forName(“XXX”);)
- 打开连接(DriverManager.getConnection(“url”,”name”,”password”))
- 根据连接,创建 Statement(conn.prepareStatement(sql))
- 设置参数(stmt.setString(1, “wyf”);)
- 执行查询(stmt.executeQuery();)
- 处理结果,结果集映射(resultSet.next())
- 关闭资源(finally)
Mybatis也是在对JDBC进行封装,它将注册驱动和打开连接交给了数据库连接池来负责,Mybatis支持第三方数据库连接池,也可以使用自带的数据库连接池;创建 Statement 和执行查询交给了StatementHandler
来负责;设置参数交给ParameterHandler
来负责;最后两步交给了ResultSetHandler
来负责。
Executor内部运作过程
测试方法
org.apache.ibatis.binding.BindingTest#shouldFindThreeSpecificPosts
下面是一个简单的数据读写过程,在宏观上先来了解一下每一个组件在整个数据读写上的作用:
Mybatis的数据读写主要是通Excuter来协调StatementHandler、ParameterHandler和ResultSetHandler三个组件来实现的:
- StatementHandler:它的作用是使用数据库的Statement或PrepareStatement执行操作,启承上启下作用;
- ParameterHandler:对预编译的SQL语句进行参数设置,SQL语句中的的占位符“?”都对应BoundSql.parameterMappings集合中的一个元素,在该对象中记录了对应的参数名称以及该参数的相关属性
- ResultSetHandler:对数据库返回的结果集(ResultSet)进行封装,返回用户指定的实体类型;
StatementHandler
StatementHandler类图
RoutingStatementHandler
通过StatementType
来创建StatementHandler
,使用静态代理模式来完成方法的调用,主要起到路由作用。它是Excutor组件真正实例化的组件。public class RoutingStatementHandler implements StatementHandler {
/**
* 静态代理模式
*/
private final StatementHandler delegate;
public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
// 根据{@link org.apache.ibatis.mapping.StatementType} 来创建不同的实现类 (策略模式)
switch (ms.getStatementType()) {
case STATEMENT:
delegate = new SimpleStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
break;
case PREPARED:
delegate = new PreparedStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
break;
case CALLABLE:
delegate = new CallableStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
break;
default:
throw new ExecutorException("Unknown statement type: " + ms.getStatementType());
}
}
@Override
public Statement prepare(Connection connection, Integer transactionTimeout) throws SQLException {
return delegate.prepare(connection, transactionTimeout);
}
...
}
BaseStatementHandler
所有子类的抽象父类,定义了初始化statement的操作顺序,由子类实现具体的实例化不同的statement(模板模式)。@Override
public Statement prepare(Connection connection, Integer transactionTimeout) throws SQLException {
ErrorContext.instance().sql(boundSql.getSql());
Statement statement = null;
try {
// 实例化Statement(由子类实现)【模板方法+策略模式】
statement = instantiateStatement(connection);
// 设置超时时间
setStatementTimeout(statement, transactionTimeout);
// 设置获取数据记录条数
setFetchSize(statement);
return statement;
} catch (SQLException e) {
closeStatement(statement);
throw e;
} catch (Exception e) {
closeStatement(statement);
throw new ExecutorException("Error preparing statement. Cause: " + e, e);
}
}
protected abstract Statement instantiateStatement(Connection connection) throws SQLException;
instantiateStatement()
就是一个模板方法,由子类实现。SimpleStatementHandler
使用JDBCStatement
执行模式,不需要做参数处理,源码如下:@Override
protected Statement instantiateStatement(Connection connection) throws SQLException {
// 实例化Statement
if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
return connection.createStatement();
} else {
return connection.createStatement(mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
}
}
@Override
public void parameterize(Statement statement) {
// N/A
// 使用Statement是直接执行sql 所以没有参数
}
PreparedStatementHandler
使用JDBCPreparedStatement
预编译执行模式。@Override
protected Statement instantiateStatement(Connection connection) throws SQLException {
// 实例化PreparedStatement
String sql = boundSql.getSql();
if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
String[] keyColumnNames = mappedStatement.getKeyColumns();
if (keyColumnNames == null) {
return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
} else {
return connection.prepareStatement(sql, keyColumnNames);
}
} else if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
return connection.prepareStatement(sql);
} else {
return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
}
}
@Override
public void parameterize(Statement statement) throws SQLException {
// 参数处理
parameterHandler.setParameters((PreparedStatement) statement);
}
CallableStatementHandler
使用JDBCCallableStatement
执行模式,用来调用存储过程。现在很少用。ParameterHandler
主要作用是给PreparedStatement
设置参数,源码如下:@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;
}
// 判断参数是否有相应的 TypeHandler
else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
value = parameterObject;
} else {
// 以上都不是,通过反射获取value值
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 {
// 根据TypeHandler设置参数
typeHandler.setParameter(ps, i + 1, value, jdbcType);
} catch (TypeException | SQLException e) {
throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
}
}
}
}
}
- 获取参数映射关系
- 获取参数名称
- 根据参数名称获取参数值
- 获取参数的类型处理器
- 根据TypeHandler设置参数值
通过上面的流程可以发现,真正设置参数是由TypeHandler来实现的。
TypeHandler
Mybatis基本上提供了所需要用到的所有TypeHandler,当然也可以自己实现。TypeHandler的主要作用是:
- 设置PreparedStatement参数值
- 获取查询结果值
public interface TypeHandler<T> {
/**
* 给{@link PreparedStatement}设置参数值
*
* @param ps {@link PreparedStatement}
* @param i 参数的索引位
* @param parameter 参数值
* @param jdbcType 参数类型
* @throws SQLException
*/
void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
/**
* 根据列名获取结果值
*
* @param columnName Colunm name, when configuration <code>useColumnLabel</code> is <code>false</code>
*/
T getResult(ResultSet rs, String columnName) throws SQLException;
/**
* 根据索引位获取结果值
*/
T getResult(ResultSet rs, int columnIndex) throws SQLException;
/**
* 获取存储过程结果值
*/
T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}
TypeHandler的本质就是对JDBC中
stmt.setString(1, "wyf");
和resultSet.getString("name")
的封装,JDBC完整代码可以查看JDBC 面试要点。
ResultSetHandler
ResultSetHandler
主要作用是:对数据库返回的结果集(ResultSet)进行封装,通过通过ResultMap
配置和反射完成自动映射,返回用户指定的实体类型;核心思路如下:
- 根据
RowBounds
做分页处理 - 根据
ResultMap
配置的返回值类型和constructor
配置信息实例化目标类 - 根据
ResultMap
配置的映射关系,获取到TypeHandler
,进而从ResultSet
中获取值 - 根据
ResultMap
配置的映射关系,获取到目标类的属性名称,然后通过反射给目标类赋值
源码太多了,这里就不发了,有兴趣就在下面的源码上看注释吧,下面的流程图会画出方法的调用栈。
Mybatis自带的
RowBounds
分页是逻辑分页,数据量大了有可能会内存溢出,所以不建议使用Mybatis默认分页。
数据读取流程图
总结
Mybatis的整个数据读取流程其实就是对JDBC的一个标准实现。