温馨提示:本文基于Mybatis.3.x版本。
MapperScannerConfigurer,Spring整合Mybatis的核心类,其作用是扫描项目中Dao类,将其创建为Mybatis的Maper对象即MapperProxy对象。
首先进入源码学习之前,我们先看一下在项目中的配置文件信息。
我们注意到这里有两三个与Mapper相关的配置:
- SqlSessionFactory#mapperLocations,指定xml文件的配置路径。
- SqlSessionFactory#configLocation,指定mybaits的配置文件,该配置文件也可以配置mapper.xml的配置路径信息。
- MapperScannerConfigurer,扫描Mapper的java类(DAO)。
本文的行文思路如下:
- Mybatis MapperProxy对象的扫描与构建
- Mapper类与SQL语句如何建立关联 这部分主要阐述Java类的运行实例Mapper对象(例如UserMapper、BookMapper)是如何与mapper.xml(UserMapper.xml、BookMapper.xml文件建立联系的)。
Mybatis MapperProxy对象创建流程
下面的源码分析或许会比较枯燥,进入源码分析之前,先给出MapperProxy的创建序列图。
1.1 MapperProxy创建序列图
1.2 MapperScannerConfigurer详解
MapperScannerConfigurer的类图如下所示:
MapperScannerConfigurer实现Spring Bean生命周期相关的类:BeanNameAware、ApplicationContextAware、BeanFactoryPostProcessor、InitializingBean、BeanDefinitionRegistryPostProcessor,我们先来看一下这些接口对应的方法的调用时机:
- BeanNameAware 是Bean对自己的名称感知,也就是在Bean创建的时候,自动将Bean的名称设置在Bean中,外部应用程序不需要调用setBeanName,就可以通过getBeanName()方法获取其bean名称。
- ApplicationContextAware 自动感知ApplicationContext对象,即在Bean创建的时候,Spring工厂会自动将当前的ApplicationContext注入该Bean中。
- InitializingBean 实现该接口,Spring在初始化Bean后会自动调用InitializingBean#afterPropertiesSet方法。
- BeanFactoryPostProcessor BeanFactory后置处理器,这个时候只是创建好了Bean的定义信息(BeanDefinition),在BeanFactoryPostProcessor接口的postProcessBeanFactory方法中,我们可以修改bean的定义信息,例如修改属性的值,修改bean的scope为单例或者多例。与其相似的是BeanPostProcessor,这个是在bean初始化前后对Bean执行,即bean的构造方法调用后,init-method前执行。
- BeanDefinitionRegistryPostProcessor 主要用来增加Bean的定义,增加BeanDefinition。由于MapperScannerConfigurer主要的目的就是扫描特定的包,并创建对应的Mapper对象,估这里是MapperScannerConfigurer重点实现的接口。
那我们接下来从BeanDefinitionRegistryPostProcessor的实现接口开始跟踪。
BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory); // [@1](https://my.oschina.net/u/11