MyBatis中Mapper的注入問題詳解

更新時(shí)間：2021年09月16日 11:45:21 作者：枯木fc

這篇文章主要介紹了MyBatis中Mapper的注入問題,我知道在 SpringBoot 體系中，MyBatis 對(duì) Mapper 的注入常見的方式有 2 種，具體哪兩種方法跟隨小編一起看看吧

在 SpringBoot 體系中，MyBatis 對(duì) Mapper 的注入常見的方式我知道的有 2 種：

1、@MapperScan

MapperScan 類是 mybatis-spring 包里面的。

通過在啟動(dòng)類上使用 @MapperScan，然后通過 basePackages 屬性指定 Mapper 文件所在的目錄來進(jìn)行掃描裝載，默認(rèn)情況下指定目錄下的所有.java文件都會(huì)被當(dāng)做 Mapper 來加載處理。

@MapperScan(basePackages = "com.test.springboot.mapper")
@ServletComponentScan(basePackages = "com.test.springboot.filters")
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

可以看到，在 MapperScan 注解上有使用了 @Import(MapperScannerRegistrar.class) ，也就是把MapperScannerRegistrar 當(dāng)做配置類注入 Spring 容器。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
@Repeatable(MapperScans.class)
public @interface MapperScan {}

MapperScannerRegistrar 類是一個(gè) ImportBeanDefinitionRegistrar 的實(shí)現(xiàn)，會(huì)在創(chuàng)建注入 Spring 容器后，被 Spring 主動(dòng)觸發(fā)。其重載的方法主要是創(chuàng)建并注冊(cè)了一個(gè) MapperScannerConfigurer 類型的 registry，這個(gè) registry 主要就是去指定的 basePackages目錄掃描指定的文件，并將其裝載成 BeanDefinition 注入 Spring 容器。

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {}

@Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    AnnotationAttributes mapperScanAttrs = AnnotationAttributes
        .fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
    if (mapperScanAttrs != null) {
      registerBeanDefinitions(importingClassMetadata, mapperScanAttrs, registry,
          generateBaseBeanName(importingClassMetadata, 0));
    }
  }

  void registerBeanDefinitions(AnnotationMetadata annoMeta, AnnotationAttributes annoAttrs,
      BeanDefinitionRegistry registry, String beanName) {

    BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
    builder.addPropertyValue("processPropertyPlaceHolders", true);

    Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");
    if (!Annotation.class.equals(annotationClass)) {
      builder.addPropertyValue("annotationClass", annotationClass);
    }
　　// ...
  }

下面是MapperScannerConfigurer 的主要實(shí)現(xiàn)，其主要依賴于 ClassPathMapperScanner 來實(shí)現(xiàn)掃面，在 MapperScan 指定了 basePackages 的情況下，它只會(huì)掃描這個(gè)指定目錄，否則可能就是掃描整個(gè) classpath 了（就類似 SpringBoot 的完整掃描）。

@Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
    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);
    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
    scanner.setResourceLoader(this.applicationContext);
    scanner.setBeanNameGenerator(this.nameGenerator);
    scanner.setMapperFactoryBeanClass(this.mapperFactoryBeanClass);
    if (StringUtils.hasText(lazyInitialization)) {
      scanner.setLazyInitialization(Boolean.valueOf(lazyInitialization));
    }
    if (StringUtils.hasText(defaultScope)) {
      scanner.setDefaultScope(defaultScope);
    }
    scanner.registerFilters();
    scanner.scan(
        StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
  }

在 ClassPathMapperScanner 的實(shí)現(xiàn)中，我們可以看到他會(huì)把掃描到的目標(biāo)類（比如用 @Mapper 注解的類 xxxMapper.java）的 BeanDefinition 的 beanClass 設(shè)置為 MapperFactoryBean，后續(xù)根據(jù) BeanDefinition 創(chuàng)建的 Bean 也就是 MapperFactoryBean 的類型了。因?yàn)镸apperFactoryBean 是一個(gè)工廠類，那么在 SpringBoot 要對(duì) xxxMapper 實(shí)例化的時(shí)候，它會(huì)判斷到 xxxMapper 對(duì)應(yīng)的 Bean 是一個(gè)工廠類，然后會(huì)去調(diào)用它的 getObject 方法創(chuàng)建 xxxMapper.java 的實(shí)例（當(dāng)然這里肯定是個(gè)代理類）。

private Class<? extends MapperFactoryBean> mapperFactoryBeanClass = MapperFactoryBean.class;

  public void setMapperFactoryBeanClass(Class<? extends MapperFactoryBean> mapperFactoryBeanClass) {
    this.mapperFactoryBeanClass = mapperFactoryBeanClass == null ? MapperFactoryBean.class : mapperFactoryBeanClass;
  }

  /**
   * Calls the parent search that will search and register all the candidates. Then the registered objects are post
   * processed to set them as MapperFactoryBeans
   */
  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);

    if (beanDefinitions.isEmpty()) {
      LOGGER.warn(() -> "No MyBatis mapper was found in '" + Arrays.toString(basePackages)
          + "' package. Please check your configuration.");
    } else {
      processBeanDefinitions(beanDefinitions);
    }

    return beanDefinitions;
  }

  private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    AbstractBeanDefinition definition;
    BeanDefinitionRegistry registry = getRegistry();
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (AbstractBeanDefinition) holder.getBeanDefinition();
      　　　　// ...　　　 String beanClassName = definition.getBeanClassName();
      definition.setBeanClass(this.mapperFactoryBeanClass);

      definition.getPropertyValues().add("addToConfig", this.addToConfig);

      // Attribute for MockitoPostProcessor
      // https://github.com/mybatis/spring-boot-starter/issues/475
      definition.setAttribute(FACTORY_BEAN_OBJECT_TYPE, beanClassName);

      // ...if (ConfigurableBeanFactory.SCOPE_SINGLETON.equals(definition.getScope()) && defaultScope != null) {
        definition.setScope(defaultScope);
      }

      if (!definition.isSingleton()) {
        BeanDefinitionHolder proxyHolder = ScopedProxyUtils.createScopedProxy(holder, registry, true);
        if (registry.containsBeanDefinition(proxyHolder.getBeanName())) {
          registry.removeBeanDefinition(proxyHolder.getBeanName());
        }
        registry.registerBeanDefinition(proxyHolder.getBeanName(), proxyHolder.getBeanDefinition());
      }

    }
  }

 @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }

getObject 方法內(nèi)部是先獲取它的 SqlSessionTemplate 實(shí)例，然后根據(jù) mapperInterface（這個(gè)是 xxxMapper.java 的全限定名）去獲取 xxxMapper 對(duì)應(yīng)的 MapperProxy 實(shí)例，然后對(duì) xxxMapper 類的方法調(diào)用都會(huì)因?yàn)榇矶徊讲睫D(zhuǎn)到 MapperProxy -> SqlSessionTemplate -> sqlSessionProxy（一個(gè) SqlSession 的代理實(shí)例）上去執(zhí)行。

2、@Mapper

Mapper 類是 mybatis 包里面的。

單純只在類上加 @Mapper 的注解肯定是沒用的，這里我們還需要另外一個(gè)官方項(xiàng)目mybatis-spring-boot-autoconfigure 的協(xié)助了（這是個(gè)自動(dòng)配置的項(xiàng)目，因此需要 SpringBoot 的支持，換一句話說就是項(xiàng)目還要另外再加入 Spring 官方的 spring-boot-configuration-processor 依賴），這樣可以在只加了 @Mapper 注解的情況下讓 Mapper文件順利的被掃描和注入。

為了依賴使用的方便與統(tǒng)一，可以直接使用mybatis-spring-boot-starter依賴

<dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>${mybatis-spring.version}</version>
</dependency>

我們可以在mybatis-spring-boot-autoconfigure 依賴的 META-INF 目錄下找到 spring.factories 的文件，這個(gè)是 SpringBoot 主動(dòng)來掃描需要進(jìn)行自動(dòng)配置注入的目標(biāo)文件。這里面可以看到后面的主角 MybatisAutoConfiguration 類，這個(gè)類加載了 Mybatis 的配置文件，聲明依賴了一些 Bean等，然后也能找到它又通過 @Import 主動(dòng)注入了一個(gè)叫AutoConfiguredMapperScannerRegistrar 的類。

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean {    // ...
    @org.springframework.context.annotation.Configuration
    @Import(AutoConfiguredMapperScannerRegistrar.class)
    @ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })
    public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
      @Override
      public void afterPropertiesSet() {
        logger.debug(
            "Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
      }
    }    // ...
}

注入的這個(gè)AutoConfiguredMapperScannerRegistrar 和前文的MapperScannerRegistrar有點(diǎn)類似，是一個(gè)掃描類的注冊(cè)器。它在這里注冊(cè)的也是MapperScannerConfigurer，不同的是這里明確指定掃描的是帶 Mapper 注解的文件，然后這里掃描的的 basePackage 是它自動(dòng)獲取的，實(shí)際就是啟動(dòng)類所在目錄以及子目錄。后面的掃描過程也就和方法一的后面是一樣的了。

List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
// ...BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
builder.addPropertyValue("processPropertyPlaceHolders", true);
builder.addPropertyValue("annotationClass", Mapper.class);
builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));

MyBtatis 團(tuán)隊(duì)貌似更加推崇使用 @Mapper 的方式，因?yàn)樗麄冊(cè)?AutoConfiguredMapperScannerRegistrar 的注釋里面這么寫道：這個(gè)方法會(huì)和 SpringBoot 一樣，掃描的是同一個(gè)基礎(chǔ) pacakge。如果你想獲得更多能力，那么你可以顯式的使用 MapperScan 注解，但是 Mapper 注解的方式能使類型映射器正常的工作，開箱即用，就像是在使用 Spring Data JPA 庫一樣。

/**
   * This will just scan the same base package as Spring Boot does. If you want more power, you can explicitly use
   * {@link org.mybatis.spring.annotation.MapperScan} but this will get typed mappers working correctly, out-of-the-box,
   * similar to using Spring Data JPA repositories.
   */