一、思路
在之前的文章中,我们已经讲了
- mybatis初始化解析XML文件,将生成的MapperStatement注册到MapperRegister中;
- 如何在spring中获取MapperProxy的代理;
- MapperProxy代理对象背后的执行逻辑(调用了MapperMethod来执行命令);
ok,那我们接下来就来看看mybatis到底是怎么实现事务的,怎么执行SQL的。
本篇的重点是下面几点:
- SqlSessionTemplate 类简介.
- SqlSessionTemplate 如何初始化.
- SqlSessionTemplate增删改查背后的逻辑(怎么与spring的事务进行融合).
二、SqlSessionTemplate 类简介
这是作者给出的对SqlSessionTemplate类的说明,SqlSessionTemplate是线程安全的,生命周期由spring管理的,同spring事务一起协作来保证真正执行的SqlSession是在spring的事务中的一个SqlSession的实现类。(强行翻译,看作者原文即可。。)
/** Thread safe, Spring managed, {@code SqlSession} that works with Spring
* transaction management to ensure that that the actual SqlSession used is the
* one associated with the current Spring transaction. In addition, it manages
* the session life-cycle, including closing, committing or rolling back the
* session as necessary based on the Spring transaction configuration.
*/
再看一下SqlSessionTemplate的继承结构,它也是一个SqlSession接口的实现类。
再观察一下SqlSessionTemplate的属性,SqlSessionTemplate下有一个代理类,由JDK动态代理生成,SqlSessionTemplate真正执行增删改查都是调用代理类的接口。
// 代理类
private final SqlSession sqlSessionProxy;
// ... 省略部分代码
// 构造函数
public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
PersistenceExceptionTranslator exceptionTranslator) {
notNull(sqlSessionFactory, "Property 'sqlSessionFactory' is required");
notNull(executorType, "Property 'executorType' is required");
this.sqlSessionFactory = sqlSessionFactory;
this.executorType = executorType;
this.exceptionTranslator = exceptionTranslator;
// 利用JDK动态代理工具类生成了一个SqlSession的代理类
this.sqlSessionProxy = (SqlSession) newProxyInstance(
SqlSessionFactory.class.getClassLoader(),
new Class[] { SqlSession.class },
new SqlSessionInterceptor());
}
// ...
// 调用代理类实现
@Override
public T selectOne(String statement) {
return this.sqlSessionProxy. selectOne(statement);
}
三、SqlSessionTemplate 如何初始化.
想真正理解一个类,就看看它是怎么初始化的。在Mybatis,Spring系列之Mapper对象获取一文中,我们描述了Spring如何获取Mapper对象,其实提到了其实是在MapperFactoryBean对象调用它的私有属性SqlSession对象的getMapper()方法来获取已经注册到MapperRegister中的对象。那我们就从MapperFactoryBean这个类出发,看看它的私有属性SqlSession是怎么初始化的。最终我们在MapperFactoryBean的父类SqlSessionDaoSupport中看到了它。
public abstract class SqlSessionDaoSupport extends DaoSupport {
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
if (!this.externalSqlSession) {
this.sqlSession = new SqlSessionTemplate(sqlSessionFactory);
}
}
}
进到SqlSessionTemplate的构造方法中,可以看到它内部的代理对象的背后就是SqlSessionInterceptor子类,具体的逻辑执行都是靠它来完成。
public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
PersistenceExceptionTranslator exceptionTranslator) {
notNull(sqlSessionFactory, "Property 'sqlSessionFactory' is required");
notNull(executorType, "Property 'executorType' is required");
this.sqlSessionFactory = sqlSessionFactory;
this.executorType = executorType;
this.exceptionTranslator = exceptionTranslator;
this.sqlSessionProxy = (SqlSession) newProxyInstance(
SqlSessionFactory.class.getClassLoader(),
new Class[] { SqlSession.class },
new SqlSessionInterceptor());
}
到这儿,SqlSessionTemplate的初始化算是讲完了,接下来我们看看它是怎么和spring事务结合的。
四、SqlSessionTemplate增删改查背后的逻辑(怎么与spring的事务进行融合)
在Mybatis系列之MappMethod(揭示Mapper类背后的执行逻辑)
文章中将到了,MapperProxy对象发起请求的最终执行对象还是SqlSession,通过调用SqlSession的增删改查接口来完成请求,Spring使用的又是SqlSessionTemplate对象,而SqlSessionTemplate最终又是依赖其代理类来完成任务,那我们就重点来分析SqlSessionInterceptor这个类。
private class SqlSessionInterceptor implements InvocationHandler {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// 获取真正执行任务的SqlSession,其实就是Mybatis自身的DefaultSqlSession
SqlSession sqlSession = getSqlSession(
SqlSessionTemplate.this.sqlSessionFactory,
SqlSessionTemplate.this.executorType,
SqlSessionTemplate.this.exceptionTranslator);
try {
// 执行命令
Object result = method.invoke(sqlSession, args);
// 如果事务不由spring进行管理,那么就提交事务
if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
// force commit even on non-dirty sessions because some databases require
// a commit/rollback before calling close()
sqlSession.commit(true);
}
return result;
} catch (Throwable t) {
Throwable unwrapped = unwrapThrowable(t);
if (SqlSessionTemplate.this.exceptionTranslator != null && unwrapped instanceof PersistenceException) {
// release the connection to avoid a deadlock if the translator is no loaded. See issue #22
closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
sqlSession = null;
Throwable translated = SqlSessionTemplate.this.exceptionTranslator.translateExceptionIfPossible((PersistenceException) unwrapped);
if (translated != null) {
unwrapped = translated;
}
}
throw unwrapped;
} finally {
if (sqlSession != null) {
closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
}
}
}
}
可以看到,真正执行命令的是通过getSqlSession()方法拿到的SqlSession实现类。
public static SqlSession getSqlSession(SqlSessionFactory sessionFactory, ExecutorType executorType, PersistenceExceptionTranslator exceptionTranslator) {
notNull(sessionFactory, NO_SQL_SESSION_FACTORY_SPECIFIED);
notNull(executorType, NO_EXECUTOR_TYPE_SPECIFIED);
// 根据sqlSessionFactory从当前线程对应的事务管理器中获取SqlSessionHolder,当sqlSessionFactory创建了sqlSession,就会在事务管理器中添加一对映射:key为sqlSessionFactory,value为SqlSessionHolder,该类保存sqlSession及执行方式
SqlSessionHolder holder = (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
// 拿到同一个事务中所使用的SqlSession
SqlSession session = sessionHolder(executorType, holder);
if (session != null) {
return session;
}
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Creating a new SqlSession");
}
// 如无SqlSession,则实例化一个SqlSession,并新建一个事务
session = sessionFactory.openSession(executorType);
// 注册到事务管理器中,方便同一个事务中的其他方法使用
registerSessionHolder(sessionFactory, executorType, exceptionTranslator, session);
return session;
}
总结一下,SqlSessionTemplate主要是帮助Spring管理Mybatis的事务,通过代理模式屏蔽了SqlSession的实现细节,专注于管理SqlSession的事务。可以结合aop的方式,帮助用户自动去提交,回滚事务,不可谓不强大。