如果我们要使用MyBatis进行数据库操作的话,大致要做两件事情:
- 定义DAO接口
在DAO接口中定义需要进行的数据库操作。 - 创建映射文件
当有了DAO接口后,还需要为该接口创建映射文件。映射文件中定义了一系列SQL语句,这些SQL语句和DAO接口一一对应。
MyBatis在初始化的时候会将映射文件与DAO接口一一对应,并根据映射文件的内容为每个函数创建相应的数据库操作能力。而我们作为MyBatis使用者,只需将DAO接口注入给Service层使用即可。
那么MyBatis是如何根据映射文件为每个DAO接口创建具体实现的?答案是——动态代理。
下面进入正题。
首先来回顾一项MyBatis在初始化过程中所做的事情。
MyBatis在初始化过程中,首先会读取我们的配置文件流程,并使用XMLConfigBuilder
来解析配置文件。XMLConfigBuilder
会依次解析配置文件中的各个子节点,如:<settings>
、<typeAliases>
、<mappers>
等。这些子节点在解析完成后都会被注册进configuration
对象。然后configuration
对象将作为参数,创建SqlSessionFactory
对象。至此,初始化过程完毕!
下面我们重点分析<mapper>
节点解析的过程。
PS:MyBatis详细的初始化过程请移步至:MyBatis源码解析(一)——MyBatis初始化过程解析
<mapper>节点解析过程
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
mapperParser.parse();
由上述代码可知,解析mapper节点的解析是由XMLMapperBuilder
类的parse()
函数来完成的,下面我们就详细看一下parse()
函数。
public void parse() {
// 若当前Mapper.xml尚未加载,则加载
if (!configuration.isResourceLoaded(resource)) {
// 解析<mapper>节点
configurationElement(parser.evalNode("/mapper"));
// 将当前Mapper.xml标注为『已加载』(下回就不用再加载了)
configuration.addLoadedResource(resource);
// 【关键】将Mapper Class添加至Configuration中
bindMapperForNamespace();
}
parsePendingResultMaps();
parsePendingCacheRefs();
parsePendingStatements();
}
这个函数主要做了两件事:
- 解析
<mapper>
节点,并将解析结果注册进configuration
中; - 将当前映射文件所对应的DAO接口的Class对象注册进
configuration
中
这一步极为关键!是为了给DAO接口创建代理对象,下文会详细介绍。
下面再进入bindMapperForNamespace()
函数,看一看它做了什么:
private void bindMapperForNamespace() {
// 获取当前映射文件对应的DAO接口的全限定名
String namespace = builderAssistant.getCurrentNamespace();
if (namespace != null) {
// 将全限定名解析成Class对象
Class<?> boundType = null;
try {
boundType = Resources.classForName(namespace);
} catch (ClassNotFoundException e) {
}
if (boundType != null) {
if (!configuration.hasMapper(boundType)) {
// 将当前Mapper.xml标注为『已加载』(下回就不用再加载了)
configuration.addLoadedResource("namespace:" + namespace);
// 将DAO接口的Class对象注册进configuration中
configuration.addMapper(boundType);
}
}
}
}
这个函数主要做了两件事:
- 将
<mapper>
节点上定义的namespace
属性(即:当前映射文件所对应的DAO接口的权限定名)解析成Class对象 - 将该Class对象存储在
configuration
对象的MapperRegistry
容器中。
可以看一下MapperRegistry
:
public class MapperRegistry {
private final Configuration config;
private final Map<Class<?>, MapperProxyFactory<?>> knownMappers = new HashMap<Class<?>, MapperProxyFactory<?>>();
}
MapperRegistry
有且仅有两个属性:Configuration
和knownMappers
。
其中,knownMappers
的类型为Map<Class<?>, MapperProxyFactory<?>>
,由此可见,它是一个Map,key为DAO接口的Class对象,而Value为该DAO接口代理对象的工厂。
那么,这个代理对象工厂是何许人也?它又是如何产生的呢?我们先来看一下MapperRegistry
的addMapper()
函数。
public <T> void addMapper(Class<T> type) {
if (type.isInterface()) {
if (hasMapper(type)) {
throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
}
boolean loadCompleted = false;
try {
// 创建MapperProxyFactory对象,并put进knownMappers中
knownMappers.put(type, new MapperProxyFactory<T>(type));
MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
parser.parse();
loadCompleted = true;
} finally {
if (!loadCompleted) {
knownMappers.remove(type);
}