流程图解Spring Framework(五) Spring BeanFactoryPostProcessor如何工作的?

本文主要是介绍流程图解Spring Framework(五) Spring BeanFactoryPostProcessor如何工作的?,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

BeanPostProcessor这个概念可以认为是在spring声明周期中留下的一个钩子,这个钩子是在所有的BeanDefinition被扫描完成之后这个阶段的。我们可以在这里做很多事情,Spring框架里面很多特性也利用了这里,比如属性注入

具体在 查看详细信息

BeanFactoryPostProcessor的定义

在Spring框架设计之中,我们可以看到优秀的设计之处,最为精妙的就是扩展点的设置,这样使我们对Spring的扩展,很多时候只需要继承一个类,把它注册为一个Bean即可。

BeanFactoryPostProcessor从字面的意思上是BeanFactory的后置处理器。也可以认为是在spring生命周期中留下的一个钩子,这个钩子是在所有的BeanDefinition被扫描完成之后这个阶段的。但是在Spring中是这样描述这个扩展点的作用的,

Allows for custom modification of an application context’s bean definitions,
adapting the bean property values of the context’s underlying bean factory`

翻译过来大致是下面个意思

这个扩展点允许修改应用程序上下文(ApplicationContext)中的BeanDefinition,以及bean的属性值。

BeanFactoryPostProcessor 的执行优先级

因为BeanFactoryPostProcessor是一个扩展点,所以当有多个Bean实现这个扩展点的时候,必回存在一个执行顺序的问题,那么Spring是如何设计的呢?

`

1.执行BeanDefinitionRegistryPostProcessor接口的后置处理器

  • 执行通过配置的BeanDefinitionRegistry后置处理器,执行顺序是PriorityOrdered(排序是按照从小到大排)-> Ordered -> 普通的

  • 执行硬编码的BeanDefinitionRegistryPostProcessor

2.执行普通的BeanFactoryPostProcessor

  • 执行硬编码的后置处理器

  • 执行通过配置注册的处理器,执行顺序是PriorityOrdered(排序是按照从小到大排)->Ordered->普通的

在这一节可以看到后置处理器的执行顺序,应该大家都有一个疑惑,这么优秀的东西是如何实现的呢?
不仅大胆的想想,无非就是会把所有的实现这个扩展点的Bean都找出来,然后排序,最后执行,那么Spring是不是这样做的呢?

BeanFactoryPostProcessor的源码阅读

接口定义

在Spring框架中的接口定义如下

public interface BeanFactoryPostProcessor {// 上下文中的BeanFactoryvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;}

执行逻辑

Spring容器的启动入口

AbstractApplicationContext#refresh 的第三步invokeBeanFactoryPostProcessors

public void refresh() throws BeansException, IllegalStateException {synchronized (this.startupShutdownMonitor) {prepareRefresh();ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();prepareBeanFactory(beanFactory);try {postProcessBeanFactory(beanFactory);// 执行上下文中注册的Bean工厂后置处理器invokeBeanFactoryPostProcessors(beanFactory);...}}
public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) {//// 1. 首先执行 BeanDefinitionRegistryPostProcessors (优秀的BeanFactoryPostProcessor)//Set<String> processedBeans = new HashSet<String>();// 1.0 如果beanFactory是BeanDefinitionRegistry类型的,也就是说BeanFactory中允许对BeanDefinition进行增删改的操作if (beanFactory instanceof BeanDefinitionRegistry) {BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;// 1.1 先执行硬编码的BeanDefinitionRegistryPostProcessorList<BeanFactoryPostProcessor> regularPostProcessors = new LinkedList<BeanFactoryPostProcessor>();List<BeanDefinitionRegistryPostProcessor> registryPostProcessors =new LinkedList<BeanDefinitionRegistryPostProcessor>();for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) {if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) {BeanDefinitionRegistryPostProcessor registryPostProcessor =(BeanDefinitionRegistryPostProcessor) postProcessor;registryPostProcessor.postProcessBeanDefinitionRegistry(registry);registryPostProcessors.add(registryPostProcessor);}else {regularPostProcessors.add(postProcessor);}}String[] postProcessorNames =beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);// 1.2 首先执行实现PriorityOrdered接口的BeanDefinitionRegistryPostProcessorList<BeanDefinitionRegistryPostProcessor> priorityOrderedPostProcessors = new ArrayList<BeanDefinitionRegistryPostProcessor>();for (String ppName : postProcessorNames) {if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));processedBeans.add(ppName);}}sortPostProcessors(beanFactory, priorityOrderedPostProcessors);registryPostProcessors.addAll(priorityOrderedPostProcessors);invokeBeanDefinitionRegistryPostProcessors(priorityOrderedPostProcessors, registry);// 1.3 接下来执行实现Ordered接口的BeanDefinitionRegistryPostProcessorspostProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);List<BeanDefinitionRegistryPostProcessor> orderedPostProcessors = new ArrayList<BeanDefinitionRegistryPostProcessor>();for (String ppName : postProcessorNames) {if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) {orderedPostProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));processedBeans.add(ppName);}}// 排序sortPostProcessors(beanFactory, orderedPostProcessors);registryPostProcessors.addAll(orderedPostProcessors);invokeBeanDefinitionRegistryPostProcessors(orderedPostProcessors, registry);//  1.4 执行其它的硬编码的的BeanDefinitionRegistryPostProcessorsboolean reiterate = true;while (reiterate) {reiterate = false;postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);for (String ppName : postProcessorNames) {if (!processedBeans.contains(ppName)) {BeanDefinitionRegistryPostProcessor pp = beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class);registryPostProcessors.add(pp);processedBeans.add(ppName);pp.postProcessBeanDefinitionRegistry(registry);reiterate = true;}}}// 执行invokeBeanFactoryPostProcessors(registryPostProcessors, beanFactory);invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);}else {// Invoke factory processors registered with the context instance.invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);}//// 2. 执行 BeanFactoryPostProcessor //String[] postProcessorNames =beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false);// 2.1 将后置处理器根据不同类型(PriorityOrdered、Ordered、其它)分组List<BeanFactoryPostProcessor> priorityOrderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();List<String> orderedPostProcessorNames = new ArrayList<String>();List<String> nonOrderedPostProcessorNames = new ArrayList<String>();for (String ppName : postProcessorNames) {if (processedBeans.contains(ppName)) {// skip - already processed in first phase above}else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class));}else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {orderedPostProcessorNames.add(ppName);}else {nonOrderedPostProcessorNames.add(ppName);}}// 2.2 首先执行优先级Order类型的后置处理器sortPostProcessors(beanFactory, priorityOrderedPostProcessors);invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);// 2.3 执行带有Order接口的后置处理器List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();for (String postProcessorName : orderedPostProcessorNames) {orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));}sortPostProcessors(beanFactory, orderedPostProcessors);invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);// 2.4 执行其它的所有后置处理器List<BeanFactoryPostProcessor> nonOrderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();for (String postProcessorName : nonOrderedPostProcessorNames) {nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));}invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);// 清空元数据cache,因为beandefine有可能会变beanFactory.clearMetadataCache();}

BeanFactoryPostProcessor 在Spring中的应用

在Spring中,有很多的框架类实现了这个类并且做了一些事情。。
在这里插入图片描述

上图是一个只依赖spring-boot-starter-web的空工程中所有的BeanFactoryPostProcessor实现,可以看到有以下扩展点

  • PropertyResourceConfigurer。配合上PlaceholderResolvingStringValueResolver,为@Value注解提供支持
  • BeanDefinitionRegistryPostProcessor,这个比如Dubbo中的Reference和Service就是通过这个接口在Spring容器中注册为Bean 的,比较适用于一些框架添加自定义的Bean的场景。
  • CustomScopeConfigurer(自定义的Scope处理)
  • ServletComponentRegisteringPostProcessor(自动扫描Servlet的三剑客)
  • DeprecatedBeanWarner(在Bean上面添加一个过期的标志,有意思)
  • AbstractDependsOnBeanFactoryPostProcessor(用于动态声明特定类型的所有bean应该依赖于一个或多个特定bean。,应用场景比如在一些框架上,有一些Bean进行初始化之前必须等待一些连接类Bean准备好,如这里面的MongoClient,MongoClientFactoryBean)
  • CustomAutowireConfigurer,自定义Qualifier类型,和@Qualifier一个意思
  • ConfigurationBeanFactoryMetaData 在bean工厂初始化期间记住Bean定义元数据的一个工具类。保存了工厂方法名称和工厂Bean的名称,可以后续根据beanName

BeanFactoryPostProcessor 小例子

  1. 使用BeanFactoryPostProcessor注册一个bean
@Component
public class RegisteBeanBeanDefinitionRegistry implements BeanDefinitionRegistryPostProcessor,Ordered {@Overridepublic void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {RootBeanDefinition rbd = new RootBeanDefinition();rbd.setTargetType(User.class);rbd.setBeanClass(User.class);registry.registerBeanDefinition("user-wuhulala", rbd);}@Overridepublic int getOrder() {return 0;}@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {// do nothing}
}
  1. 使用BeanFactoryPostProcessor丰富Bean的属性
public class ModifyBeanBeanFactoryPostProcessor implements BeanFactoryPostProcessor,Ordered {@Overridepublic int getOrder() {return 0;}@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {RootBeanDefinition bd = (RootBeanDefinition) beanFactory.getBeanDefinition("user-wuhulala");MutablePropertyValues values = new MutablePropertyValues();values.addPropertyValue("name", "wuhulala");values.addPropertyValue("age", 21);Address address = new Address();address.setName("浙江省");values.addPropertyValue("address", address);bd.setPropertyValues(values);}
}

使用BeanFactoryPostProcessor注意点

  1. 如果使用BeanDefinitionRegistry接口,那么应该是对当前IOC容器的Bean的一种补充或删除。
  2. BeanFactoryPostProcessor可以操作BeanDefinition,但永远不要与bean实例交互。也就是不要在这里进行Bean的实例化。 因为在这里实例化的话会过早,违反了容器的设计规则并有可能会导致意外的副作用。比如这里初始化的Bean依赖于其它的Bean,就会导致这个链路上的Bean都进行了初始化,从而导致它依赖Bean没有被BeanFactoryPostProcessor处理过对应的BeanDefinition。如果需要bean实例交互,可以实现另一个扩展点 BeanPostProcessor。
  3. 在BeanFactoryPostProcessor不要进行Bean的注册。

聊聊设计

Spring扩展点在Spring核心中是很重要的概念,spring本身就内置了很多实现。如果我们需要扩展Spring的功能,他们是很好的方式。并且它们可以像插件一样很好的工作。

在我们日常进行程序的设计编码时候,当一处进行多次的修改(添加、删除、修改细节)的时候,我们也可以尝试着抽取出一个扩展点,这样会使我们的程序变得极为简单。

比如我最近在做的一个项目流程,其实在项目新增之前和之后都需要进行很多的逻辑处理,比如调用远程服务、参数校验、后置处理,并且需求变动很频繁,那么现在依葫芦画瓢,把项目流程分为新增前、新增、新增后三个逻辑,抽象出preAddProcessor/postAddProcessor两个接口,最后用一段通用逻辑进行拼接,如有兴趣,可私聊。

这篇关于流程图解Spring Framework(五) Spring BeanFactoryPostProcessor如何工作的?的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1113919

相关文章

Spring Security常见问题及解决方案

《SpringSecurity常见问题及解决方案》SpringSecurity是Spring生态的安全框架,提供认证、授权及攻击防护,支持JWT、OAuth2集成,适用于保护Spring应用,需配置... 目录Spring Security 简介Spring Security 核心概念1. ​Securit

SpringBoot+EasyPOI轻松实现Excel和Word导出PDF

《SpringBoot+EasyPOI轻松实现Excel和Word导出PDF》在企业级开发中,将Excel和Word文档导出为PDF是常见需求,本文将结合​​EasyPOI和​​Aspose系列工具实... 目录一、环境准备与依赖配置1.1 方案选型1.2 依赖配置(商业库方案)二、Excel 导出 PDF

SpringBoot改造MCP服务器的详细说明(StreamableHTTP 类型)

《SpringBoot改造MCP服务器的详细说明(StreamableHTTP类型)》本文介绍了SpringBoot如何实现MCPStreamableHTTP服务器,并且使用CherryStudio... 目录SpringBoot改造MCP服务器(StreamableHTTP)1 项目说明2 使用说明2.1

spring中的@MapperScan注解属性解析

《spring中的@MapperScan注解属性解析》@MapperScan是Spring集成MyBatis时自动扫描Mapper接口的注解,简化配置并支持多数据源,通过属性控制扫描路径和过滤条件,利... 目录一、核心功能与作用二、注解属性解析三、底层实现原理四、使用场景与最佳实践五、注意事项与常见问题六

Spring的RedisTemplate的json反序列泛型丢失问题解决

《Spring的RedisTemplate的json反序列泛型丢失问题解决》本文主要介绍了SpringRedisTemplate中使用JSON序列化时泛型信息丢失的问题及其提出三种解决方案,可以根据性... 目录背景解决方案方案一方案二方案三总结背景在使用RedisTemplate操作redis时我们针对

Java中Arrays类和Collections类常用方法示例详解

《Java中Arrays类和Collections类常用方法示例详解》本文总结了Java中Arrays和Collections类的常用方法,涵盖数组填充、排序、搜索、复制、列表转换等操作,帮助开发者高... 目录Arrays.fill()相关用法Arrays.toString()Arrays.sort()A

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4

Java堆转储文件之1.6G大文件处理完整指南

《Java堆转储文件之1.6G大文件处理完整指南》堆转储文件是优化、分析内存消耗的重要工具,:本文主要介绍Java堆转储文件之1.6G大文件处理的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言文件为什么这么大?如何处理这个文件?分析文件内容(推荐)删除文件(如果不需要)查看错误来源如何避