Springboot擴展點之BeanDefinitionRegistryPostProcessor，你學會了嗎？
前言
通過這篇文章來大家分享一下，另外一個Springboot的擴展點BeanDefinitionRegistryPostProcessor，一般稱這類擴展點為容器級后置處理器，另外一類是Bean級的后置處理器；容器級的后置處理器會在Spring容器初始化后、刷新前這個時間執行一次，Bean級的后置處理器，則是在每一個Bean實例化前后都會執行。
圖片
功能特性
- postProcessBeanDefinitionRegistry()方法 可以通過BeanDefinitionRegistry對BeanDefintion進行增刪改查；
- 繼承了BeanFactoryPostProcessor，BeanFactoryPostProcessor是容器級別的擴展接口，org.springframework.beans.factory.config.BeanFactoryPostProcessor#postProcessBeanFactory方法在容器實例化后、刷新容器前被執行，即在容器刷新前還可以對BeanDefintion再作一些操作；
public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {
void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;
}@FunctionalInterface
public interface BeanFactoryPostProcessor {
void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;
}總結起來就是，在所有的BeanDefinition加載完成之后，Bean真正被實例化之前，可以通過實現BeanDefinitionRegistryPostProcessor接口，對BeanDefinition再做一些定制化的操作，比如修改某個bean的BeanDefinition的屬性、手動注冊一些復雜的Bean。
對于Spring原理不太熟悉的小伙伴心里看到這可能有點暈了，BeanDefinition是什么？BeanDefinitionRegistry又是什么？ConfigurableListableBeanFactory又又是什么？別著急，這里拐個彎簡單的解釋一下，方便下面的內容理解起來更順暢。
BeanDefinition
大家都知道，Spring的核心之一是IOC（控制反轉），Spring之所以可以實現bean控制權的反轉，是因為Spring的容器功能，在bean納入Spring容器管理前，所有bean會被抽象封裝成一個BeanDefinition實例，然后會在不同的時機根據BeanDefinition實例信息對bean進行實例化。
簡單說，Dog.java描述狗這一類動物的屬性和行為，BeanDefinition描述Dog.java這個類。
BeanDefinitionRegistry
BeanDefinitionRegistry從字面意思看是bean的定義信息的注冊登記，其實這個類的功能和字面意思一樣，就是對BeanDefinition進行管理（增刪改查）；
public interface BeanDefinitionRegistry extends AliasRegistry {
//注冊beanDefinition
void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException;
//移除指定的beanDefinition
void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
//根據beanName查詢beanDefinition
BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
//判斷某個beanDefinition是否已經注冊
boolean containsBeanDefinition(String beanName);
//獲取所有已注冊的beanDefinition
String[] getBeanDefinitionNames();
//獲取所有已注冊的beanDefinition的數量
int getBeanDefinitionCount();
//判斷某個beanDefinition是否已經被使用
boolean isBeanNameInUse(String beanName);
}ConfigurableListableBeanFactory
上面提到了Spring的容器，Spring的核心之一是IOC，那么Spring的容器設計就是核心中的核心了。Spring的容器有多種形態，最基礎的形態就是BeanFactory，ConfigurableListableBeanFactory間接繼承了BeanFactory，因此ConfigurableListableBeanFactory實現類除了有Spring基礎版本容器的功能外，還有一些高級的功能，Springboot默認的實際實現是DefaultListableBeanFactory，有興趣的小伙伴可以以此為入口深入探究一番，這里不展開細說了。
圖片
自定義實現
MyBeanDefinitionRegistryPostProcessor
下面通過一個具體類MyBeanDefinitionRegistryPostProcessor實現BeanDefinitionRegistryPostProcessor接口，來探究BeanDefinitionRegistryPostProcessor實現類的初始化和執行過程。
- 在postProcessBeanDefinitionRegistry()方法被調用的時候手工在Spring中注冊了Dog類的BeanDefinition信息；
- 在postProcessBeanFactory()方法被調用的時候，從Spring容器中取出Dog類的BeanDefinition信息和Dog類的實例；
@Data
public class Dog {
private String name;
private String color;
}@Component
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
//手工定義一個beanDefinition實例
RootBeanDefinition beanDefinition = new RootBeanDefinition();
//給beanDefinition填充屬性
beanDefinition.setBeanClass(Dog.class);
MutablePropertyValues propertyValues = new MutablePropertyValues();
PropertyValue propertyValue1 = new PropertyValue("name", "旺財");
PropertyValue propertyValue2 = new PropertyValue("color", "黑色");
propertyValues.addPropertyValue(propertyValue1);
propertyValues.addPropertyValue(propertyValue2);
beanDefinition.setPropertyValues(propertyValues);
//注冊手工定義的beanDefinition
registry.registerBeanDefinition("dog", beanDefinition);
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
System.out.println("-----------start------------");
//根據類名取出手工注冊的beanDefinition
BeanDefinition beanDefinition = beanFactory.getBeanDefinition("dog");
System.out.println(beanDefinition.getBeanClassName());
//根據類從容器中取出手工注冊的beanDefinition所描述的實例bean
Dog dog = beanFactory.getBean(Dog.class);
System.out.println(dog.getName());
System.out.println(dog.getColor());
System.out.println("-----------end------------");
}
}單元測試
@Test
public void test(){
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext("com.fanfu");
Dog dog = ((Dog) context.getBean("dog"));
System.out.println(dog.getName());
System.out.println(dog.getColor());
}UML類圖
通過BeanDefinitionRegistryPostProcessorUML類圖可以看出BeanDefinitionRegistryPostProcessor繼承了BeanFactoryPostProcessor，postProcessBeanDefinitionRegistry()方法屬于BeanDefinitionRegistryPostProcessor，postProcessBeanFactory()屬于BeanFactoryPostProcessor，所有實現了BeanDefinitionRegistryPostProcessor接口的實現類都需要實現這個方法，而作為Springboot的擴展點之一，其擴展的邏輯也在這兩個方法中；
圖片
初始化和執行時機
通過自定義的MyBeanDefinitionRegistryPostProcessor類，實現BeanDefinitionRegistryPostProcessor接口，從項目啟動開始，其執行過程如下：
- 執行項目的主類，SpringApplication#run被調用；
- 進入boot.SpringApplication#run方法后，剛開始是一些Spring容器初始化的配置操作，直到執行到SpringApplication#refreshContext，開始容器刷新，進入了關鍵階段；
- 在SpringApplication#refreshContext，實際的刷新邏輯是在AbstractApplicationContext#refresh方法中；
- AbstractApplicationContext#refresh方法中，調用AbstractApplicationContext#invokeBeanFactoryPostProcessors開始初始化和執行實現BeanDefinitionRegistryPostProcessor接口的postProcessBeanDefinitionRegistry()和postProcessBeanFactory()；
- 進入AbstractApplicationContext#invokeBeanFactoryPostProcessors方法，發現又調用了PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()；
- 在PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()方法中，并不是直接就初始化和執行postProcessBeanDefinitionRegistry()和postProcessBeanFactory()，而是又進行了一系列的判斷，其判斷順序是：1、通過AbstractApplicationContext#addBeanFactoryPostProcessor提前注冊的BeanDefinitionRegistryPostProcessor實現類；2、實現了PriorityOrdered接口；3、是否實現了Ordered；4、剩下的其他BeanDefinitionRegistryPostProcessor實現類；自定義的MyBeanDefinitionRegistryPostProcessor就屬于第4類，所以是所有實現里較晚才被執行的，如果想要提前被執行，可以考慮前面三種方式；
- 在PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()方法中執行完MyBeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry方法后，緊接著就開始執行MyBeanDefinitionRegistryPostProcessor#postProcessBeanFactory方法了；從整個調用過程看postProcessBeanDefinitionRegistry()是早于postProcessBeanFactory()方法執行；
下面是我根據整個調用過程畫的一個時序圖，過程確實比較復雜，但是邏輯比較清晰，因此并不難理解，想要真的搞清楚整個過程，最好的方法就是照著這個圖，親自執行一遍，通過debug觀察每一個關鍵節點的執行過程。
圖片
內部實現類
spring-boot-starter-web中內置的實現類有CachingMetadataReaderFactoryPostProcessor、ConfigurationClassPostProcessor、ConfigurationWarningsPostProcessor、EmbeddedDataSourceBeanFactoryPostProcessor、ImportsCleanupPostProcessor、TestRestTemplateRegistrar、WebTestClientRegistrar、WsdlDefinitionBeanFactoryPostProcessor，觀察一下每個實現類會發現：都比較類似，這些內置實現類都是Springboot中的內部類，通過這些BeanDefinitionRegistryPostProcessor內部實現類向Spring容器中注冊了一些特殊的BeanDefinition，如果展開詳細再說一說這些Bean，怕是一天一夜也說不完，有興趣的小伙伴可以深入了解一下，這里就不再展開了。
總結
通過梳理整個過程，其實最關鍵的就是一句話：在Spring容器初始后、未刷新前，即Bean已被掃描注冊為BeanDefinition后，未正式實例化前，可以通過實現BeanDefinitionRegistryPostProcessor做一些額外的操作。
