mybatis使用在日常开发中很简单,基本没有门槛,都是和Spring直接集成,然后把之前的一些配置copy到spring的配置文件中就可以使用。具体mybatis的配置文件加载代码,已经SqlSession执行的细节都被封装到了框架中,符合面向对象编程,但是存在一个问题就是那些细节的代码慢慢都被遗忘。写这个博客就是记录一下,以后忘记可以看看。仅此而已。
Mybatis配置文件的读取和SqlSessionFactory的构建
在mybatis中加载的基本的顺序是读取配置文件,然后构建SqlSessionFactory
,通过SqlSessionFactory
获取Session
实例,最后通过Session
实例获取到对应Mapper的代理对象,通过代理对象来调用CRUD方法执行数据的操作。
SqlSessionFactory构建
public class UserService {
private static SqlSessionFactory sqlSessionFactory;
//加载xml文件
static {
InputStream inputStream = null;
try {
//读取配置文件
inputStream = Resources.getResourceAsStream("mybatis-config.xml");
//构建SqlSessionFactory
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (Exception e) {
e.printStackTrace();
} finally {
//关闭流
if (inputStream != null) {
try {
inputStream.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
先将Mybatis核心配置文件mybatis-config.xml
读取到流中,然后交给SqlSessionFactoryBuilder
构建SqlSessionFactory
对象,在构建前会对核心配置文件进行一系列的分析,并将分析的内容放到Configuration
实例中,分析的过程之前的博客中有,可以翻一翻参考一下。
到这里是sqlSessionFactory
构建完成,接下来看如何使用。
SqlSession、Mapper的获取以及使用
public void insert() {
//获取SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//获取UserMapper
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
UserMode mode = new UserMode();
mode.setUserName("Joker");
mode.setUserPhone("15612341234");
mode.setUserAge(20);
//调用插入方法
mapper.insert(mode);
}
这里实现的逻辑的方法不难,关键是在于SqlSession
和UserMapper
的获取,这里和大家一起看看源码。
SqlSession获取源码
在SqlSessionFactory
是个接口,其实现是DefaultSqlSessionFactory
,在这个类中有各种获取SqlSession
实例的方法,根据上面的实例代码,找到openSession
方法的实现。
public SqlSession openSession() {
/**
* configuration中获取默认的Executor执行器的类型
* 第二个参数是事务隔离级别
* 第三个参数表示是否自动提交,默认值是false
**/
return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}
执行器Executor
类型有多种,如果在mapper.xml
文件中没有特殊的配置基本使用的都是默认的执行器SimpleExecutor
。事务隔离级别和是否自动提交都是使用默认的值。
进入到openSessionFromDataSource
方法中后,从上面的传入参数可以知道,在这个方法中就是根据Executor
执行器的类型创建相对应的实例,同时也会根据数据相关的参数构建出对应的事务管理器。待着两个实例构建结束,就会根据这两个实例去构建最终需要的SqlSession
实例。源码如下:
/**
* 构建Session
* @param execType 执行器类型
* @param level 事务隔离界别
* @param autoCommit 是否自动提交
* @return
*/
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
Transaction tx = null;
try {
//configuration获取环境配置信息
final Environment environment = configuration.getEnvironment();
//事务管理器工厂
final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
//创建事务管理器
tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
//创建执行器executor
final Executor executor = configuration.newExecutor(tx, execType);
//构建Session
return new DefaultSqlSession(configuration, executor, autoCommit);
} catch (Exception e) {
closeTransaction(tx); // may have fetched a connection so lets call close()
throw ExceptionFactory.wrapException("Error opening session. Cause: " + e, e);
} finally {
ErrorContext.instance().reset();
}
}
基本的流程和上面的解释一样。至于再深入的代码就不再详尽的贴出来啦(源码的内容太多,入口已提供,可以自己跟进去详细的了解),但是下面可以大概的说一下。
在mybatis-config.xml
核心配置文件中有个environment标签,这个标签中会配置相应的数据源信息和事务管理器的信息。在源码中将这些参数传入到事务管理器工厂中,构建工厂对象TransactionFactory
,接着调用其创建事务管理器对象的方法。到这里事务管理器实例创建完成。
然后根据构建好的事务管理器和执行器类型去构建执行器对象,执行器对象的类型共有三种,从ExecutorType
枚举类中可以看到,分别是是BATCH
批处理模式,REUSE
复用模式,SIMPLE
简单模式。在newExecutor
方法中对执行器类型做了判断,当不是批处理或者复用模式的时候就默认使用简单模式,当然后面还有对cacheEnabled
的判断,如果支持缓存,还需要对上面的SimpleExecutor
包装一层,然后就是对整个执行链的包装。至此执行器构建完成。(执行器构建的过程使用的是装饰器模式)
事务管理器、执行器构建结束,使用Configuration
、执行器和是否自动提交参数,构建SqlSession
对象,这个过程很简单,就是将这些参数设置到SqlSession
对象成员变量中。
Mapper获取源码
Mapper本身只是一个接口,在从SqlSession
对象中get
获取对象的时候,是使用的动态代理,在mybatis源码中有一个模块叫做binding,在这里面有具体做动态代理的实现。看源码:
public <T> T getMapper(Class<T> type) {
//通过configuration构建Mapper实例
return configuration.<T>getMapper(type, this);
}
在SqlSession
中有个Configuration
实例,通过这个实例使用的getMapper
方法构建Mapper代理对象,进入后会调用MapperRegistry
(Mapper注册器),在注册器里面会构建MapperProxyFactory
工厂类,然后通过工厂类的newInstance
方法构建具体的代理对象MapperProxy
。
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
//根据type到knowMappers中获取MapperProxyFactory实例
final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
if (mapperProxyFactory == null) {
throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
}
try {
//mapperProxyFactory生成对象实例
return mapperProxyFactory.newInstance(sqlSession);
} catch (Exception e) {
throw new BindingException("Error getting mapper instance. Cause: " + e, e);
}
}
通过这里就完成了Mapper代理对象的创建,并返回。
insert方法调用
在mapper.xml
文件的结果过程中,有对应的方法解析,每个方法解析后会对应有一个MappedStatement
。最终会调用到执行器Executor
中的update
方法。整个执行的过程相对比较复杂一点,这里就不贴出源码,有兴趣的可以看一下,篇幅有限,在后续的博客文章里面再详细说Executor
执行各种方法的方式和流程。
本文作者:程序猿杨鲍
版权归作者所有,转载请注明出处