Spring Boot 啟動擴展點超詳細總結

Spring的核心思想就是容器,當容器refresh的時候,外部看上去風平浪靜,其實內部則是一片驚濤駭浪,汪洋一片。Springboot更是封裝了Spring,遵循約定大于配置,加上自動裝配的機制。很多時候我們只要引用了一個依賴,幾乎是零配置就能完成一個功能的裝配。

我非常喜歡這種自動裝配的機制,所以在自己開發(fā)中間件和公共依賴工具的時候也會用到這個特性。讓使用者以最小的代價接入。想要把自動裝配玩的轉,就必須要了解spring對于bean的構造生命周期以及各個擴展接口。當然了解了bean的各個生命周期也能促進我們加深對spring的理解。業(yè)務代碼也能合理利用這些擴展點寫出更加漂亮的代碼。

在網(wǎng)上搜索spring擴展點,發(fā)現(xiàn)很少有博文說的很全的,只有一些常用的擴展點的說明。

所以在這篇文章里,我總結了幾乎Spring & Springboot所有的擴展接口,以及各個擴展點的使用場景。并且整理出了一個bean在spring內部從被加載到最后初始化完成所有可擴展點的順序調用圖。從而我們也能窺探到bean是如何一步步加載到spring容器中的。

2.可擴展的接口啟動調用順序圖

以下是我整理的spring容器中Bean的生命周期內所有可擴展的點的調用順序,下面會一個個分析

1.jpg

3.ApplicationContextInitializer

org.springframework.context.ApplicationContextInitializer

這是整個spring容器在刷新之前初始化ConfigurableApplicationContext的回調接口,簡單來說,就是在容器刷新之前調用此類的initialize方法。這個點允許被用戶自己擴展。用戶可以在整個spring容器還沒被初始化之前做一些事情。

可以想到的場景可能為,在最開始激活一些配置,或者利用這時候class還沒被類加載器加載的時機,進行動態(tài)字節(jié)碼注入等操作。

擴展方式為:

publicclassTestApplicationContextInitializerimplementsApplicationContextInitializer{

@Override

publicvoidinitialize(ConfigurableApplicationContext?applicationContext){

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

}

}

因為這時候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之后執(zhí)行,提供一個補充的擴展點

使用場景:你可以在這里動態(tài)注冊自己的beanDefinition,可以加載classpath之外的bean

擴展方式為:

publicclassTestBeanDefinitionRegistryPostProcessorimplementsBeanDefinitionRegistryPostProcessor{

@Override

publicvoidpostProcessBeanDefinitionRegistry(BeanDefinitionRegistry?registry)throwsBeansException{

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

}

@Override

publicvoidpostProcessBeanFactory(ConfigurableListableBeanFactory?beanFactory)throwsBeansException{

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

}

}

5.BeanFactoryPostProcessor

org.springframework.beans.factory.config.BeanFactoryPostProcessor

這個接口是beanFactory的擴展接口,調用時機在spring在讀取beanDefinition信息之后,實例化bean之前。

在這個時機,用戶可以通過實現(xiàn)這個擴展接口來自行處理一些東西,比如修改已經(jīng)注冊的beanDefinition的元信息。

擴展方式為:

publicclassTestBeanFactoryPostProcessorimplementsBeanFactoryPostProcessor{

@Override

publicvoidpostProcessBeanFactory(ConfigurableListableBeanFactory?beanFactory)throwsBeansException{

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

}

}

6.InstantiationAwareBeanPostProcessor

org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor

該接口繼承了BeanPostProcess接口,區(qū)別如下:

BeanPostProcess接口只在bean的初始化階段進行擴展(注入spring上下文前后),而InstantiationAwareBeanPostProcessor接口在此基礎上增加了3個方法,把可擴展的范圍增加了實例化階段和屬性注入階段。

該類主要的擴展點有以下5個方法,主要在bean生命周期的兩大階段:實例化階段?和初始化階段?,下面一起進行說明,按調用順序為:

postProcessBeforeInstantiation:實例化bean之前,相當于new這個bean之前

postProcessAfterInstantiation:實例化bean之后,相當于new這個bean之后

postProcessPropertyValues:bean已經(jīng)實例化完成,在屬性注入時階段觸發(fā),@Autowired,@Resource等注解原理基于此方法實現(xiàn)

postProcessBeforeInitialization:初始化bean之前,相當于把bean注入spring上下文之前

postProcessAfterInitialization:初始化bean之后,相當于把bean注入spring上下文之后

使用場景:這個擴展點非常有用 ,無論是寫中間件和業(yè)務中,都能利用這個特性。比如對實現(xiàn)了某一類接口的bean在各個生命期間進行收集,或者對某個類型的bean進行統(tǒng)一的設值等等。

擴展方式為:

publicclassTestInstantiationAwareBeanPostProcessorimplementsInstantiationAwareBeanPostProcessor{

@Override

publicObjectpostProcessBeforeInitialization(Object?bean,?String?beanName)throwsBeansException{

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

returnbean;

}

@Override

publicObjectpostProcessAfterInitialization(Object?bean,?String?beanName)throwsBeansException{

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

returnbean;

}

@Override

publicObjectpostProcessBeforeInstantiation(Class<?>?beanClass,?String?beanName)throwsBeansException{

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

returnnull;

}

@Override

publicbooleanpostProcessAfterInstantiation(Object?bean,?String?beanName)throwsBeansException{

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

returntrue;

}

@Override

publicPropertyValuespostProcessPropertyValues(PropertyValues?pvs,?PropertyDescriptor[]?pds,?Object?bean,?String?beanName)throwsBeansException{

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

returnpvs;

}

7.SmartInstantiationAwareBeanPostProcessor

org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor

該擴展接口有3個觸發(fā)點方法:

predictBeanType:該觸發(fā)點發(fā)生在postProcessBeforeInstantiation之前(在圖上并沒有標明,因為一般不太需要擴展這個點),這個方法用于預測Bean的類型,返回第一個預測成功的Class類型,如果不能預測返回null;當你調用BeanFactory.getType(name)時當通過bean的名字無法得到bean類型信息時就調用該回調方法來決定類型信息。

determineCandidateConstructors:該觸發(fā)點發(fā)生在postProcessBeforeInstantiation之后,用于確定該bean的構造函數(shù)之用,返回的是該bean的所有構造函數(shù)列表。用戶可以擴展這個點,來自定義選擇相應的構造器來實例化這個bean。

getEarlyBeanReference:該觸發(fā)點發(fā)生在postProcessAfterInstantiation之后,當有循環(huán)依賴的場景,當bean實例化好之后,為了防止有循環(huán)依賴,會提前暴露回調方法,用于bean實例化的后置處理。這個方法就是在提前暴露的回調方法中觸發(fā)。

擴展方式為:

publicclassTestSmartInstantiationAwareBeanPostProcessorimplementsSmartInstantiationAwareBeanPostProcessor{

@Override

publicClass?predictBeanType(Class?beanClass,?String?beanName)throwsBeansException?{

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

returnbeanClass;

}

@Override

publicConstructor[]?determineCandidateConstructors(Class?beanClass,?String?beanName)throwsBeansException?{

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

returnnull;

}

@Override

publicObjectgetEarlyBeanReference(Object?bean,?String?beanName)throwsBeansException{

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

returnbean;

}

}

8.BeanFactoryAware

org.springframework.beans.factory.BeanFactoryAware

這個類只有一個觸發(fā)點,發(fā)生在bean的實例化之后,注入屬性之前,也就是Setter之前。這個類的擴展點方法為setBeanFactory,可以拿到BeanFactory這個屬性。

使用場景為,你可以在bean實例化之后,但還未初始化之前,拿到?BeanFactory,在這個時候,可以對每個bean作特殊化的定制。也或者可以把BeanFactory拿到進行緩存,日后使用。

擴展方式為:

publicclassTestBeanFactoryAwareimplementsBeanFactoryAware{

@Override

publicvoidsetBeanFactory(BeanFactory?beanFactory)throwsBeansException{

System.out.println("[TestBeanFactoryAware]?"+?beanFactory.getBean(TestBeanFactoryAware.class).getClass().getSimpleName());

}

}

9.ApplicationContextAwareProcessor

org.springframework.context.support.ApplicationContextAwareProcessor

該類本身并沒有擴展點,但是該類內部卻有6個擴展點可供實現(xiàn) ,這些類觸發(fā)的時機在bean實例化之后,初始化之前

2.png

可以看到,該類用于執(zhí)行各種驅動接口,在bean實例化之后,屬性填充之后,通過執(zhí)行以上紅框標出的擴展接口,來獲取對應容器的變量。所以這里應該來說是有6個擴展點?,這里就放一起來說了

EnvironmentAware:用于獲取EnviromentAware的一個擴展類,這個變量非常有用, 可以獲得系統(tǒng)內的所有參數(shù)。當然個人認為這個Aware沒必要去擴展,因為spring內部都可以通過注入的方式來直接獲得。

EmbeddedValueResolverAware:用于獲取StringValueResolver的一個擴展類,?StringValueResolver用于獲取基于String類型的properties的變量,一般我們都用@Value的方式去獲取,如果實現(xiàn)了這個Aware接口,把StringValueResolver緩存起來,通過這個類去獲取String類型的變量,效果是一樣的。

ResourceLoaderAware:用于獲取ResourceLoader的一個擴展類,ResourceLoader可以用于獲取classpath內所有的資源對象,可以擴展此類來拿到ResourceLoader對象。

ApplicationEventPublisherAware:用于獲取ApplicationEventPublisher的一個擴展類,ApplicationEventPublisher可以用來發(fā)布事件,結合ApplicationListener來共同使用,下文在介紹ApplicationListener時會詳細提到。這個對象也可以通過spring注入的方式來獲得。

MessageSourceAware:用于獲取MessageSource的一個擴展類,MessageSource主要用來做國際化。

ApplicationContextAware:用來獲取ApplicationContext的一個擴展類,ApplicationContext應該是很多人非常熟悉的一個類了,就是spring上下文管理器,可以手動的獲取任何在spring上下文注冊的bean,我們經(jīng)常擴展這個接口來緩存spring上下文,包裝成靜態(tài)方法。同時ApplicationContext也實現(xiàn)了BeanFactory,MessageSource,ApplicationEventPublisher等接口,也可以用來做相關接口的事情。

10.BeanNameAware

org.springframework.beans.factory.BeanNameAware

可以看到,這個類也是Aware擴展的一種,觸發(fā)點在bean的初始化之前,也就是postProcessBeforeInitialization之前,這個類的觸發(fā)點方法只有一個:setBeanName

使用場景為:用戶可以擴展這個點,在初始化bean之前拿到spring容器中注冊的的beanName,來自行修改這個beanName的值。

擴展方式為:

publicclassNormalBeanAimplementsBeanNameAware{

publicNormalBeanA(){

System.out.println("NormalBean?constructor");

}

@Override

publicvoidsetBeanName(String?name){

System.out.println("[BeanNameAware]?"+?name);

}

}

11.@PostConstruct

javax.annotation.PostConstruct

這個并不算一個擴展點,其實就是一個標注。其作用是在bean的初始化階段,如果對一個方法標注了@PostConstruct,會先調用這個方法。這里重點是要關注下這個標準的觸發(fā)點,這個觸發(fā)點是在postProcessBeforeInitialization之后,InitializingBean.afterPropertiesSet之前。

使用場景:用戶可以對某一方法進行標注,來進行初始化某一個屬性

擴展方式為:

publicclassNormalBeanA{

publicNormalBeanA(){

System.out.println("NormalBean?constructor");

}

@PostConstruct

publicvoidinit(){

System.out.println("[PostConstruct]?NormalBeanA");

}

}

12.InitializingBean

org.springframework.beans.factory.InitializingBean

這個類,顧名思義,也是用來初始化bean的。InitializingBean接口為bean提供了初始化方法的方式,它只包括afterPropertiesSet方法,凡是繼承該接口的類,在初始化bean的時候都會執(zhí)行該方法。這個擴展點的觸發(fā)時機在postProcessAfterInitialization之前。

使用場景:用戶實現(xiàn)此接口,來進行系統(tǒng)啟動的時候一些業(yè)務指標的初始化工作。

擴展方式為:

publicclassNormalBeanAimplementsInitializingBean{

@Override

publicvoidafterPropertiesSet()throwsException{

System.out.println("[InitializingBean]?NormalBeanA");

}

}

13.FactoryBean

org.springframework.beans.factory.FactoryBean

一般情況下,Spring通過反射機制利用bean的class屬性指定支線類去實例化bean,在某些情況下,實例化Bean過程比較復雜,如果按照傳統(tǒng)的方式,則需要在bean中提供大量的配置信息。配置方式的靈活性是受限的,這時采用編碼的方式可能會得到一個簡單的方案。Spring為此提供了一個org.springframework.bean.factory.FactoryBean的工廠類接口,用戶可以通過實現(xiàn)該接口定制實例化Bean的邏輯。FactoryBean接口對于Spring框架來說占用重要的地位,Spring自身就提供了70多個FactoryBean的實現(xiàn)。它們隱藏了實例化一些復雜bean的細節(jié),給上層應用帶來了便利。從Spring3.0開始,F(xiàn)actoryBean開始支持泛型,即接口聲明改為FactoryBean<T>的形式

使用場景:用戶可以擴展這個類,來為要實例化的bean作一個代理,比如為該對象的所有的方法作一個攔截,在調用前后輸出一行l(wèi)og,模仿ProxyFactoryBean的功能。

擴展方式為:

publicclassTestFactoryBeanimplementsFactoryBean{

@Override

publicTestFactoryBean.TestFactoryInnerBeangetObject()throwsException{

System.out.println("[FactoryBean]?getObject");

returnnewTestFactoryBean.TestFactoryInnerBean();

}

@Override

publicClass?getObjectType()?{

returnTestFactoryBean.TestFactoryInnerBean.class;

}

@Override

publicbooleanisSingleton(){

returntrue;

}

publicstaticclassTestFactoryInnerBean{

}

}

14.SmartInitializingSingleton

org.springframework.beans.factory.SmartInitializingSingleton

這個接口中只有一個方法afterSingletonsInstantiated,其作用是是 在spring容器管理的所有單例對象(非懶加載對象)初始化完成之后調用的回調接口。其觸發(fā)時機為postProcessAfterInitialization之后。

使用場景:用戶可以擴展此接口在對所有單例對象初始化完畢后,做一些后置的業(yè)務處理。

擴展方式為:

publicclassTestSmartInitializingSingletonimplementsSmartInitializingSingleton{

@Override

publicvoidafterSingletonsInstantiated(){

System.out.println("[TestSmartInitializingSingleton]");

}

}

15.CommandLineRunner

org.springframework.boot.CommandLineRunner

這個接口也只有一個方法:run(String... args),觸發(fā)時機為整個項目啟動完畢后,自動執(zhí)行。如果有多個CommandLineRunner,可以利用@Order來進行排序。

使用場景:用戶擴展此接口,進行啟動項目之后一些業(yè)務的預處理。

擴展方式為:

publicclassTestCommandLineRunnerimplementsCommandLineRunner{

@Override

publicvoidrun(String...?args)throwsException{

System.out.println("[TestCommandLineRunner]");

}

}

16.DisposableBean

org.springframework.beans.factory.DisposableBean

這個擴展點也只有一個方法:destroy(),其觸發(fā)時機為當此對象銷毀時,會自動執(zhí)行這個方法。比如說運行applicationContext.registerShutdownHook時,就會觸發(fā)這個方法。

擴展方式為:

publicclassNormalBeanAimplementsDisposableBean{

@Override

publicvoiddestroy()throwsException{

System.out.println("[DisposableBean]?NormalBeanA");

}

}

17.ApplicationListener

org.springframework.context.ApplicationListener

準確的說,這個應該不算spring&springboot當中的一個擴展點,ApplicationListener可以監(jiān)聽某個事件的event,觸發(fā)時機可以穿插在業(yè)務方法執(zhí)行過程中,用戶可以自定義某個業(yè)務事件。但是spring內部也有一些內置事件,這種事件,可以穿插在啟動調用中。我們也可以利用這個特性,來自己做一些內置事件的監(jiān)聽器來達到和前面一些觸發(fā)點大致相同的事情。

接下來羅列下spring主要的內置事件:

ContextRefreshedEvent

ApplicationContext 被初始化或刷新時,該事件被發(fā)布。這也可以在ConfigurableApplicationContext接口中使用?refresh()方法來發(fā)生。此處的初始化是指:所有的Bean被成功裝載,后處理Bean被檢測并激活,所有Singleton Bean 被預實例化,ApplicationContext容器已就緒可用。

ContextStartedEvent

當使用?ConfigurableApplicationContext?(ApplicationContext子接口)接口中的 start() 方法啟動?ApplicationContext時,該事件被發(fā)布。你可以調查你的數(shù)據(jù)庫,或者你可以在接受到這個事件后重啟任何停止的應用程序。

ContextStoppedEvent

當使用?ConfigurableApplicationContext接口中的?stop()停止ApplicationContext時,發(fā)布這個事件。你可以在接受到這個事件后做必要的清理的工作

ContextClosedEvent

當使用?ConfigurableApplicationContext接口中的?close()方法關閉?ApplicationContext?時,該事件被發(fā)布。一個已關閉的上下文到達生命周期末端;它不能被刷新或重啟

RequestHandledEvent

這是一個 web-specific 事件,告訴所有 bean HTTP 請求已經(jīng)被服務。只能應用于使用DispatcherServlet的Web應用。在使用Spring作為前端的MVC控制器時,當Spring處理用戶請求結束后,系統(tǒng)會自動觸發(fā)該事件

18.最后

我們從這些spring&springboot的擴展點當中,大致可以窺視到整個bean的生命周期。在業(yè)務開發(fā)或者寫中間件業(yè)務的時候,可以合理利用spring提供給我們的擴展點,在spring啟動的各個階段內做一些事情。以達到自定義初始化的目的。此篇總結,如果有錯誤或者疏漏的地方,懇請指正。

下一篇,應某位小伙伴要求,準備總結下在springboot啟動過程中,我們如何控制bean的加載順序的各種辦法,讓bean的加載順序完全受你掌控。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容