浅入浅出Mybatis：（二）Mapper interface加载过程

前言

在上一篇中，我们对MyBatis的整体项目结构进行了大览，本篇，开始正式进入源码分析的第一篇，来一起了解一下MyBatis的mapper interface与XML配置文件的加载过程。

本篇源代码基于SpringBoot 1.5x，Mybatis-spring 1.3x、Mybatis 3.4x。

SpringBoot加载MyBaits的过程

在Spring项目中，我们对Mybatis进行配置时，往往只需要添加几个注解，就可以将mapper interface托管给Spring，就像这样：

那么这里就有两个问题：

1、Spring是如何扫描到Mapper interface的，并加载到Spring容器中去的呢？

2、mapper interface是如何与XML配置文件建立起关联的呢？

下面，我们来分析一下Mybatis的mapper加载过程。

Mapper加载过程

Mybatis在SpringBoot的加载过程，依托于SpringBoot的autoconfig机制，如果您对SpringBoot有过了解，一定知道SpringBoot中最核心的部分，就是autoconfig机制，也是SpringBoot集成其他框架的主要方式，这里就不对SpringBoot的autoconfig机制进行过多的介绍，毕竟本篇的主角是Mybatis，感兴趣的看官可以自行查找相关资料。

如果是通过@MapperScan的加载方式，则会使用MapperScannerRegistrar为扫描入口，而如果通过XML配置文件指定mapper的方式，则会通过MybatisAutoConfiguration作为扫描入口。

本篇，我们主要介绍使用@MapperScan的加载方式，同时笔者也推荐使用此种方式，可以更加符合SpringBoot的面向注解编程的思想。

想了解Mapper的加载过程，我们需要找到一个切入点，而这个切入点，就是SpringBoot启动类上的注解，@MapperScan。

MapperScan

我们进入MapperScan中，发现注释上关联了两个类，一个是MapperScannerRegistrar，一个是MapperFactoryBean，通过命名就可以看出，毫无疑问，MapperScannerRegistrar就是Mapper的扫描器，我们进入MapperScannerRegistrar。

MapperScannerRegistrar

MapperScannerRegistrar实现了ImportBeanDefinitionRegistrar接口，并实现了registerBeanDefinitions方法，因此在Spring启动时，会调用所有实现了ImportBeanDefinitionRegistrar接口的类的registerBeanDefinitions方法，我们来具体分析一下registerBeanDefinitions中的实现：

上面就是registerBeanDefinitions的实现，核心主要分为5个步骤：

1、解析@MapperScan注解中的属性内容，并以K-V的形式存储进实现了LinkedHashMap的AnnotationAttributes对象中；

2、创建ClassPathMapperScanner对象，该对象是扫描mapper interface的核心；

3、组装ClassPathMapperScanner对象中的各个属性字段值，其中核心的属性字段包括factoryBean、sqlSessionFactoryRef、basePackages；

4、开始加载指定包路径下的类对象。

特别注意：

需要注意的一点是，对于通过@MapperScan的扫描方式，默认会加载指定包路径下的全部类对象进入Spring容器中，但是对于MybatisAutoConfiguration的扫描方式，则需要在mapper interface上加入@Mapper注解才可以被Spring扫描。

原因是因为ClassPathMapperScanner的registerFilters方法，其实现如下：

这里我们不过多的探究其具体实现细节，而是从注释中就可以得到核心信息，当指定了annotationClass与markerInterface属性后，ClassPathMapperScanner只会扫描符合条件的接口实现类，而MybatisAutoConfiguration的方式指定了annotationClass为@Mapper。

ClassPathMapperScanner

我们继续来看ClassPathMapperScanner中的doScan方法的具体实现：

doScan中主要做了两件事：

1、扫描指定包路径下的类，并将其包装为BeanDefinitionHolder，组装成一个集合；

2、处理BeanDefinitionHolder集合中的全部对象的属性字段值。

我们来看一下processBeanDefinitions的实现细节：

上面就是processBeanDefinitions的实现，其中主要是处理BeanDefinitionHolder的属性字段，而其中最核心的操作是设置definition对象的BeanClass字段，将其设置为MapperFactoryBean class：

definition.setBeanClass(this.mapperFactoryBean.getClass());

通过MapperFactoryBean，可以将mapper interface注入进BeanFactory中，我们接下来看一下MapperFactoryBean的实现。

MapperFactoryBean

MapperFactoryBean从名字中我们就可以看出来，这是一个Mapper bean的工厂类，它继承了SqlSessionDaoSupport类并实现了FactoryBean接口，具备了FactoryBean的能力。

我们来看一下其核心实现方法：

而在初始化的过程中，由于SqlSessionDaoSupport实现了InitializingBean接口，并在初始化方法中调用了子类实现的checkDaoConfig方法，而checkDaoConfig方法是非常核心的所在，通过该步骤，才可以将mapper interface与mapper xml进行关联组装，让我们来深入探究一下。

在checkDaoConfig方法中，主要做了两件事情：

1、检查mapper interface是否已经完成过初始化；

2、如果没有，进行装载操作。

我们进入configuration.addMapper(this.mapperInterface)方法一探究竟：

这里调用了mybaits中的Configuration的addMapper方法，Configuration类是一个非常核心的类，后面的章节中我们会着重介绍，这里暂时忽略，继续跟进：

进入MapperRegistry的addMapper实现，其中主要进行了两件事情：

1、将mapper interface作为key放入Map集合中，value设置为MapperProxyFactory；

2、将mapper interface继续解析处理。

这里将mapper interface至关重要，我们先分析第二步，然后在回头来说这一步。进入parser.parse()方法：

在parse方法中，进行大量的解析工作，我们需要关注的是红框部分，这里Mybaits会进行两部分判断：

第一步：尝试解析mapper interface对应的XML配置文件；

第二步：尝试解析mapper interface上的注解字段。

我们先忽略具体的解析过程，这一部分的分析将放到下一篇中仔细讲解，parseStatement方法非常的冗长，主要是进行各种解析的工作，我们核心关注的点：

我们进入该方法内部，马上快要到底真相的所在：

看到这里，你是不是突然发现了这熟悉的配方，这熟悉的味道？MyBatis将mapperXML文件中的标签或mapper interface上的注解进行解析，最终组装成MappedStatement对象，而MappedStatement则是Mybatis中最为核心的类之一，通过它，才可以真正的执行SQL语句。

Mapper加载全流程

最后，我们用一张简易的流程图来概括一下mapper加载的过程：

结语

本篇我们介绍了SpringBoot对Mybaits Mapper的核心加载过程，对Mybatis中的一些核心类有了初步的认识，同时也解释的文章开头的第一个问题：

1、Spring是如何扫描到mapper interface的，并加载到Spring容器中去的呢？

但是第二个问题：

2、mapper interface是如何与XML配置文件建立起关联的呢？

那么在下一篇中，我们就来解答第二个问题，深入探究Mybatis是如何解析XML配置文件与接口注解的，而又是如何与mapper interface建立关系的，敬请期待！

更多精彩文章， 请关注我的个人公众号：老宣说
让我们一起共同学习成长！
感谢您的支持！