记录Mybatis的配置之谜

 每个现象背后都有其缘由,越离奇的bug越是由不起眼的细节引发,每个bug背后都有框架或代码运行的原理和机制所在,解决bug,不仅仅需要去网上查询,还需要对其背后的原理进行了解和总结。  同事大佬最近在学习并使用Mybatis,他使用Mybatis的MapperScannerConfigurer来进行相关配置,并希望通过yml配置来指定basePackage,mappers等属性。为此,编写了自定义的配置类 StarterAutoConfiguration和自定义属性类 TkProperties,并在初始化 MapperScannerConfigurer时使用 TkProperties中的属性。但是,事与愿违,在初始化 MapperScannerConfigurer时, TkProperties实例中的属性死活都是未初始化状态。

记录Mybatis的配置之谜

 为此,我们花了大量时间探查缘由,最后不得不询问了另一位大佬,才发现这个离奇问题的背后竟然有着这样的缘由。  我们首先来看一下大佬关于 MapperScannerConfigurer的自定义配置实现。他首先定义了自定义配置类 BkStarterAutoConfiguration,使用 @EnableConfigurationProperties注解将 TkProperties声明为配置属性类。


  1. @Configuration
  2. @EnableConfigurationProperties({TkProperties.class})
  3. @AutoConfigureBefore(MybatisAutoConfiguration.class)
  4. public class BkStarterAutoConfiguration {
  5. @Bean
  6. @ConditionalOnMissingBean
  7. @Order(Ordered.HIGHEST_PRECEDENCE)
  8. public TkProperties tkProperties() {
  9. return new TkProperties();
  10. }
  11. }

 下面是 TkProperties的定义,使用 @ConfigurationProperties注解声明了该属性配置的前缀,两个属性名称为 basePackagemappers


  1. @Data
  2. @ConfigurationProperties(prefix = "tk")
  3. public class TkProperties {
  4. private String basePackage;
  5. private String mappers;
  6. }

MapperConfig是声明并配置 MapperScannerConfigurer实例的配置类,使用被 @Bean注解修饰的 mapperScannerConfigurer方法来初始化,其方法参数为 TkProperties


  1. @Configuration
  2. public class MapperConfig {
  3. @Bean
  4. public MapperScannerConfigurer mapperScannerConfigurer(TkProperties tkProperties) {
  5. MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
  6. mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
  7. //使用TkProperties的成员变量来配置mapperScannerConfigurer
  8. mapperScannerConfigurer.setBasePackage(tkProperties.getBasePackage());
  9. Properties properties = new Properties();
  10. properties.setProperty("mappers", tkProperties.getMappers());
  11. mapperScannerConfigurer.setProperties(properties);
  12. return mapperScannerConfigurer;
  13. }
  14. }

 yml配置文件如下所示。


  1. ---
  2. tk:
  3. basePackage: cn.remcarpediem.mybatis.dao
  4. mappers: cn.remcarpediem.mappers.BaseDao

 代码乍看起来一定问题都没有,但是运行时,在初始化MapperScannerConfigurer实例时,TkProperties实例的属性死活就是没有初始化成功。

记录Mybatis的配置之谜

 一定有很多见多识广的读者已经知道这个现象背后的原因。“凶手”就是 MapperScannerConfigurer实现的接口 BeanDefinitionRegistryPostProcessor。具体原因我们还需要慢慢来解释,因为它涉及了Spring Boot的很多原理。

 首先, BeanDefinitionRegistryPostProcessor接口继承了 BeanFactoryPostProcessor接口,大家一般都对 BeanFactoryPostProcessor较为熟悉,它是实例工厂(BeanFactory)的后处理器(PostProcessor),与之类似的还有实例的后处理器(BeanPostProcessor)。 BeanFactoryPostProcessor中只定义了一个方法,其将会在 ApplicationContext内部的 BeanFactory加载完 BeanDefinition后,但是在Bean实例化之前进行。所以通常我们可以通过实现该接口来对实例化之前的 BeanDefinition进行修改。比如说 PropertySourcesPlaceholderConfigurer就实现 BeanFactoryPostProcessor接口,用于处理实例中被 @Value注解修饰的变量,修改其数值。


  1. public interface BeanFactoryPostProcessor {
  2. void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;
  3. }

 而 BeanDefinitionRegistryPostProcessor接口扩展自 BeanFactoryPostProcessor,它是 BeanDefinitionRegistry的后处理器,它可以在 BeanFactoryPostProcessor检测之前注册一些特殊的 BeanDefinition,比如说可以注册用来定义 BeanFactoryPostProcessorBeanDefintion,比如说我们之前提到的 MapperScannerConfigurerConfigurationClassPostProcessor


  1. public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {
  2. void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;
  3. }

MapperScannerConfigurerpostProcessBeanDefinitionRegistry主要用来 ClassPathMapperScanner来扫描 MybatisMapperClassPathMapperScanner继承了 ClassPathBeanDefinitionScanner,在 doScan方法中获取了 basePackage指定的包路径下的所有 MapperBeanDefinition,然后进行注册。

 而 BeanPostProcessor就是Bean实例的后处理器。每个Bean实例在进行初始化前会调用其 postProcessBeforeInitialization方法和初始化之后调用其 postProcessAfterInitialization方法。 ConfigurationPropertiesBindingPostProcessor实现了 BeanPostProcessor接口,用于处理被 @ConfigurationProperties修饰的实例。


  1. public interface BeanPostProcessor {
  2. Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
  3. Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
  4. }

 我们可以总结一下 BeanDefinitionRegistryPostProcessorBeanFactoryPostProcessorBeanPostProcessor三个后处理器发挥作用的次序和时机。

记录Mybatis的配置之谜

由此,我们也能够理解为什么 MapperScannerConfigurer初始化时, TkProperties还没有初始化,那是因为 ConfigurationPropertiesBindingPostProcessor还没有初始化,并且也没有对 TkProperties进行处理

 遇到问题和bug,不要百度一下解决方案处理就结束了,而是要深入了解一下背后的机制和原理,希望大家都能够多多探索更加深入的原理,获得更多的知识。

记录Mybatis的配置之谜

上一篇:12月1日云栖精选夜读:双11黑科技,阿里百万级服务器自动化运维系统StarAgent揭秘


下一篇:第三代神龙架构云服务器发布