主頁 > 後端開發 > 精盡MyBatis原始碼分析 - Spring-Boot-Starter 原始碼分析

精盡MyBatis原始碼分析 - Spring-Boot-Starter 原始碼分析

2020-11-28 11:15:06 後端開發

該系列檔案是本人在學習 Mybatis 的原始碼程序中總結下來的,可能對讀者不太友好,請結合我的原始碼注釋(Mybatis原始碼分析 GitHub 地址、Mybatis-Spring 原始碼分析 GitHub 地址、Spring-Boot-Starter 原始碼分析 GitHub 地址)進行閱讀

MyBatis 版本:3.5.2

MyBatis-Spring 版本:2.0.3

MyBatis-Spring-Boot-Starter 版本:2.1.4

《MyBatis-Spring原始碼分析》檔案中對 Spring 集成 MyBatis 的方案進行了分析,MyBatis-Spring 讓你能夠在 Spring 專案中方便地使用 MyBatis,隨著 Spring Boot 框架受到業界的廣泛關注,有越來越多企業使將它使用到正式的生產環境,它支持整合其他組件,讓你能夠在 Spring Boot 專案中更加方便地使用其他組件

當然,MyBatis 也提供了整合到 Spring Boot 的方案 Spring-Boot-Starter,能夠讓你快速的在 Spring Boot 上面使用 MyBatis,那么我們來看看這個 Spring-Boot-Starter 子專案 是如何將 MyBatis 集成到 Spring 中的

在開始讀這篇檔案之前,需要對 Spring 有一定的了解,其中Spring-Boot-Starter 基于 MyBatis-Spring 來實作的,所以可以先查看我的另一篇《MyBatis-Spring原始碼分析》檔案來了解 MyBatis-Spring,本文可以結合我的原始碼注釋(Spring-Boot-Starter 原始碼分析 GitHub 地址)進行閱讀

簡述

MyBatis 的 Spring-Boot-Starter 子專案我們主要看到兩個模塊

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

主要涉及到的幾個類:

  • 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 原始碼分析》

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/228061.html

標籤:其他

上一篇:精盡MyBatis原始碼分析 - Spring-Boot-Starter 原始碼分析

下一篇:Java基本概念:介面

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more