Spring中那些BeanFactoryPostProcessors详解(一)

简介: Spring中那些BeanFactoryPostProcessors详解(一)

关联博文:

Spring中那些BeanFactoryPostProcessors详解(一)

Spring中那些BeanFactoryPostProcessors详解(二)


本文是对Spring中refresh分析之invokeBeanFactoryPostProcessors方法详解的一个补充,我们详细说明一下那些BeanFactoryPostProcessor在invokeBeanFactoryPostProcessors方法中的作用。


【1】CachingMetadataReaderFactoryPostProcessor


CachingMetadataReaderFactoryPostProcessor是SharedMetadataReaderFactoryContextInitializer的静态内部类实现了BeanDefinitionRegistryPostProcessor 和 PriorityOrdered接口。


主要用来注册CachingMetadataReaderFactory这个BeanDefinition并配置ConfigurationClassPostProcessor。如下所示其postProcessBeanFactory方法为空,我们主要看其postProcessBeanDefinitionRegistry方法。register方法会注册SharedMetadataReaderFactoryBean这个一个BeanDefinition,beanName如下所示:

org.springframework.boot.autoconfigure.internalCachingMetadataReaderFactory

79212540ebdd42a39af5cbb87b38e7f4.png

ConfigurationWarningsPostProcessor是ConfigurationWarningsApplicationContextInitializer的静态内部类,实现了PriorityOrdered 和 BeanDefinitionRegistryPostProcessor接口主要用来打印一些警示信息,我们对这个不用过多关注。

【2】ConfigurationClassPostProcessor


这个重量级的处理器我们在SpringBoot自动配置原理解析系列分析中详细描述过其postProcessBeanDefinitionRegistry方法。而其postProcessBeanFactory呢则是对候选配置类做了增强并注册了ImportAwareBeanPostProcessor这样一个BeanPostProcessor用来对ImportAware类型做支持。


关于ConfigurationClassPostProcessor本文我们这里不做进一步分析,梳理其作用如下:


对于候选配置类使用CGLIB Enhancer增强

解析处理@PropertySource 注解

解析@ComponentScan注解,扫描@Configuration、@Service、@Controller、@Repository和@Component注解并注册BeanDefinition

解析@Import注解,然后进行实例化,并执行ImportBeanDefinitionRegistrar的registerBeanDefinitions逻辑,或者ImportSelector的selectImports逻辑或者将候选类作为配置类触发配置类解析过程

解析@ImportResource注解,并加载相关配置信息

解析方法级别@Bean注解并将返回值注册成BeanDefinition

注册ImportAwareBeanPostProcessor到容器中,用于处理ImportAware

【3】MapperScannerConfigurer


是的,这个我们在SSM年代很熟悉的扫描配置器也是一个BeanDefinitionRegistryPostProcessor。其是在什么时候注册BeanDefinition呢?是在ConfigurationClassPostProcessor的parse方法中。


如下所示@MapperScan注解导入了MapperScannerRegistrar。

a5b079fd73da4a609a34084a535118c6.png

这个MapperScannerRegistrar会做什么呢?其会注册一个MapperScannerConfigurer这样的BeanDefinition到BeanFactory中。如下图所示:


我们继续看MapperScannerConfigurer。其postProcessBeanFactory方法是个空方法,我们主要看其postProcessBeanDefinitionRegistry方法。简单来讲其会实例化一个扫描器ClassPathMapperScanner并触发对basePackage的扫描。

@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));
   }
   //注册过滤器
   scanner.registerFilters();
   //触发基础包的扫描
   scanner.scan(
       StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
 }

ClassPathMapperScanner 继承自ClassPathBeanDefinitionScanner,其scan方法如下所示。

// ClassPathBeanDefinitionScanner
public int scan(String... basePackages) {
  int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
//实际扫描方法,触发子类ClassPathMapperScanner 的方法
  doScan(basePackages);
  // Register annotation config processors, if necessary.
//默认为true,在实例化AnnotatedBeanDefinitionReader时我们触发过这个registerAnnotationConfigProcessors
//这里可以理解为一个补偿机制,本文这个方法没有任何作用
  if (this.includeAnnotationConfig) {
    AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
  }
//返回本次扫描注册的数量
  return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
}

子类ClassPathMapperScanner 的doScan方法又调用了父类ClassPathMapperScanner 的doScan方法然后对beanDefinitions 做了后置处理包装为MapperFactoryBean。

 @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 {
   //这里会包装为MapperFactoryBean
     processBeanDefinitions(beanDefinitions);
   }
   return beanDefinitions;
 }

父类ClassPathMapperScanner 的doScan方法我们在SpringBoot自动配置原理解析(五)中分析@ComponentScan注解解析过程中详细说明过,这里不再赘述。我们接下来看一下processBeanDefinitions方法。

private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
   GenericBeanDefinition definition;
   //遍历beanDefinitions
   for (BeanDefinitionHolder holder : beanDefinitions) {
     definition = (GenericBeanDefinition) holder.getBeanDefinition();
     //比如com.recommend.mapper.SysAdviceMapper
     String beanClassName = definition.getBeanClassName();
     LOGGER.debug(() -> "Creating MapperFactoryBean with name '" + holder.getBeanName() + "' and '" + beanClassName
         + "' mapperInterface");
     // the mapper interface is the original class of the bean
     // but, the actual class of the bean is MapperFactoryBean
     //作为MapperFactoryBean的Class<T> mapperInterface成员
     definition.getConstructorArgumentValues().addGenericArgumentValue(beanClassName); // issue #59
     //设置BeanClass为MapperFactoryBean,其是一个FactoryBean哦
     definition.setBeanClass(this.mapperFactoryBeanClass);
  //添加属性-值
     definition.getPropertyValues().add("addToConfig", this.addToConfig);
     boolean explicitFactoryUsed = false;
     //尝试处理sqlSessionFactory属性值,本文这里sqlSessionFactoryBeanName为null
     if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
       definition.getPropertyValues().add("sqlSessionFactory",
           new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
       explicitFactoryUsed = true;
     } else if (this.sqlSessionFactory != null) {
       definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
       explicitFactoryUsed = true;
     }
 //尝试处理sqlSessionTemplate属性值,本文这里sqlSessionTemplateBeanName为null
     if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
       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;
     }
//设置自动装配类型  AUTOWIRE_BY_TYPE=2
     if (!explicitFactoryUsed) {
       LOGGER.debug(() -> "Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
       definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
     }
     // lazyInitialization默认为false
     definition.setLazyInit(lazyInitialization);
   }
 }


可以看到在这里为BeanDefinition设置了BeanClass为MapperFactoryBean,其是一个MapperFactoryBean,我们后面再实例化我们自己的XXXMapper时就会触发其getObject方法。而我们自己的原始接口类型比如com.recommend.mapper.SysAdviceMapper则作为MapperFactoryBean构造方法的参数。


// MapperFactoryBean
public MapperFactoryBean(Class<T> mapperInterface) {
   this.mapperInterface = mapperInterface;
 }
@Override
public T getObject() throws Exception {
  return getSqlSession().getMapper(this.mapperInterface);
}


【4】PropertySourceOrderingPostProcessor

其是ConfigFileApplicationListener的静态内部类,实现了BeanFactoryPostProcessor,和Ordered接口。其postProcessBeanFactory方法主要用来将我们的defaultProperties-PropertySource排到最后面,如果存在的话。

@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
  reorderSources(this.context.getEnvironment());
}
private void reorderSources(ConfigurableEnvironment environment) {
  PropertySource<?> defaultProperties = environment.getPropertySources().remove(DEFAULT_PROPERTIES);
  // 本文这里为null
  if (defaultProperties != null) {
    environment.getPropertySources().addLast(defaultProperties);
  }
}


目录
相关文章
|
Java Spring
Spring中那些BeanFactoryPostProcessors详解(二)
Spring中那些BeanFactoryPostProcessors详解(二)
100 0
|
3月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
759 0
|
7月前
|
前端开发 Java 数据库
微服务——SpringBoot使用归纳——Spring Boot集成Thymeleaf模板引擎——Thymeleaf 介绍
本课介绍Spring Boot集成Thymeleaf模板引擎。Thymeleaf是一款现代服务器端Java模板引擎,支持Web和独立环境,可实现自然模板开发,便于团队协作。与传统JSP不同,Thymeleaf模板可以直接在浏览器中打开,方便前端人员查看静态原型。通过在HTML标签中添加扩展属性(如`th:text`),Thymeleaf能够在服务运行时动态替换内容,展示数据库中的数据,同时兼容静态页面展示,为开发带来灵活性和便利性。
335 0
|
7月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于 xml 的整合
本教程介绍了基于XML的MyBatis整合方式。首先在`application.yml`中配置XML路径,如`classpath:mapper/*.xml`,然后创建`UserMapper.xml`文件定义SQL映射,包括`resultMap`和查询语句。通过设置`namespace`关联Mapper接口,实现如`getUserByName`的方法。Controller层调用Service完成测试,访问`/getUserByName/{name}`即可返回用户信息。为简化Mapper扫描,推荐在Spring Boot启动类用`@MapperScan`注解指定包路径避免逐个添加`@Mapper`
327 0
|
7月前
|
Java 测试技术 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——少量配置信息的情形
本课主要讲解Spring Boot项目中的属性配置方法。在实际开发中,测试与生产环境的配置往往不同,因此不应将配置信息硬编码在代码中,而应使用配置文件管理,如`application.yml`。例如,在微服务架构下,可通过配置文件设置调用其他服务的地址(如订单服务端口8002),并利用`@Value`注解在代码中读取这些配置值。这种方式使项目更灵活,便于后续修改和维护。
105 0
|
7月前
|
SQL Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— application.yml 中对日志的配置
在 Spring Boot 项目中,`application.yml` 文件用于配置日志。通过 `logging.config` 指定日志配置文件(如 `logback.xml`),实现日志详细设置。`logging.level` 可定义包的日志输出级别,例如将 `com.itcodai.course03.dao` 包设为 `trace` 级别,便于开发时查看 SQL 操作。日志级别从高到低为 ERROR、WARN、INFO、DEBUG,生产环境建议调整为较高级别以减少日志量。本课程采用 yml 格式,因其层次清晰,但需注意格式要求。
643 0
|
3月前
|
缓存 JSON 前端开发
第07课:Spring Boot集成Thymeleaf模板引擎
第07课:Spring Boot集成Thymeleaf模板引擎
409 0
第07课:Spring Boot集成Thymeleaf模板引擎
|
7月前
|
缓存 NoSQL Java
基于SpringBoot的Redis开发实战教程
Redis在Spring Boot中的应用非常广泛,其高性能和灵活性使其成为构建高效分布式系统的理想选择。通过深入理解本文的内容,您可以更好地利用Redis的特性,为应用程序提供高效的缓存和消息处理能力。
557 79
|
4月前
|
Prometheus 监控 Cloud Native
Spring Boot 可视化监控
本文介绍了如何通过Spring Actuator、Micrometer、Prometheus和Grafana为Spring Boot应用程序添加监控功能。首先创建了一个Spring Boot应用,并配置了Spring Actuator以暴露健康状态和指标接口。接着,利用Micrometer收集应用性能数据,并通过Prometheus抓取这些数据进行存储。最后,使用Grafana将Prometheus中的数据可视化,展示在精美的仪表板上。整个过程简单易行,为Spring Boot应用提供了基本的监控能力,同时也为后续扩展更详细的监控指标奠定了基础。
705 2
|
7月前
|
Java Spring
SpringBoot自动配置原理
本文深入解析了SpringBoot的核心功能——自动配置,重点探讨了`org.springframework.boot.autoconfigure`及相关注解的工作机制。通过分析`@SpringBootApplication`、`@EnableAutoConfiguration`等注解,揭示了SpringBoot如何基于类路径和条件自动装配Bean
347 7