本文已参与「新人创作礼」活动,一起开启掘金创作之路。 @TOC
前言
我们写好的Mapper如何让Mybatis知道?注册,我们需要将Mapper注册到Mybatis里面去。本文就来讲讲Mybatis是如何注册的。
开始注册
configuration.addMapper(UserMapper.class);
就这么一行代码就可以完成UserMapper的注册,那么我们执行这行代码的背后Mybatis做了什么努力来接收我们的Mapper呢?
public <T> void addMapper(Class<T> type) {
mapperRegistry.addMapper(type);
}
首先我们的Mapper会被一个Mapper注册表接收,
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 {
knownMappers.put(type, new MapperProxyFactory<>(type));
// It's important that the type is added before the parser is run
// otherwise the binding may automatically be attempted by the
// mapper parser. If the type is already known, it won't try.
MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
parser.parse();
loadCompleted = true;
} finally {
if (!loadCompleted) {
knownMappers.remove(type);
}
}
}
}
注册表里面有一个已Mapper的class作为Key,Mapper代理工厂作为Value的HashMap,正是这个Map来存储我们的所有Mapper。 Mybatis要求我们每个Mapper只能注册一次。
其实这段话我不是很理解,为什么在解析前把这个放到knownMappers很重要,在后面解析成功后在放进去有什么问题吗?难道说是为了多线程的时候,通过上面抛异常的方式来避免重复解析?这样的设计也不合理啊。 目前我们的Mapper就成功的注册到Mybatis里面去了。可是注册过程却不是这么简单的,注意重要的两行代码:
MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
parser.parse();
Mapper解析
从上面可以看到,在Mapper正式生效之前Mybatis会对Mapper进行解析,接下来我们来研究下这个解析过程。 首先要着手构建一个MapperAnnotationBuilder,可以看到这个Builder初始化了一些信息,并用雇了个助手。 我觉得这里不应该是Builder,而是解析器,解析器准备好了就开始解析Mapper了。解析流程比较复杂,我画了个流程图辅助分析:
下面来看看Mybatis解析Mapper的过程。Mybatis先解析了XML配置再解析Mapper的注解配置,接下来分别解析下
XML解析
xml解析内容较多,看这里:Mybatis---xml解析
Annotation解析
这个地方就想吐槽下,在MapperAnnotationBuilder的解析过程中为啥要先搞XML解析呢?直接把Annotation解析放到XML解析之后不行吗?
annotation解析过程其实也和XML异曲同工。mybatis的注解全部在org.apache.ibatis.annotations
下面,可以自己去看看。
经过上面的解析后,Mapper算是注册到mybatis里面去了,这个Mapper的则会被记录到knownMappers了。