1.背景
Spring的核心思想就是容器，當(dāng)容器refresh的時(shí)候，外部看上去風(fēng)平浪靜，其實(shí)內(nèi)部則是一片驚濤駭浪，汪洋一片。Springboot更是封裝了Spring，遵循約定大于配置，加上自動(dòng)裝配的機(jī)制。很多時(shí)候我們只要引用了一個(gè)依賴，幾乎是零配置就能完成一個(gè)功能的裝配。
我非常喜歡這種自動(dòng)裝配的機(jī)制，所以在自己開發(fā)中間件和公共依賴工具的時(shí)候也會(huì)用到這個(gè)特性。讓使用者以最小的代價(jià)接入。想要把自動(dòng)裝配玩的轉(zhuǎn)，就必須要了解spring對(duì)于bean的構(gòu)造生命周期以及各個(gè)擴(kuò)展接口。當(dāng)然了解了bean的各個(gè)生命周期也能促進(jìn)我們加深對(duì)spring的理解。業(yè)務(wù)代碼也能合理利用這些擴(kuò)展點(diǎn)寫出更加漂亮的代碼
在網(wǎng)上搜索spring擴(kuò)展點(diǎn)，發(fā)現(xiàn)很少有博文說的很全的，只有一些常用的擴(kuò)展點(diǎn)的說明。
所以在這篇文章里，我總結(jié)了幾乎Spring & Springboot所有的擴(kuò)展接口，以及各個(gè)擴(kuò)展點(diǎn)的使用場景。并且整理出了一個(gè)bean在spring內(nèi)部從被加載到最后初始化完成所有可擴(kuò)展點(diǎn)的順序調(diào)用圖。從而我們也能窺探到bean是如何一步步加載到spring容器中的。
2.可擴(kuò)展的接口啟動(dòng)調(diào)用順序圖
以下是我整理的spring容器中Bean的生命周期內(nèi)所有可擴(kuò)展的點(diǎn)的調(diào)用順序，下面會(huì)一個(gè)個(gè)分析
3.ApplicationContextInitializer
org.springframework.context.ApplicationContextInitializer
這是整個(gè)spring容器在刷新之前初始化ConfigurableApplicationContext的回調(diào)接口，簡單來說，就是在容器刷新之前調(diào)用此類的initialize方法。這個(gè)點(diǎn)允許被用戶自己擴(kuò)展。用戶可以在整個(gè)spring容器還沒被初始化之前做一些事情。
可以想到的場景可能為，在最開始激活一些配置，或者利用這時(shí)候class還沒被類加載器加載的時(shí)機(jī)，進(jìn)行動(dòng)態(tài)字節(jié)碼注入等操作。
擴(kuò)展方式為：
public class TestApplicationContextInitializer implements ApplicationContextInitializer {
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
System.out.println("[ApplicationContextInitializer]");
}
}
因?yàn)檫@時(shí)候spring容器還沒被初始化，所以想要自己的擴(kuò)展的生效，有以下三種方式：
-
在啟動(dòng)類中用springApplication.addInitializers(new TestApplicationContextInitializer())語句加入 -
配置文件配置context.initializer.classes=com.example.demo.TestApplicationContextInitializer -
Spring SPI擴(kuò)展，在spring.factories中加入org.springframework.context.ApplicationContextInitializer=com.example.demo.TestApplicationContextInitializer
4.BeanDefinitionRegistryPostProcessor
org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor
這個(gè)接口在讀取項(xiàng)目中的beanDefinition之后執(zhí)行，提供一個(gè)補(bǔ)充的擴(kuò)展點(diǎn)
使用場景：你可以在這里動(dòng)態(tài)注冊(cè)自己的beanDefinition，可以加載classpath之外的bean
擴(kuò)展方式為:
public class TestBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanDefinitionRegistry");
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanFactory");
}
}
5.BeanFactoryPostProcessor
org.springframework.beans.factory.config.BeanFactoryPostProcessor
這個(gè)接口是beanFactory的擴(kuò)展接口，調(diào)用時(shí)機(jī)在spring在讀取beanDefinition信息之后，實(shí)例化bean之前。
在這個(gè)時(shí)機(jī)，用戶可以通過實(shí)現(xiàn)這個(gè)擴(kuò)展接口來自行處理一些東西，比如修改已經(jīng)注冊(cè)的beanDefinition的元信息。
擴(kuò)展方式為：
public class TestBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
System.out.println("[BeanFactoryPostProcessor]");
}
}
6.InstantiationAwareBeanPostProcessor
org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
該接口繼承了BeanPostProcess接口，區(qū)別如下：
BeanPostProcess接口只在bean的初始化階段進(jìn)行擴(kuò)展（注入spring上下文前后），而InstantiationAwareBeanPostProcessor接口在此基礎(chǔ)上增加了3個(gè)方法，把可擴(kuò)展的范圍增加了實(shí)例化階段和屬性注入階段，分享一套 181G視頻的JAVA架構(gòu)師課程，累計(jì)更新時(shí)長1000+個(gè)小時(shí)
該類主要的擴(kuò)展點(diǎn)有以下5個(gè)方法，主要在bean生命周期的兩大階段：實(shí)例化階段和初始化階段，下面一起進(jìn)行說明，按調(diào)用順序?yàn)椋?/p>
-
postProcessBeforeInstantiation：實(shí)例化bean之前，相當(dāng)于new這個(gè)bean之前 -
postProcessAfterInstantiation：實(shí)例化bean之后，相當(dāng)于new這個(gè)bean之后 -
postProcessPropertyValues：bean已經(jīng)實(shí)例化完成，在屬性注入時(shí)階段觸發(fā)，@Autowired,@Resource等注解原理基于此方法實(shí)現(xiàn) -
postProcessBeforeInitialization：初始化bean之前，相當(dāng)于把bean注入spring上下文之前 -
postProcessAfterInitialization：初始化bean之后，相當(dāng)于把bean注入spring上下文之后
使用場景：這個(gè)擴(kuò)展點(diǎn)非常有用 ，無論是寫中間件和業(yè)務(wù)中，都能利用這個(gè)特性。比如對(duì)實(shí)現(xiàn)了某一類接口的bean在各個(gè)生命期間進(jìn)行收集，或者對(duì)某個(gè)類型的bean進(jìn)行統(tǒng)一的設(shè)值等等。
擴(kuò)展方式為：
public class TestInstantiationAwareBeanPostProcessor implements InstantiationAwareBeanPostProcessor {
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
System.out.println("[TestInstantiationAwareBeanPostProcessor] before initialization " + beanName);
return bean;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
System.out.println("[TestInstantiationAwareBeanPostProcessor] after initialization " + beanName);
return bean;
}
@Override
public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
System.out.println("[TestInstantiationAwareBeanPostProcessor] before instantiation " + beanName);
return null;
}
@Override
public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
System.out.println("[TestInstantiationAwareBeanPostProcessor] after instantiation " + beanName);
return true;
}
@Override
public PropertyValues postProcessPropertyValues(PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException {
System.out.println("[TestInstantiationAwareBeanPostProcessor] postProcessPropertyValues " + beanName);
return pvs;
}
7.SmartInstantiationAwareBeanPostProcessor
org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
該擴(kuò)展接口有3個(gè)觸發(fā)點(diǎn)方法：
-
predictBeanType：該觸發(fā)點(diǎn)發(fā)生在postProcessBeforeInstantiation之前(在圖上并沒有標(biāo)明，因?yàn)橐话悴惶枰獢U(kuò)展這個(gè)點(diǎn))，這個(gè)方法用于預(yù)測(cè)Bean的類型，返回第一個(gè)預(yù)測(cè)成功的Class類型，如果不能預(yù)測(cè)返回null；當(dāng)你調(diào)用BeanFactory.getType(name)時(shí)當(dāng)通過bean的名字無法得到bean類型信息時(shí)就調(diào)用該回調(diào)方法來決定類型信息。 -
determineCandidateConstructors：該觸發(fā)點(diǎn)發(fā)生在postProcessBeforeInstantiation之后，用于確定該bean的構(gòu)造函數(shù)之用，返回的是該bean的所有構(gòu)造函數(shù)列表。用戶可以擴(kuò)展這個(gè)點(diǎn)，來自定義選擇相應(yīng)的構(gòu)造器來實(shí)例化這個(gè)bean。 -
getEarlyBeanReference：該觸發(fā)點(diǎn)發(fā)生在postProcessAfterInstantiation之后，當(dāng)有循環(huán)依賴的場景，當(dāng)bean實(shí)例化好之后，為了防止有循環(huán)依賴，會(huì)提前暴露回調(diào)方法，用于bean實(shí)例化的后置處理。這個(gè)方法就是在提前暴露的回調(diào)方法中觸發(fā)。
擴(kuò)展方式為：
public class TestSmartInstantiationAwareBeanPostProcessor implements SmartInstantiationAwareBeanPostProcessor {
@Override
public Class<?> predictBeanType(Class<?> beanClass, String beanName) throws BeansException {
System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] predictBeanType " + beanName);
return beanClass;
}
@Override
public Constructor<?>[] determineCandidateConstructors(Class<?> beanClass, String beanName) throws BeansException {
System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] determineCandidateConstructors " + beanName);
return null;
}
@Override
public Object getEarlyBeanReference(Object bean, String beanName) throws BeansException {
System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] getEarlyBeanReference " + beanName);
return bean;
}
}
8.BeanFactoryAware
org.springframework.beans.factory.BeanFactoryAware
這個(gè)類只有一個(gè)觸發(fā)點(diǎn)，發(fā)生在bean的實(shí)例化之后，注入屬性之前，也就是Setter之前。這個(gè)類的擴(kuò)展點(diǎn)方法為setBeanFactory，可以拿到BeanFactory這個(gè)屬性。
使用場景為，你可以在bean實(shí)例化之后，但還未初始化之前，拿到 BeanFactory，在這個(gè)時(shí)候，可以對(duì)每個(gè)bean作特殊化的定制。也或者可以把BeanFactory拿到進(jìn)行緩存，日后使用。
擴(kuò)展方式為：
public class TestBeanFactoryAware implements BeanFactoryAware {
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
System.out.println("[TestBeanFactoryAware] " + beanFactory.getBean(TestBeanFactoryAware.class).getClass().getSimpleName());
}
}
9.ApplicationContextAwareProcessor
org.springframework.context.support.ApplicationContextAwareProcessor
該類本身并沒有擴(kuò)展點(diǎn)，但是該類內(nèi)部卻有6個(gè)擴(kuò)展點(diǎn)可供實(shí)現(xiàn) ，這些類觸發(fā)的時(shí)機(jī)在bean實(shí)例化之后，初始化之前
可以看到，該類用于執(zhí)行各種驅(qū)動(dòng)接口，在bean實(shí)例化之后，屬性填充之后，通過執(zhí)行以上紅框標(biāo)出的擴(kuò)展接口，來獲取對(duì)應(yīng)容器的變量。所以這里應(yīng)該來說是有6個(gè)擴(kuò)展點(diǎn)，這里就放一起來說了，分享一套 181G視頻的Java架構(gòu)師課程，累計(jì)更新時(shí)長1000+個(gè)小時(shí)
-
EnvironmentAware：用于獲取EnviromentAware的一個(gè)擴(kuò)展類，這個(gè)變量非常有用， 可以獲得系統(tǒng)內(nèi)的所有參數(shù)。當(dāng)然個(gè)人認(rèn)為這個(gè)Aware沒必要去擴(kuò)展，因?yàn)閟pring內(nèi)部都可以通過注入的方式來直接獲得。 -
EmbeddedValueResolverAware：用于獲取StringValueResolver的一個(gè)擴(kuò)展類， StringValueResolver用于獲取基于String類型的properties的變量，一般我們都用@Value的方式去獲取，如果實(shí)現(xiàn)了這個(gè)Aware接口，把StringValueResolver緩存起來，通過這個(gè)類去獲取String類型的變量，效果是一樣的。 -
ResourceLoaderAware：用于獲取ResourceLoader的一個(gè)擴(kuò)展類，ResourceLoader可以用于獲取classpath內(nèi)所有的資源對(duì)象，可以擴(kuò)展此類來拿到ResourceLoader對(duì)象。 -
ApplicationEventPublisherAware：用于獲取ApplicationEventPublisher的一個(gè)擴(kuò)展類，ApplicationEventPublisher可以用來發(fā)布事件，結(jié)合ApplicationListener來共同使用，下文在介紹ApplicationListener時(shí)會(huì)詳細(xì)提到。這個(gè)對(duì)象也可以通過spring注入的方式來獲得。 -
MessageSourceAware：用于獲取MessageSource的一個(gè)擴(kuò)展類，MessageSource主要用來做國際化。 -
ApplicationContextAware：用來獲取ApplicationContext的一個(gè)擴(kuò)展類，ApplicationContext應(yīng)該是很多人非常熟悉的一個(gè)類了，就是spring上下文管理器，可以手動(dòng)的獲取任何在spring上下文注冊(cè)的bean，我們經(jīng)常擴(kuò)展這個(gè)接口來緩存spring上下文，包裝成靜態(tài)方法。同時(shí)ApplicationContext也實(shí)現(xiàn)了BeanFactory，MessageSource，ApplicationEventPublisher等接口，也可以用來做相關(guān)接口的事情。
10.BeanNameAware
org.springframework.beans.factory.BeanNameAware
可以看到，這個(gè)類也是Aware擴(kuò)展的一種，觸發(fā)點(diǎn)在bean的初始化之前，也就是postProcessBeforeInitialization之前，這個(gè)類的觸發(fā)點(diǎn)方法只有一個(gè)：setBeanName
使用場景為：用戶可以擴(kuò)展這個(gè)點(diǎn)，在初始化bean之前拿到spring容器中注冊(cè)的的beanName，來自行修改這個(gè)beanName的值。
擴(kuò)展方式為：
public class NormalBeanA implements BeanNameAware{
public NormalBeanA() {
System.out.println("NormalBean constructor");
}
@Override
public void setBeanName(String name) {
System.out.println("[BeanNameAware] " + name);
}
}
11.@PostConstruct
javax.annotation.PostConstruct
這個(gè)并不算一個(gè)擴(kuò)展點(diǎn)，其實(shí)就是一個(gè)標(biāo)注。其作用是在bean的初始化階段，如果對(duì)一個(gè)方法標(biāo)注了@PostConstruct，會(huì)先調(diào)用這個(gè)方法。這里重點(diǎn)是要關(guān)注下這個(gè)標(biāo)準(zhǔn)的觸發(fā)點(diǎn)，這個(gè)觸發(fā)點(diǎn)是在postProcessBeforeInitialization之后，InitializingBean.afterPropertiesSet之前。
使用場景：用戶可以對(duì)某一方法進(jìn)行標(biāo)注，來進(jìn)行初始化某一個(gè)屬性
擴(kuò)展方式為：
public class NormalBeanA {
public NormalBeanA() {
System.out.println("NormalBean constructor");
}
@PostConstruct
public void init(){
System.out.println("[PostConstruct] NormalBeanA");
}
}
12.InitializingBean
org.springframework.beans.factory.InitializingBean
這個(gè)類，顧名思義，也是用來初始化bean的。InitializingBean接口為bean提供了初始化方法的方式，它只包括afterPropertiesSet方法，凡是繼承該接口的類，在初始化bean的時(shí)候都會(huì)執(zhí)行該方法。這個(gè)擴(kuò)展點(diǎn)的觸發(fā)時(shí)機(jī)在postProcessAfterInitialization之前。
使用場景：用戶實(shí)現(xiàn)此接口，來進(jìn)行系統(tǒng)啟動(dòng)的時(shí)候一些業(yè)務(wù)指標(biāo)的初始化工作。
擴(kuò)展方式為：
public class NormalBeanA implements InitializingBean{
@Override
public void afterPropertiesSet() throws Exception {
System.out.println("[InitializingBean] NormalBeanA");
}
}
13.FactoryBean
org.springframework.beans.factory.FactoryBean
一般情況下，Spring通過反射機(jī)制利用bean的class屬性指定支線類去實(shí)例化bean，在某些情況下，實(shí)例化Bean過程比較復(fù)雜，如果按照傳統(tǒng)的方式，則需要在bean中提供大量的配置信息。配置方式的靈活性是受限的，這時(shí)采用編碼的方式可能會(huì)得到一個(gè)簡單的方案。Spring為此提供了一個(gè)org.springframework.bean.factory.FactoryBean的工廠類接口，用戶可以通過實(shí)現(xiàn)該接口定制實(shí)例化Bean的邏輯。
FactoryBean接口對(duì)于Spring框架來說占用重要的地位，Spring自身就提供了70多個(gè)FactoryBean的實(shí)現(xiàn)。它們隱藏了實(shí)例化一些復(fù)雜bean的細(xì)節(jié)，給上層應(yīng)用帶來了便利。從Spring3.0開始，FactoryBean開始支持泛型，即接口聲明改為FactoryBean<T>的形式
使用場景：用戶可以擴(kuò)展這個(gè)類，來為要實(shí)例化的bean作一個(gè)代理，比如為該對(duì)象的所有的方法作一個(gè)攔截，在調(diào)用前后輸出一行l(wèi)og，模仿ProxyFactoryBean的功能。
擴(kuò)展方式為：
public class TestFactoryBean implements FactoryBean<TestFactoryBean.TestFactoryInnerBean> {
@Override
public TestFactoryBean.TestFactoryInnerBean getObject() throws Exception {
System.out.println("[FactoryBean] getObject");
return new TestFactoryBean.TestFactoryInnerBean();
}
@Override
public Class<?> getObjectType() {
return TestFactoryBean.TestFactoryInnerBean.class;
}
@Override
public boolean isSingleton() {
return true;
}
public static class TestFactoryInnerBean{
}
}
14.SmartInitializingSingleton
org.springframework.beans.factory.SmartInitializingSingleton
這個(gè)接口中只有一個(gè)方法afterSingletonsInstantiated，其作用是是 在spring容器管理的所有單例對(duì)象（非懶加載對(duì)象）初始化完成之后調(diào)用的回調(diào)接口。其觸發(fā)時(shí)機(jī)為postProcessAfterInitialization之后，分享一套 181G視頻的Java架構(gòu)師課程，累計(jì)更新時(shí)長1000+個(gè)小時(shí)
使用場景：用戶可以擴(kuò)展此接口在對(duì)所有單例對(duì)象初始化完畢后，做一些后置的業(yè)務(wù)處理。
擴(kuò)展方式為：
public class TestSmartInitializingSingleton implements SmartInitializingSingleton {
@Override
public void afterSingletonsInstantiated() {
System.out.println("[TestSmartInitializingSingleton]");
}
}
15.CommandLineRunner
org.springframework.boot.CommandLineRunner
這個(gè)接口也只有一個(gè)方法：run(String... args)，觸發(fā)時(shí)機(jī)為整個(gè)項(xiàng)目啟動(dòng)完畢后，自動(dòng)執(zhí)行。如果有多個(gè)CommandLineRunner，可以利用@Order來進(jìn)行排序。
使用場景：用戶擴(kuò)展此接口，進(jìn)行啟動(dòng)項(xiàng)目之后一些業(yè)務(wù)的預(yù)處理。
擴(kuò)展方式為：
public class TestCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("[TestCommandLineRunner]");
}
}
16.DisposableBean
org.springframework.beans.factory.DisposableBean
這個(gè)擴(kuò)展點(diǎn)也只有一個(gè)方法：destroy()，其觸發(fā)時(shí)機(jī)為當(dāng)此對(duì)象銷毀時(shí)，會(huì)自動(dòng)執(zhí)行這個(gè)方法。比如說運(yùn)行applicationContext.registerShutdownHook時(shí)，就會(huì)觸發(fā)這個(gè)方法。
擴(kuò)展方式為：
public class NormalBeanA implements DisposableBean {
@Override
public void destroy() throws Exception {
System.out.println("[DisposableBean] NormalBeanA");
}
}
17.ApplicationListener
org.springframework.context.ApplicationListener
準(zhǔn)確的說，這個(gè)應(yīng)該不算spring&springboot當(dāng)中的一個(gè)擴(kuò)展點(diǎn)，ApplicationListener可以監(jiān)聽某個(gè)事件的event，觸發(fā)時(shí)機(jī)可以穿插在業(yè)務(wù)方法執(zhí)行過程中，用戶可以自定義某個(gè)業(yè)務(wù)事件。
但是spring內(nèi)部也有一些內(nèi)置事件，這種事件，可以穿插在啟動(dòng)調(diào)用中。我們也可以利用這個(gè)特性，來自己做一些內(nèi)置事件的監(jiān)聽器來達(dá)到和前面一些觸發(fā)點(diǎn)大致相同的事情
接下來羅列下spring主要的內(nèi)置事件：
ApplicationContext 被初始化或刷新時(shí)，該事件被發(fā)布。這也可以在ConfigurableApplicationContext接口中使用 refresh()方法來發(fā)生。此處的初始化是指：所有的Bean被成功裝載，后處理Bean被檢測(cè)并激活，所有Singleton Bean 被預(yù)實(shí)例化，ApplicationContext容器已就緒可用。
當(dāng)使用 ConfigurableApplicationContext （ApplicationContext子接口）接口中的 start() 方法啟動(dòng) ApplicationContext時(shí)，該事件被發(fā)布。你可以調(diào)查你的數(shù)據(jù)庫，或者你可以在接受到這個(gè)事件后重啟任何停止的應(yīng)用程序。
當(dāng)使用 ConfigurableApplicationContext接口中的 stop()停止ApplicationContext 時(shí)，發(fā)布這個(gè)事件。你可以在接受到這個(gè)事件后做必要的清理的工作
當(dāng)使用 ConfigurableApplicationContext接口中的 close()方法關(guān)閉 ApplicationContext 時(shí)，該事件被發(fā)布。一個(gè)已關(guān)閉的上下文到達(dá)生命周期末端；它不能被刷新或重啟
這是一個(gè) web-specific 事件，告訴所有 bean HTTP 請(qǐng)求已經(jīng)被服務(wù)。只能應(yīng)用于使用DispatcherServlet的Web應(yīng)用。在使用Spring作為前端的MVC控制器時(shí)，當(dāng)Spring處理用戶請(qǐng)求結(jié)束后，系統(tǒng)會(huì)自動(dòng)觸發(fā)該事件
18.最后
我們從這些spring&springboot的擴(kuò)展點(diǎn)當(dāng)中，大致可以窺視到整個(gè)bean的生命周期。在業(yè)務(wù)開發(fā)或者寫中間件業(yè)務(wù)的時(shí)候，可以合理利用spring提供給我們的擴(kuò)展點(diǎn)，在spring啟動(dòng)的各個(gè)階段內(nèi)做一些事情。以達(dá)到自定義初始化的目的。此篇總結(jié)，如果有錯(cuò)誤或者疏漏的地方，懇請(qǐng)指正。
