源码分析Mybatis MapperProxy初始化之Mapper对象的扫描与构建(图文并茂)

时间 2019-11-12

标签源码分析 mybatis mapperproxy 初始化 mapper 对象扫描构建图文并茂栏目 MyBatis 繁體版

原文原文链接

舒适提示：本文基于Mybatis.3.x版本。java

MapperScannerConfigurer，Spring整合Mybatis的核心类，其做用是扫描项目中Dao类，将其建立为Mybatis的Maper对象即MapperProxy对象。spring

首先进入源码学习以前，咱们先看一下在项目中的配置文件信息。 sql

咱们注意到这里有两三个与Mapper相关的配置：apache

SqlSessionFactory#mapperLocations，指定xml文件的配置路径。
SqlSessionFactory#configLocation，指定mybaits的配置文件，该配置文件也能够配置mapper.xml的配置路径信息。
MapperScannerConfigurer，扫描Mapper的java类(DAO)。

本文的行文思路以下：session

Mybatis MapperProxy对象的扫描与构建
Mapper类与SQL语句如何创建关联这部分主要阐述Java类的运行实例Mapper对象（例如UserMapper、BookMapper)是如何与mapper.xml(UserMapper.xml、BookMapper.xml文件创建联系的)。

Mybatis MapperProxy对象建立流程

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

1.1 MapperProxy建立序列图

1.2 MapperScannerConfigurer详解

MapperScannerConfigurer的类图以下所示： app

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的实现接口开始跟踪。post

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/1198)
    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);   
    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
    scanner.setResourceLoader(this.applicationContext);
    scanner.setBeanNameGenerator(this.nameGenerator);
    scanner.registerFilters();
    scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));    // @2
}

代码@1：首先设置SqlSessionFactory，从该Scan器生成的Mapper最终都是受该SqlSessionFactory的管辖。代码@2：调用ClassPathMapperScanner的scan方法进行扫描动做，接下来详细介绍。学习

ClassPathMapperScanner#doScan

public Set<beandefinitionholder> doScan(String... basePackages) {
    Set<beandefinitionholder> beanDefinitions = super.doScan(basePackages);   //[@1](https://my.oschina.net/u/1198)
    if (beanDefinitions.isEmpty()) {
      logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
    } else {
      processBeanDefinitions(beanDefinitions);   // @2
    }
    return beanDefinitions;
}

代码@1：首先调用父类(org.springframework.context.annotation.ClassPathBeanDefinitionScanner)方法，根据扫描的文件，构建对应的BeanDefinitionHolder对象。代码@2：对这些BeanDefinitions进行处理，对Bean进行加工，加入Mybatis特性。

ClassPathMapperScanner#processBeanDefinitions

private void processBeanDefinitions(Set<beandefinitionholder> beanDefinitions) {
    GenericBeanDefinition definition;
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (GenericBeanDefinition) holder.getBeanDefinition();

      if (logger.isDebugEnabled()) {
        logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() 
          + "' and '" + definition.getBeanClassName() + "' mapperInterface");
      }

      // the mapper interface is the original class of the bean
      // but, the actual class of the bean is MapperFactoryBean
      definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());
      definition.setBeanClass(this.mapperFactoryBean.getClass());   // @1
      definition.getPropertyValues().add("addToConfig", this.addToConfig);
      boolean explicitFactoryUsed = false;
      if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {    // @2 start
        definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
        explicitFactoryUsed = true;
      } else if (this.sqlSessionFactory != null) {
        definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
        explicitFactoryUsed = true;
      }    // @2 end

      if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {  // @3
        if (explicitFactoryUsed) {
          logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
        }
        definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
        explicitFactoryUsed = true;
      } else if (this.sqlSessionTemplate != null) {
        if (explicitFactoryUsed) {
          logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
        }
        definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
        explicitFactoryUsed = true;
      }

      if (!explicitFactoryUsed) {
        if (logger.isDebugEnabled()) {
          logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
        }
        definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
      }
    }
  }

该方法有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。

1.3 MapperFactoryBean

MapperFactoryBean的类图以下：

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

DaoSupport

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

public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
	// Let abstract subclasses check their configuration.
	checkDaoConfig(); // @1

	// Let concrete implementations initialize themselves.
	try {
		initDao();           // @2
	} catch (Exception ex) {
		throw new BeanInitializationException("Initialization of DAO failed", ex);
	}
}

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

SqlSessionDaoSupport

SqlSession支持父类，经过使用SqlSessionFactory或SqlSessionTemplate建立SqlSession，那下面两个方法会在何时被调用呢？

public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory)
public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate)

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

MapperFactoryBean

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

MapperFactoryBean#checkDaoConfig
protected void checkDaoConfig() {
    super.checkDaoConfig();   // @1

    notNull(this.mapperInterface, "Property 'mapperInterface' is required");

    Configuration configuration = getSqlSession().getConfiguration();
    if (this.addToConfig &amp;&amp; !configuration.hasMapper(this.mapperInterface)) {     // @2
      try {
        configuration.addMapper(this.mapperInterface);                                        
      } catch (Throwable t) {
        logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", t);
        throw new IllegalArgumentException(t);
      } finally {
        ErrorContext.instance().reset();
      }
    }
  }

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

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

接下来进入到org.apache.ibatis.session.Configuration中。

public <t> void addMapper(Class<t> type) {
    mapperRegistry.addMapper(type);
 }

public <t> T getMapper(Class<t> type, SqlSession sqlSession) {
    return mapperRegistry.getMapper(type, sqlSession);
}

public boolean hasMapper(Class<!--?--> type) {
   return mapperRegistry.hasMapper(type);
}

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

1.4 MapperRegistry

其核心类图以下所示：

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

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

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

MapperRegistry#addMapper

public <t> void addMapper(Class<t> type) {
    if (type.isInterface()) {
      if (hasMapper(type)) {   // @1
        throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
      }
      boolean loadCompleted = false;
      try {
        knownMappers.put(type, new MapperProxyFactory<t>(type));    // @2
        MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);    // @3
        parser.parse();
        loadCompleted = true;
      } finally {
        if (!loadCompleted) {
          knownMappers.remove(type);
        }
      }
    }
  }

代码@1：若是该接口已经注册，则抛出已经绑定的异常。代码@2：为该接口注册MapperProxyFactory，但这里只是注册其建立MapperProxy的工厂，并非建立MapperProxy。代码@3：若是Mapper对应的xml资源未加载，触发xml的绑定操做，将xml中的sql语句与Mapper创建关系。本文将不详细介绍，在下一篇中详细介绍。

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

MapperRegistry#getMapper

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

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

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

1.5 MapperProxy

类图以下：

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

下面以一张以SqlSessionFacotry为视角的各核心类的关系图：

舒适提示：本文只阐述了Mybatis MapperProxy的建立流程，MapperProxy与*.Mapper.xml即SQL是如何关联的本文未涉及到，这部分的内容请看下文，即将发布。

做者介绍：丁威，《RocketMQ技术内幕》做者，RocketMQ 社区布道师，公众号：中间件兴趣圈维护者，目前已陆续发表源码分析Java集合、Java 并发包(JUC)、Netty、Mycat、Dubbo、RocketMQ、Mybatis等源码专栏。