源码分析Mybatis MapperProxy初始化【图文并茂】

丁威

发布于 2019-06-11 14:54:58

9870

发布于 2019-06-11 14:54:58

文章被收录于专栏：中间件兴趣圈中间件兴趣圈

温馨提示：本文基于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文件建立联系的)。

下面的源码分析或许会比较枯燥，进入源码分析之前，先给出MapperProxy的创建序列图。

MapperProxy创建序列图

MapperScannerConfigurer

MapperScannerConfigurer的类图如下所示：

MapperScannerConfigurer实现Spring Bean生命周期相关的类，我们先简单介绍各个核心类及其作用。

BeanNameAware 是Bean对自己的名称感知，也就是在Bean创建的时候，自动将Bean的名称设置在Bean中，外部应用程序不需要调用setBeanName，就可以通过getBeanName()方法获取其bean名称。
ApplicationContextAware 自动感知ApplicationContext对象，即在Bean创建的时候，Spring工厂会自动将当前的ApplicationContext注入该Bean中。
InitializingBean 实现该接口，Spring在初始化Bean后会自动调用InitializingBean#afterPropertiesSet方法。
BeanFactoryPostProcessor BeanFactory后置处理器，这个时候只是创建好了Bean的定义信息(BeanDefinition)，在postProcessBeanFactory方法中，我们可以修改bean的定义信息，例如修改属性的值。与其相似的是BeanPostProcessor，这个是在bean初始化前后对Bean执行，即bean的构造方法调用后，init-method前执行。
BeanDefinitionRegistryPostProcessor 主要用来增加Bean的定义，增加BeanDefinition。MapperScannerConfigurer主要的目的就是扫描特定的包并创建对应的Mapper对象。接下来将重点对该接口的实现。

BeanDefinitionRegistryPostProcessor

 1public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
 2    if (this.processPropertyPlaceHolders) {
 3      processPropertyPlaceHolders();
 4    }
 5
 6    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
 7    scanner.setAddToConfig(this.addToConfig);
 8    scanner.setAnnotationClass(this.annotationClass);
 9    scanner.setMarkerInterface(this.markerInterface);
10    scanner.setSqlSessionFactory(this.sqlSessionFactory);     // @1
11    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
12    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);   
13    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
14    scanner.setResourceLoader(this.applicationContext);
15    scanner.setBeanNameGenerator(this.nameGenerator);
16    scanner.registerFilters();
17    scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));    // @2
18}

代码@1：首先设置SqlSessionFactory，从该Scan器生成的Mapper最终都是受该SqlSessionFactory的管辖。

代码@2：调用ClassPathMapperScanner的scan方法进行扫描动作，接下来详细介绍。

ClassPathMapperScanner#doScan

1public Set<BeanDefinitionHolder> doScan(String... basePackages) {
2    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);   //@1
3    if (beanDefinitions.isEmpty()) {
4      logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
5    } else {
6      processBeanDefinitions(beanDefinitions);   // @2
7    }
8    return beanDefinitions;
9}

代码@1：首先调用父类ClassPathBeanDefinitionScanner的doScan方法，接下配置文件并构建对应的BeanDefinitionHolder对象。

代码@2：对这些BeanDefinitions进行处理，对Bean进行加工，加入Mybatis特性。

ClassPathMapperScanner

 1private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
 2    GenericBeanDefinition definition;
 3    for (BeanDefinitionHolder holder : beanDefinitions) {
 4      definition = (GenericBeanDefinition) holder.getBeanDefinition();
 5
 6      if (logger.isDebugEnabled()) {
 7        logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() 
 8          + "' and '" + definition.getBeanClassName() + "' mapperInterface");
 9      }
10
11      // the mapper interface is the original class of the bean
12      // but, the actual class of the bean is MapperFactoryBean
13      definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());
14      definition.setBeanClass(this.mapperFactoryBean.getClass());   // @1
15      definition.getPropertyValues().add("addToConfig", this.addToConfig);
16      boolean explicitFactoryUsed = false;
17      if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {    // @2 start
18        definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
19        explicitFactoryUsed = true;
20      } else if (this.sqlSessionFactory != null) {
21        definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
22        explicitFactoryUsed = true;
23      }    // @2 end
24
25      if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {  // @3
26        if (explicitFactoryUsed) {
27          logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
28        }
29        definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
30        explicitFactoryUsed = true;
31      } else if (this.sqlSessionTemplate != null) {
32        if (explicitFactoryUsed) {
33          logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
34        }
35        definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
36        explicitFactoryUsed = true;
37      }
38
39      if (!explicitFactoryUsed) {
40        if (logger.isDebugEnabled()) {
41          logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
42        }
43        definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
44      }
45    }
46  }

该方法有3个关键点：代码@1：BeanDefinition中的beanClass设置的类为MapperFactoryBean，即该BeanDefinition初始化的实例为MapperFactoryBean，其名字可以看出，这是一个FactoryBean对象，会通过其getObject方法进行构建具体实例。

代码@2：将为MapperFactoryBean设置属性，将SqlSessionFactory放入其属性中，在实例化时可以自动获取到该SqlSessionFactory。

代码@3：如果sqlSessionTemplate不为空，则放入到属性中，以便Spring在实例化MapperFactoryBean时可以得到对应的SqlSessionTemplate。

分析到这里，MapperScannerConfigurer的doScan方法就结束了，但并没有初始化Mapper，只是创建了很多的BeanDefinition,并且其beanClass为MapperFactoryBean，那我们将目光转向MapperFactoryBean。

MapperFactoryBean

MapperFactoryBean的类图如下：

先对上述核心类做一个简述：

DaoSupport

Dao层的基类，定义一个模板方法，供其子类实现具体的逻辑，DaoSupport的模板方法如下：

 1public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
 2    // Let abstract subclasses check their configuration.
 3    checkDaoConfig(); // @1
 4
 5    // Let concrete implementations initialize themselves.
 6    try {
 7        initDao();           // @2
 8    } catch (Exception ex) {
 9        throw new BeanInitializationException("Initialization of DAO failed", ex);
10    }
11}

代码@1：检查或构建dao的配置信息，该方法为抽象类，供子类实现，等下我们本节的主角MapperFactoryBean主要实现该方法，从而实现与Mybatis相关的整合信息。

代码@2：初始化Dao相关的方法，该方法为一个空实现。

SqlSessionDaoSupport

SqlSession支持父类，通过使用SqlSessionFactory或SqlSessionTemplate创建SqlSession，那下面两个方法会在什么时候被调用呢？

1public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory)
2public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate)
3

不知道大家还记不记得，在创建MapperFactoryBean的时候，其属性里会设置SqlSessionFacotry或SqlSessionTemplate，见上文代码(processBeanDefinitions)，这样的话在示例化Bean时，Spring会自动注入实例，即在实例化Bean时，上述方法中的一个或多个会被调用。

MapperFactoryBean

主要看它是如何实现checkDaoConfig的。

 1MapperFactoryBean#checkDaoConfig
 2protected void checkDaoConfig() {
 3    super.checkDaoConfig();   // @1
 4
 5    notNull(this.mapperInterface, "Property 'mapperInterface' is required");
 6
 7    Configuration configuration = getSqlSession().getConfiguration();
 8    if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {     // @2
 9      try {
10        configuration.addMapper(this.mapperInterface);                                        
11      } catch (Throwable t) {
12        logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", t);
13        throw new IllegalArgumentException(t);
14      } finally {
15        ErrorContext.instance().reset();
16      }
17    }
18  }

代码@1：首先先调用父类的checkDaoConfig方法。

代码@2：mapperInterface，就是具体的Mapper的接口类，例如com.demo.dao.UserMapper，如果以注册，则抛出异常，否则调用configuration增加Mapper。

接下来关注org.apache.ibatis.session.Configuration。

 1public <T> void addMapper(Class<T> type) {
 2    mapperRegistry.addMapper(type);
 3 }
 4
 5public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
 6    return mapperRegistry.getMapper(type, sqlSession);
 7}
 8
 9public boolean hasMapper(Class<?> type) {
10   return mapperRegistry.hasMapper(type);
11}

从上面代码可以看出，正在注册(添加)、查询、获取Mapper的核心类为MapperRegistry。

MapperRegistry

其核心类图如下所示：

对其属性做个简单的介绍：

Configuration config Mybatis全局配置对象。
Map, MapperProxyFactory> knownMappers 已注册Map，这里的键值为mapper接口，例如com.demo.dao.UserMapper，值为MapperProxyFactory，创建MapperProxy的工厂。

下面简单介绍MapperRegistry的几个方法，其实现都比较简单。

MapperRegistry#addMapper

 1public <T> void addMapper(Class<T> type) {
 2    if (type.isInterface()) {
 3      if (hasMapper(type)) {   // @1
 4        throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
 5      }
 6      boolean loadCompleted = false;
 7      try {
 8        knownMappers.put(type, new MapperProxyFactory<T>(type));    // @2
 9        MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);    // @3
10        parser.parse();
11        loadCompleted = true;
12      } finally {
13        if (!loadCompleted) {
14          knownMappers.remove(type);
15        }
16      }
17    }
18  }

代码@1：如果该接口已经注册，则抛出已经绑定的异常。

代码@2：为该接口注册MapperProxyFactory，但这里只是注册其创建MapperProxy的工厂，并不是创建MapperProxy。

代码@3：如果Mapper对应的xml资源未加载，触发xml的绑定操作，将xml中的sql语句与Mapper建立关系。本文将不详细介绍，在下一篇中详细介绍。

注意：addMapper方法，只是为*Mapper创建对应对应的MapperProxyFactory。

MapperRegistry#getMapper

 1public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
 2    final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);   // @1
 3    if (mapperProxyFactory == null)
 4      throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
 5    try {
 6      return mapperProxyFactory.newInstance(sqlSession);                                                                                 // @2
 7    } catch (Exception e) {
 8      throw new BindingException("Error getting mapper instance. Cause: " + e, e);
 9    }
10  }

根据Mapper接口与SqlSession创建MapperProxy对象。代码@1：根据接口获取MapperProxyFactory。代码@2：调用MapperProxyFactory的newInstance创建MapperProxy对象。

到目前为止Mybatis Mapper的初始化构造过程就完成一半了，即MapperScannerConfigurer通过包扫描，然后构建MapperProxy，但此时MapperProxy还未与mapper.xml文件中的sql语句建立关联，由于篇幅的原因，将在下一节重点介绍其关联关系建立的流程。接下来我们先一睹MapperProxy对象，毕竟这是本文最终要创建的对象，也为后续SQL的执行流程做个简单准备。

MapperProxy

类图如下：

上面的类都比较简单，MapperMethod，代表一个一个的Mapper方法，从SqlCommand可以看出，每一个MapperMethod都会对应一条SQL语句。

下面以一张以SqlSessionFacotry为视角的各核心类的关系图结束本文的讲解：

温馨提示：本文只阐述了Mybatis MapperProxy的创建流程，MapperProxy与*.Mapper.xml即SQL是如何关联的本文未涉及到，这部分的内容请看下文，即将发布。原文链接(支持目录)： https://blog.csdn.net/prestigeding/article/details/90415680

本文参与腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2019-05-21，如有侵权请联系 cloudcommunity@tencent.com 删除

mybatis