mapper注解的主要作用_Mybatis对mapper的加载流程详解

今天来分析Configuration初始化的最后一部分mapper的加载。

加载方法mapperElement

XMLConfigBuilder配置Configuration的parseConfiguration方法还剩最后一行解析代码：mapperElement(root.evalNode("mappers"));

mapperElement方法源码与详解如下图：

从源码可以得出一些结论：

mappers节点支持mapper和package两种类型子节点；

package子节点只需要name一个属性；

一个mapper子节点有且只能有url、resource、class三个属性中其中一个，否则会抛出异常；

mapperElement解析两种mappers子节点，主要代码我分成了4个部分，接下来逐一进行深入解析。

解析包方法addMappers

首先来看解析包的方法使用的是configuration的addMappers方法，方法主要是涉及到一个MapperRegistry类型的属性mapperRegistry，addMappers主要流程如下图：

addMappers方法主要涉及到的是MapperRegistry这个类，这个类有两个属性：config、knownMappers。在config指向的是configuration，knownMappers存放这class文件对应的MapperProxyFactory。MapperProxyFactory根据名字先猜测是创建mapper代理的工厂。

介绍完关键类，再来看addMappers主要分4步：

调用mapperRegistry属性的addMappers(String packageName)方法这个方法会调用另外一个addMappers；

addMappers(String packageName, Class<?> superType)方法会遍历指定包下面所有属于superType子类的类，上一步传递的是Object.class，所以这里是遍历所有类，然后调用addMapper(mapperClass)方法；

addMapper(mapperClass)方法首先需要判断mapperClass必须是接口，再判断class是否已经存在，存在会报异常。不存在则实例化一个MapperProxyFactory对象并put进knownMappers，最后根据class创建一个MapperAnnotationBuilder并调用parse方法。

最后是MapperAnnotationBuilder的parse方法，MapperAnnotationBuilder是解析mapper注解的，我们后面详解。

加载package下的mapper总的流程看下来比较简单，实际上就是找到对应包下面所有的接口，然后根据接口创建一个MapperProxyFactory放到configuration属性mapperRegistry的knownMappers中。

解析单个mapper

从解析单个mapper有三种情况，但是分两种情况，一种是有resource或者url属性的是直接根据属性值生成一个XMLMapperBuilder对象，然后执行parse方法，如果是由class属性值和加载包的最后一步方法相似，调用mapperRegistry的addMapper方法。

XMLMapperBuilder的初始化和parse简单介绍源码如下图：

解析mapper.xml的XMLMapperBuilder和最开始解析mybatis-config.xml的XMLConfigBuilder一样都是继承至mybatis的BaseBuilder，并且初始化流程也差不多。

可以看出XMLMapperBuilder类是解析mapper.xml最关键的类，这个类比较复杂，接下来的文章再来专门讲解它。

总结

mapper的注入支持两种方式，单个mapper注入或者整个包下面注入，也可以按加载class文件或者xml文件分成两种。单个mapper注入如果是根据url或者xml则是通过加载xml文件注入，通过url获取扫描整个包加载则是class方式进行注入。

通过xml加载是直接根据xml生成XMLMapperBuilder，然后执行parse方法。

通过class加载则是接口类生成MapperProxyFactory，放到MapperRegistry的map属性knownMappers中，最后通过MapperAnnotationBuilder执行parse进行解析,parse也会调用XMLMapperBuilder的parse方法。

后面的文章我们先解读MapperAnnotationBuilder这个类，最终再来看最重要的类XMLMapperBuilder。

从目前源码可以得出一些需要注意的点：

一个mapper子节点有且只能有url、resource、class三个属性中其中一个，否则会抛出异常；

一个mapper只能被加载一次，重复加载会抛出异常。

Java程序员日常学习笔记，如理解有误欢迎各位交流讨论！