精盡MyBatis源碼分析 - Spring-Boot-Starter 源碼分析

該系列文檔是本人在學習 Mybatis 的源碼過程當中總結下來的,可能對讀者不太友好,請結合個人源碼註釋(Mybatis源碼分析 GitHub 地址Mybatis-Spring 源碼分析 GitHub 地址Spring-Boot-Starter 源碼分析 GitHub 地址)進行閱讀html

MyBatis 版本:3.5.2java

MyBatis-Spring 版本:2.0.3git

MyBatis-Spring-Boot-Starter 版本:2.1.4github

《MyBatis-Spring源碼分析》文檔中對 Spring 集成 MyBatis 的方案進行了分析,MyBatis-Spring 讓你可以在 Spring 項目中方便地使用 MyBatis,隨着 Spring Boot 框架受到業界的普遍關注,有愈來愈多企業將它使用到正式的生產環境,它支持整合其餘組件,讓你可以在 Spring Boot 項目中更加方便地使用其餘組件spring

固然,MyBatis 也提供了整合到 Spring Boot 的方案 Spring-Boot-Starter,可以讓你快速的在 Spring Boot 上面使用 MyBatis,那麼咱們來看看這個 Spring-Boot-Starter 子項目 是如何將 MyBatis 集成到 Spring 中的sql

在開始讀這篇文檔以前,須要對 Spring 有必定的瞭解,其中Spring-Boot-Starter 基於 MyBatis-Spring 來實現的,因此能夠先查看個人另外一篇《MyBatis-Spring源碼分析》文檔來了解 MyBatis-Spring,本文能夠結合個人源碼註釋(Spring-Boot-Starter 源碼分析 GitHub 地址)進行閱讀數據庫

簡述

MyBatis 的 Spring-Boot-Starter 子項目咱們主要看到兩個模塊apache

  • mybatis-spring-boot-starter:定義了一個 pom 文件,引入 MyBatis 相關依賴
  • mybatis-spring-boot-autoconfigure:MyBatis 整合到 Spring Boot 的具體實現

主要涉及到的幾個類:json

  • org.mybatis.spring.boot.autoconfigure.MybatisProperties:MyBatis 的配置類,注入 Spring Boot 的配置文件中 MyBatis 的相關配置
  • org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration:實現 InitializingBean 接口,MyBatis 自動配置類,用於初始化 MyBatis,核心類

大體邏輯以下:數組

經過 MybatisAutoConfiguration 這個自動配置類,再加上 MybatisProperties 的配置信息,生成 SqlSessionFactory 和 SqlSessionTemplate 類,完成初始化,經過 @MapperScan 註解指定 Mapper 接口

配置示例

mybatis:
  type-aliases-package: tk.mybatis.simple.model
  mapper-locations: classpath:mapper/*.xml
  config-location: classpath:mybatis-config.xml

application.yml中添加上面三個MyBatis的相關配置便可,而後在啓動類上面添加@MapperScan註解指定 Mapper 接口所在包路徑便可

注意:你還須要定義一個 DataSource 數據源,可選 DruidHikariCP等數據庫鏈接池,這裏就不講述如何使用了

MybatisProperties

org.mybatis.spring.boot.autoconfigure.MybatisProperties:MyBatis 的配置類,經過 Spring Boot 中的 @ConfigurationProperties 註解,注入 MyBatis 的相關配置,代碼以下:

@ConfigurationProperties(prefix = MybatisProperties.MYBATIS_PREFIX)
public class MybatisProperties {

  public static final String MYBATIS_PREFIX = "mybatis";

  private static final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();

  /**
   * Location of MyBatis xml config file.
   * mybatis-config.xml 配置文件的路徑
   */
  private String configLocation;

  /**
   * Locations of MyBatis mapper files.
   * XML 映射文件的路徑
   */
  private String[] mapperLocations;

  /**
   * Packages to search type aliases. (Package delimiters are ",; \t\n")
   * 須要設置別名的包路徑
   */
  private String typeAliasesPackage;

  /**
   * The super class for filtering type alias. If this not specifies, the MyBatis deal as type alias all classes that
   * searched from typeAliasesPackage.
   */
  private Class<?> typeAliasesSuperType;

  /**
   * Packages to search for type handlers. (Package delimiters are ",; \t\n")
   */
  private String typeHandlersPackage;

  /**
   * Indicates whether perform presence check of the MyBatis xml config file.
   */
  private boolean checkConfigLocation = false;

  /**
   * Execution mode for {@link org.mybatis.spring.SqlSessionTemplate}.
   */
  private ExecutorType executorType;

  /**
   * The default scripting language driver class. (Available when use together with mybatis-spring 2.0.2+)
   */
  private Class<? extends LanguageDriver> defaultScriptingLanguageDriver;

  /**
   * Externalized properties for MyBatis configuration.
   */
  private Properties configurationProperties;

  /**
   * A Configuration object for customize default settings. If {@link #configLocation} is specified, this property is
   * not used.
   */
  @NestedConfigurationProperty
  private Configuration configuration;

  /**
   * 獲取 XML 映射文件路徑下的資源對象
   *
   * @return Resource 資源數組
   */
  public Resource[] resolveMapperLocations() {
    return Stream.of(Optional.ofNullable(this.mapperLocations).orElse(new String[0]))
        .flatMap(location -> Stream.of(getResources(location))).toArray(Resource[]::new);
  }

  /**
   * 獲取某個路徑下的資源
   *
   * @param location 路徑
   * @return Resource 資源數組
   */
  private Resource[] getResources(String location) {
    try {
      return resourceResolver.getResources(location);
    } catch (IOException e) {
      return new Resource[0];
    }
  }

}
  • configLocation:mybatis-config.xml 配置文件的路徑
  • mapperLocations:XML 映射文件的路徑
  • typeAliasesPackage:須要設置別名的包路徑,多個以, ; \t\n分隔
  • typeAliasesSuperType:須要設置別名的父 Class 類型
  • typeHandlersPackage:類型處理器的包路徑
  • checkConfigLocation:檢查 mybatis-config.xml 配置文件是否存在
  • executorType:Executor 執行器類型,默認 SIMPLE
  • defaultScriptingLanguageDriver:設置默認的 LanguageDriver 語言驅動類,默認爲 XMLLanguageDriver

其中定義了前綴爲mybatis,說明你能夠在 Spring Boot 項目中的 application.yml 配置文件中,以該前綴定義 MyBatis 的相關屬性

咱們一般添加前面三個配置就能夠了

這裏注意到僅添加了 @ConfigurationProperties 註解,在做爲 Spring Bean 注入到 Spring 容器中時,會將相關配置注入到屬性中,可是這個註解不會將該類做爲 Spring Bean 進行注入,須要結合 @Configuration 註解或者其餘註解一塊兒使用

SpringBootVFS

org.mybatis.spring.boot.autoconfigure.SpringBootVFS:MyBatis 須要使用到的虛擬文件系統,用於替代 MyBatis 的 org.apache.ibatis.io.DefaultVFS 默認類

使用 Spring Boot 提供的 PathMatchingResourcePatternResolver 解析器,獲取到指定路徑下的 Resource 資源,代碼以下:

public class SpringBootVFS extends VFS {

  private final ResourcePatternResolver resourceResolver;

  public SpringBootVFS() {
    this.resourceResolver = new PathMatchingResourcePatternResolver(getClass().getClassLoader());
  }

  @Override
  public boolean isValid() {
    return true;
  }

  @Override
  protected List<String> list(URL url, String path) throws IOException {
    String urlString = url.toString();
    String baseUrlString = urlString.endsWith("/") ? urlString : urlString.concat("/");
    Resource[] resources = resourceResolver.getResources(baseUrlString + "**/*.class");
    return Stream.of(resources).map(resource -> preserveSubpackageName(baseUrlString, resource, path))
        .collect(Collectors.toList());
  }

  private static String preserveSubpackageName(final String baseUrlString, final Resource resource,
      final String rootPath) {
    try {
      return rootPath + (rootPath.endsWith("/") ? "" : "/")
          + resource.getURL().toString().substring(baseUrlString.length());
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

}

MybatisAutoConfiguration

org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration:實現 InitializingBean 接口,MyBatis 自動配置類,用於初始化 MyBatis,核心類

構造方法

@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 {

  private static final Logger logger = LoggerFactory.getLogger(MybatisAutoConfiguration.class);

  /**
   * MyBatis 配置信息
   */
  private final MybatisProperties properties;

  private final Interceptor[] interceptors;

  private final TypeHandler[] typeHandlers;

  private final LanguageDriver[] languageDrivers;

  private final ResourceLoader resourceLoader;

  private final DatabaseIdProvider databaseIdProvider;

  private final List<ConfigurationCustomizer> configurationCustomizers;

  public MybatisAutoConfiguration(MybatisProperties properties, ObjectProvider<Interceptor[]> interceptorsProvider,
      ObjectProvider<TypeHandler[]> typeHandlersProvider, ObjectProvider<LanguageDriver[]> languageDriversProvider,
      ResourceLoader resourceLoader, ObjectProvider<DatabaseIdProvider> databaseIdProvider,
      ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider) {
    this.properties = properties;
    this.interceptors = interceptorsProvider.getIfAvailable();
    this.typeHandlers = typeHandlersProvider.getIfAvailable();
    this.languageDrivers = languageDriversProvider.getIfAvailable();
    this.resourceLoader = resourceLoader;
    this.databaseIdProvider = databaseIdProvider.getIfAvailable();
    this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
  }
}

咱們主要來看到類上面定義的幾個註解:

  • @Configuration:能夠看成一個 Spring Bean 注入到 Spring 上下文中

  • @ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })

    保證存在 value 中全部的 Class 對象,以確保能夠建立它們的實例對象,這裏就保證 SqlSessionFactory 和 SqlSessionFactoryBean 都可以被建立

  • @ConditionalOnSingleCandidate(DataSource.class)

    保證存在 value 類型對應的 Bean,這裏確保已經存在一個 DataSource 數據源對象

  • @EnableConfigurationProperties(MybatisProperties.class)

    注入 value 中全部的類型的 Bean,這裏會讓 MybatisProperties 做爲 Spring Bean 注入到 Spring 上下文中

  • @AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })

    在加載 value 中的全部類以後注入當前 Bean,會先注入 DataSourceAutoConfiguration 和 MybatisLanguageDriverAutoConfiguration 兩個類(感興趣的能夠去看看,我沒搞懂這兩個類😈 😈 😈 )

咱們能夠看到是經過構造函數注入 MybatisAutoConfiguration ,其中會注入 MybatisPropertiesResourceLoader 兩個 Bean,其餘的對象都是經過 ObjectProvider 進行注入的(經過它的getIfAvailable()方法,若是存在對應的實例對象則設置)

afterPropertiesSet方法

afterPropertiesSet()方法,實現的 InitializingBean 接口的方法,在 Spring 容器初始化該 Bean 時會調用該方法

用於校驗 mybatis-config 配置文件是否存在,方法以下:

@Override
  public void afterPropertiesSet() {
    checkConfigFileExists();
  }

  private void checkConfigFileExists() {
    if (this.properties.isCheckConfigLocation() && StringUtils.hasText(this.properties.getConfigLocation())) {
      Resource resource = this.resourceLoader.getResource(this.properties.getConfigLocation());
      Assert.state(resource.exists(),
          "Cannot find config location: " + resource + " (please add config file or check your Mybatis configuration)");
    }
  }

若是配置了 MybatisProperties 中配置checkConfigLocation須要檢查 mybatis-config.xml 配置文件,那麼就會檢查該文件是否有對應的 Resource 資源,文件不存在則會拋出異常

sqlSessionFactory方法

sqlSessionFactory(DataSource dataSource)方法,注入一個 SqlSessionFactory 類型的 Spring Bean 到 Spring 上下文,方法以下:

@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    // <1> 建立一個 SqlSessionFactoryBean 對象,在 mybatis-spring 子項目中
    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    // <2> 設置數據源
    factory.setDataSource(dataSource);
    // <3> 設置虛擬文件系統爲 SpringBootVFS 對象
    factory.setVfs(SpringBootVFS.class);
    /*
     * <4> 接下來設置一些屬性
     */
    // 若是配置了 mybatis-config.xml 配置文件
    if (StringUtils.hasText(this.properties.getConfigLocation())) {
      factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
    }
    // <5> 應用 Configuration 對象
    applyConfiguration(factory);
    if (this.properties.getConfigurationProperties() != null) {
      factory.setConfigurationProperties(this.properties.getConfigurationProperties());
    }
    if (!ObjectUtils.isEmpty(this.interceptors)) {
      factory.setPlugins(this.interceptors);
    }
    if (this.databaseIdProvider != null) {
      factory.setDatabaseIdProvider(this.databaseIdProvider);
    }
    // 若是配置了須要設置別名包路徑
    if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
      factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
    }
    if (this.properties.getTypeAliasesSuperType() != null) {
      factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
    }
    if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
      factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
    }
    if (!ObjectUtils.isEmpty(this.typeHandlers)) {
      factory.setTypeHandlers(this.typeHandlers);
    }
    // 若是配置了 XML 映射文件路徑
    if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
      factory.setMapperLocations(this.properties.resolveMapperLocations());
    }
    // 獲取 SqlSessionFactoryBean 對象中屬性的名稱
    Set<String> factoryPropertyNames = Stream
            .of(new BeanWrapperImpl(SqlSessionFactoryBean.class).getPropertyDescriptors())
            .map(PropertyDescriptor::getName)
            .collect(Collectors.toSet());
    Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
    // 若是包含了 scriptingLanguageDrivers 屬性,而且存在語言驅動類
    if (factoryPropertyNames.contains("scriptingLanguageDrivers") && !ObjectUtils.isEmpty(this.languageDrivers)) {
      // Need to mybatis-spring 2.0.2+
      // 設置語言驅動類
      factory.setScriptingLanguageDrivers(this.languageDrivers);
      if (defaultLanguageDriver == null && this.languageDrivers.length == 1) {
        defaultLanguageDriver = this.languageDrivers[0].getClass();
      }
    }
    // 若是包含了 defaultScriptingLanguageDriver 屬性
    if (factoryPropertyNames.contains("defaultScriptingLanguageDriver")) {
      // Need to mybatis-spring 2.0.2+
      // 設置默認的語言驅動類
      factory.setDefaultScriptingLanguageDriver(defaultLanguageDriver);
    }

    // <6> 這裏會初始化(經過 afterPropertiesSet() 方法),返回一個 DefaultSqlSessionFactory 對象
    return factory.getObject();
}

@ConditionalOnMissingBean註解:不存在同類型則注入當前 Bean(DefaultSqlSessionFactory),存在則不注入

  1. 建立一個 SqlSessionFactoryBean 對象,在《MyBatis-Spring源碼分析》已經講到過

  2. 設置數據源 DataSource

  3. 設置 VFS 虛擬文件系統爲 SpringBootVFS 對象

  4. 接下來設置一些屬性,例如 configLocation、typeAliasesPackage、mapperLocation等屬性

  5. 應用 Configuration 對象

    private void applyConfiguration(SqlSessionFactoryBean factory) {
      Configuration configuration = this.properties.getConfiguration();
      if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
        // 若是沒有自定義 Configuration 對象,也沒有定義 configLocation 配置文件,則直接建立
        configuration = new Configuration();
      }
      /*
       * 若是 Configuration 不爲 null,而且 ConfigurationCustomizer 處理器不爲空
       * 則對該 Configuration 對象進行自定義處理
       */
      if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
        for (ConfigurationCustomizer customizer : this.configurationCustomizers) {
          customizer.customize(configuration);
        }
      }
      factory.setConfiguration(configuration);
    }

    若是你在 MapperProperties 中定義了 Configuration 對象,或者你沒有配置 configLocation(會建立一個 Configuration)

    那麼會經過 ConfigurationCustomizer 處理器(須要本身去實現該接口),對該 Configuration 對象進行自定義處理

  6. 調用SqlSessionFactoryBean 的 getObject() 方法,返回一個 DefaultSqlSessionFactory 對象,這裏會調用其 afterPropertiesSet() 方法,完成 MyBatis 的初始化

sqlSessionTemplate方法

sqlSessionTemplate(SqlSessionFactory sqlSessionFactory)方法,注入一個 SqlSessionTemplate 類型的 Spring Bean 到 Spring 上下文,方法以下:

@Bean
@ConditionalOnMissingBean
public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
    // 獲取執行器類型,默認 SIMPLE
    ExecutorType executorType = this.properties.getExecutorType();
    if (executorType != null) {
      return new SqlSessionTemplate(sqlSessionFactory, executorType);
    } else {
      return new SqlSessionTemplate(sqlSessionFactory);
    }
}

@ConditionalOnMissingBean註解:不存在同類型則注入當前 Bean(SqlSessionTemplate),存在則不注入

根據 SqlSessionFactory 建立一個 SqlSessionTemplate 對象

這裏怎麼才能被 MapperFactoryBean 注入 sqlSessionTemplate 屬性爲當前 SqlSessionTemplate 對象呢?

在 org.mybatis.spring.mapper.ClassPathMapperScanner 的 processBeanDefinitions 方法中你會發現,若是沒有配置 sqlSession 相關配置,則 explicitFactoryUsed 爲 false,那麼就會設置該 MapperFactoryBean 的 AutowireMode 爲 AUTOWIRE_BY_TYPE,也就是說經過屬性類型注入值,經過 set 方法來賦值,就會找到這個 SqlSessionTemplate 對象了

MapperScannerRegistrarNotFoundConfiguration

MybatisAutoConfiguration 的一個內部靜態類,實現了 InitializingBean 接口

用於注入一個 AutoConfiguredMapperScannerRegistrar 靜態類,代碼以下:

/**
 * If mapper registering configuration or mapper scanning configuration not present,
 * this configuration allow to scan mappers based on the same component-scanning path as Spring Boot itself.
 *
 */
@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.");
    }

}

若是 MapperFactoryBean 和 MapperScannerConfigurer 類型的 Bean 都不存在則注入該 Bean,則經過 @Import(AutoConfiguredMapperScannerRegistrar.class) 導入的 AutoConfiguredMapperScannerRegistrar 類,會去掃描 Spring Boot 項目的基礎包路徑,帶有 @Mapper 註解的接口會被當成 Mapper接口 進行解析

AutoConfiguredMapperScannerRegistrar

MybatisAutoConfiguration 的一個內部靜態類,實現了 BeanFactoryAware 和 ImportBeanDefinitionRegistrar 接口

用於往 BeanDefinitionRegistry 註冊表添加一個 MapperScannerConfigurer 類型的 BeanDefinition 對象,該對象在《MyBatis-Spring源碼分析》已經講過,代碼以下:

/**
 * 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.
 */
public static class AutoConfiguredMapperScannerRegistrar implements BeanFactoryAware, ImportBeanDefinitionRegistrar {

    private BeanFactory beanFactory;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

      if (!AutoConfigurationPackages.has(this.beanFactory)) {
        logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
        return;
      }

      logger.debug("Searching for mappers annotated with @Mapper");

      // <1> 獲取到 Spring Boot 的基礎包路徑
      List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
      if (logger.isDebugEnabled()) {
        packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
      }

      // <2> 生成一個 BeanDefinition 構建器,用於構建 MapperScannerConfigurer 的 BeanDefinition 對象
      BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
      builder.addPropertyValue("processPropertyPlaceHolders", true);
      // <3> 設置 @Mapper 註解的接口才會被當成 Mapper 接口
      builder.addPropertyValue("annotationClass", Mapper.class);
      builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
      BeanWrapper beanWrapper = new BeanWrapperImpl(MapperScannerConfigurer.class);
      // 獲取 MapperScannerConfigurer 的屬性名稱
      Set<String> propertyNames = Stream.of(beanWrapper.getPropertyDescriptors()).map(PropertyDescriptor::getName)
          .collect(Collectors.toSet());
      if (propertyNames.contains("lazyInitialization")) {
        // Need to mybatis-spring 2.0.2+
        builder.addPropertyValue("lazyInitialization", "${mybatis.lazy-initialization:false}");
      }
      if (propertyNames.contains("defaultScope")) {
        // Need to mybatis-spring 2.0.6+
        builder.addPropertyValue("defaultScope", "${mybatis.mapper-default-scope:}");
      }
      // <4> 添加 一個 MapperScannerConfigurer 的 BeanDefinition 對象,也就是注入一個 MapperScannerConfigurer 對象到容器中
      registry.registerBeanDefinition(MapperScannerConfigurer.class.getName(), builder.getBeanDefinition());
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) {
      this.beanFactory = beanFactory;
    }

}
  1. 獲取到 Spring Boot 的基礎包路徑
  2. 生成一個 BeanDefinition 構建器,用於構建 MapperScannerConfigurer 的 BeanDefinition 對象
  3. 設置 @Mapper 註解的接口才會被當成 Mapper 接口
  4. 添加一個 MapperScannerConfigurer 的 BeanDefinition 對象,也就是注入一個 MapperScannerConfigurer 對象到容器中

這個類和@MapperScan註解同樣的做用,若是你沒有經過下面三種配置方式掃描 Mapper 接口的包路徑

  • 配置 MapperScannerConfigurer 掃描器類型的 Spring Bean

  • @MapperScan註解

  • <mybatis:scan />標籤)

那麼這裏就會經過AutoConfiguredMapperScannerRegistrar添加一個 MapperScannerConfigurer 掃描器對象,去掃描 Spring Boot 項目設置的基礎包路徑,若是配置了@Mapper註解,則會當成Mapper接口進行解析,和@MapperScan註解的做用同樣

spring.factories文件

spring.factories 文件位於resources/META-INF下面,內容以下:

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

上面講到的 MybatisAutoConfiguration 自定配置類做爲初始化 MyBatis 的入口,須要被 Spring 容器管理,可是他人經過引入該組件後,這些類不必定可以被 Spring 掃描到,因此須要經過 spring.factories 文件來定義 org.springframework.boot.autoconfigure.EnableAutoConfiguration 的類名值,那麼這些類名對應的類就會必定會被 Spring 管理了(SPI 機制)

  • 同目錄中還有一個additional-spring-configuration-metadata.json文件,該文件定義的內容是在 Spring Boot 項目中的 application.yml 配置文件中 mybatis 相關配置的默認值以及提示等信息

總結

經過 spring.factories 文件,在你引入 MyBatis 的 mybatis-spring-boot-starter 依賴後,MybatisAutoConfiguion 自定配置類將會做爲 Spring Bean 注入到 Spring 的上下文中,從這個類中會初始化 SqlSessionFactory 和 SqlSessionTemplate 兩個對象,完成初始化,另外能夠經過 @MapperScan 註解解析對應的 Mapper 接口

實際上就是在 MyBatis-Spring 的子項目上增長對 Spring Boot 配置文件以及註解的支持,不用在配置文件中定義相應的 Bean 了,相對來講比較簡單

到這裏已經對 MyBatis 相關內容所有分析玩了,相信你們對 MyBatis 有了一個更加深刻的瞭解,感謝你們的閱讀!!!😄😄😄

參考文章:芋道源碼《精盡 MyBatis 源碼分析》

相關文章
相關標籤/搜索