专栏名称: Java专栏
一个Java、Python、数据库、中间件、业内资讯、面试、学习资源等干货的知识分享社区。
目录
相关文章推荐
51好读  ›  专栏  ›  Java专栏

非常有必要了解的Springboot启动扩展点

Java专栏  · 公众号  ·  · 2020-10-31 18:00

正文

注意 文末有最新 Java实战 项目 面试题


来源:r6d.cn/r4P7



背景

Spring的核心思想就是容器,当容器refresh的时候,外部看上去风平浪静,其实内部则是一片惊涛骇浪,汪洋一片。Springboot更是封装了Spring,遵循约定大于配置,加上自动装配的机制。很多时候我们只要引用了一个依赖,几乎是零配置就能完成一个功能的装配。

我非常喜欢这种自动装配的机制,所以在自己开发中间件和公共依赖工具的时候也会用到这个特性。让使用者以最小的代价接入。想要把自动装配玩的转,就必须要了解spring对于bean的构造生命周期以及各个扩展接口。当然了解了bean的各个生命周期也能促进我们加深对spring的理解。业务代码也能合理利用这些扩展点写出更加漂亮的代码。

在网上搜索spring扩展点,发现很少有博文说的很全的,只有一些常用的扩展点的说明。

所以在这篇文章里,我总结了几乎Spring & Springboot所有的扩展接口,以及各个扩展点的使用场景。并且整理出了一个bean在spring内部从被加载到最后初始化完成所有可扩展点的顺序调用图。从而我们也能窥探到bean是如何一步步加载到spring容器中的。

2.可扩展的接口启动调用顺序图

以下是我整理的spring容器中Bean的生命周期内所有可扩展的点的调用顺序,下面会一个个分析

3.ApplicationContextInitializer

org.springframework.context.ApplicationContextInitializer

这是整个spring容器在刷新之前初始化ConfigurableApplicationContext的回调接口,简单来说,就是在容器刷新之前调用此类的initialize方法。这个点允许被用户自己扩展。用户可以在整个spring容器还没被初始化之前做一些事情。

可以想到的场景可能为,在最开始激活一些配置,或者利用这时候class还没被类加载器加载的时机,进行动态字节码注入等操作。

扩展方式为:

  1. publicclassTestApplicationContextInitializerimplementsApplicationContextInitializer{

  2. @Override

  3. publicvoid initialize(ConfigurableApplicationContext applicationContext){

  4. System.out.println("[ApplicationContextInitializer]");

  5. }

  6. }

因为这时候spring容器还没被初始化,所以想要自己的扩展的生效,有以下三种方式:

在启动类中用springApplication.addInitializers(new TestApplicationContextInitializer())语句加入
配置文件配置context.initializer.classes=com.example.demo.TestApplicationContextInitializer
Spring SPI扩展,在spring.factories中加入org.springframework.context.ApplicationContextInitializer=com.example.demo.TestApplicationContextInitializer

4.BeanDefinitionRegistryPostProcessor

org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor

这个接口在读取项目中的beanDefinition之后执行,提供一个补充的扩展点

使用场景:你可以在这里动态注册自己的beanDefinition,可以加载classpath之外的bean

扩展方式为:

  1. publicclassTestBeanDefinitionRegistryPostProcessorimplementsBeanDefinitionRegistryPostProcessor{

  2. @Override

  3. publicvoid postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)throwsBeansException{

  4. System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanDefinitionRegistry");

  5. }


  6. @Override

  7. publicvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)throwsBeansException{

  8. System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanFactory");

  9. }

  10. }

5.BeanFactoryPostProcessor

org.springframework.beans.factory.config.BeanFactoryPostProcessor

这个接口是beanFactory的扩展接口,调用时机在spring在读取beanDefinition信息之后,实例化bean之前。

在这个时机,用户可以通过实现这个扩展接口来自行处理一些东西,比如修改已经注册的beanDefinition的元信息。

扩展方式为:

  1. publicclassTestBeanFactoryPostProcessorimplementsBeanFactoryPostProcessor{

  2. @Override

  3. publicvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)throwsBeansException{

  4. System.out.println("[BeanFactoryPostProcessor]");

  5. }

  6. }

6.InstantiationAwareBeanPostProcessor

org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor

该接口继承了BeanPostProcess接口,区别如下:

BeanPostProcess接口只在bean的初始化阶段进行扩展(注入spring上下文前后),而InstantiationAwareBeanPostProcessor接口在此基础上增加了3个方法,把可扩展的范围增加了实例化阶段和属性注入阶段。

该类主要的扩展点有以下5个方法,主要在bean生命周期的两大阶段: 实例化阶段 初始化阶段 ,下面一起进行说明,按调用顺序为:

postProcessBeforeInstantiation:实例化bean之前,相当于new这个bean之前
postProcessAfterInstantiation:实例化bean之后,相当于new这个bean之后
postProcessPropertyValues:bean已经实例化完成,在属性注入时阶段触发,@Autowired,@Resource等注解原理基于此方法实现
postProcessBeforeInitialization:初始化bean之前,相当于把bean注入spring上下文之前
postProcessAfterInitialization:初始化bean之后,相当于把bean注入spring上下文之后
使用场景:这个扩展点非常有用 ,无论是写中间件和业务中,都能利用这个特性。比如对实现了某一类接口的bean在各个生命期间进行收集,或者对某个类型的bean进行统一的设值等等。

扩展方式为:

  1. publicclassTestInstantiationAwareBeanPostProcessorimplementsInstantiationAwareBeanPostProcessor{


  2. @Override

  3. publicObject postProcessBeforeInitialization(Object bean,String beanName)throwsBeansException{

  4. System.out.println("[TestInstantiationAwareBeanPostProcessor] before initialization "+ beanName);

  5. return bean;

  6. }


  7. @Override

  8. publicObject postProcessAfterInitialization(Object bean,String beanName)throwsBeansException{

  9. System.out.println("[TestInstantiationAwareBeanPostProcessor] after initialization "+ beanName);

  10. return bean;

  11. }


  12. @Override

  13. publicObject postProcessBeforeInstantiation(Class> beanClass,String beanName)throwsBeansException{

  14. System.out.println("[TestInstantiationAwareBeanPostProcessor] before instantiation "+ beanName);

  15. returnnull;

  16. }


  17. @Override

  18. publicboolean postProcessAfterInstantiation(Object bean,String beanName)throwsBeansException{

  19. System.out.println("[TestInstantiationAwareBeanPostProcessor] after instantiation "+ beanName);

  20. returntrue;

  21. }


  22. @Override

  23. publicPropertyValues postProcessPropertyValues(PropertyValues pvs,PropertyDescriptor[] pds,Object bean,String beanName)throwsBeansException{

  24. System.out.println("[TestInstantiationAwareBeanPostProcessor] postProcessPropertyValues "+ beanName);

  25. return pvs;

  26. }

7.SmartInstantiationAwareBeanPostProcessor

org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor

该扩展接口有3个触发点方法:

predictBeanType:该触发点发生在postProcessBeforeInstantiation之前(在图上并没有标明,因为一般不太需要扩展这个点),这个方法用于预测Bean的类型,返回第一个预测成功的Class类型,如果不能预测返回null;当你调用BeanFactory.getType(name)时当通过bean的名字无法得到bean类型信息时就调用该回调方法来决定类型信息。
determineCandidateConstructors:该触发点发生在postProcessBeforeInstantiation之后,用于确定该bean的构造函数之用,返回的是该bean的所有构造函数列表。用户可以扩展这个点,来自定义选择相应的构造器来实例化这个bean。
getEarlyBeanReference:该触发点发生在postProcessAfterInstantiation之后,当有循环依赖的场景,当bean实例化好之后,为了防止有循环依赖,会提前暴露回调方法,用于bean实例化的后置处理。这个方法就是在提前暴露的回调方法中触发。
扩展方式为:

  1. publicclassTestSmartInstantiationAwareBeanPostProcessorimplementsSmartInstantiationAwareBeanPostProcessor{


  2. @Override

  3. publicClass> predictBeanType(Class> beanClass,String beanName)throwsBeansException{

  4. System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] predictBeanType "+ beanName);

  5. return beanClass;

  6. }


  7. @Override

  8. publicConstructor>[] determineCandidateConstructors(Class> beanClass,String beanName)throwsBeansException{

  9. System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] determineCandidateConstructors "+ beanName);

  10. returnnull;

  11. }


  12. @Override

  13. publicObject getEarlyBeanReference(Object bean,String beanName)throwsBeansException{

  14. System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] getEarlyBeanReference "+ beanName);

  15. return bean;

  16. }

  17. }

8.BeanFactoryAware

org.springframework.beans.factory.BeanFactoryAware

这个类只有一个触发点,发生在bean的实例化之后,注入属性之前,也就是Setter之前。这个类的扩展点方法为setBeanFactory,可以拿到BeanFactory这个属性。

使用场景为,你可以在bean实例化之后,但还未初始化之前,拿到 BeanFactory,在这个时候,可以对每个bean作特殊化的定制。也或者可以把BeanFactory拿到进行缓存,日后使用。







请到「今天看啥」查看全文