轉(zhuǎn)載地址:https://blog.csdn.net/u013256816/article/details/109006588
1. 背景
Spring的核心思想就是容器霎迫,當(dāng)容器refresh的時候,外部看上去風(fēng)平浪靜帘靡,其實內(nèi)部則是一片驚濤駭浪知给,汪洋一片。Springboot更是封裝了Spring,遵循約定大于配置涩赢,加上自動裝配的機制戈次。很多時候我們只要引用了一個依賴,幾乎是零配置就能完成一個功能的裝配筒扒。
我非常喜歡這種自動裝配的機制怯邪,所以在自己開發(fā)中間件和公共依賴工具的時候也會用到這個特性。讓使用者以最小的代價接入花墩。想要把自動裝配玩的轉(zhuǎn)悬秉,就必須要了解spring對于bean的構(gòu)造生命周期以及各個擴展接口。當(dāng)然了解了bean的各個生命周期也能促進我們加深對spring的理解冰蘑。業(yè)務(wù)代碼也能合理利用這些擴展點寫出更加漂亮的代碼和泌。
在網(wǎng)上搜索spring擴展點,發(fā)現(xiàn)很少有博文說的很全的祠肥,只有一些常用的擴展點的說明武氓。
所以在這篇文章里,我總結(jié)了幾乎Spring & Springboot所有的擴展接口搪柑,以及各個擴展點的使用場景聋丝。并且整理出了一個bean在spring內(nèi)部從被加載到最后初始化完成所有可擴展點的順序調(diào)用圖索烹。從而我們也能窺探到bean是如何一步步加載到spring容器中的工碾。
2.可擴展的接口啟動調(diào)用順序圖
以下是我整理的spring容器中Bean的生命周期內(nèi)所有可擴展的點的調(diào)用順序,下面會一個個分析
3.ApplicationContextInitializer
org.springframework.context.ApplicationContextInitializer
這是整個spring容器在刷新之前初始化ConfigurableApplicationContext的回調(diào)接口百姓,簡單來說渊额,就是在容器刷新之前調(diào)用此類的initialize方法。這個點允許被用戶自己擴展垒拢。用戶可以在整個spring容器還沒被初始化之前做一些事情旬迹。
可以想到的場景可能為,在最開始激活一些配置求类,或者利用這時候class還沒被類加載器加載的時機奔垦,進行動態(tài)字節(jié)碼注入等操作。
擴展方式為:
publicclassTestApplicationContextInitializerimplementsApplicationContextInitializer{@Overridepublicvoid initialize(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{@Overridepublicvoid postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)throwsBeansException{System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanDefinitionRegistry");}@Overridepublicvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)throwsBeansException{System.out.println("[BeanDefinitionRegistryPostProcessor] postProcessBeanFactory");}}
5.BeanFactoryPostProcessor
org.springframework.beans.factory.config.BeanFactoryPostProcessor
這個接口是beanFactory的擴展接口,調(diào)用時機在spring在讀取beanDefinition信息之后症革,實例化bean之前筐咧。
在這個時機,用戶可以通過實現(xiàn)這個擴展接口來自行處理一些東西,比如修改已經(jīng)注冊的beanDefinition的元信息量蕊。
擴展方式為:
publicclassTestBeanFactoryPostProcessorimplementsBeanFactoryPostProcessor{@Overridepublicvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)throwsBeansException{System.out.println("[BeanFactoryPostProcessor]");}}
6.InstantiationAwareBeanPostProcessor
org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
該接口繼承了BeanPostProcess接口铺罢,區(qū)別如下:
BeanPostProcess接口只在bean的初始化階段進行擴展(注入spring上下文前后),而InstantiationAwareBeanPostProcessor接口在此基礎(chǔ)上增加了3個方法危融,把可擴展的范圍增加了實例化階段和屬性注入階段畏铆。
該類主要的擴展點有以下5個方法,主要在bean生命周期的兩大階段:實例化階段和初始化階段吉殃,下面一起進行說明辞居,按調(diào)用順序為:
postProcessBeforeInstantiation:實例化bean之前,相當(dāng)于new這個bean之前
postProcessAfterInstantiation:實例化bean之后蛋勺,相當(dāng)于new這個bean之后
postProcessPropertyValues:bean已經(jīng)實例化完成瓦灶,在屬性注入時階段觸發(fā),@Autowired,@Resource等注解原理基于此方法實現(xiàn)
postProcessBeforeInitialization:初始化bean之前抱完,相當(dāng)于把bean注入spring上下文之前
postProcessAfterInitialization:初始化bean之后贼陶,相當(dāng)于把bean注入spring上下文之后
使用場景:這個擴展點非常有用 ,無論是寫中間件和業(yè)務(wù)中巧娱,都能利用這個特性碉怔。比如對實現(xiàn)了某一類接口的bean在各個生命期間進行收集,或者對某個類型的bean進行統(tǒng)一的設(shè)值等等禁添。
擴展方式為:
publicclassTestInstantiationAwareBeanPostProcessorimplementsInstantiationAwareBeanPostProcessor{@OverridepublicObject postProcessBeforeInitialization(Object bean,String beanName)throwsBeansException{System.out.println("[TestInstantiationAwareBeanPostProcessor] before initialization "+ beanName);return bean;}@OverridepublicObject postProcessAfterInitialization(Object bean,String beanName)throwsBeansException{System.out.println("[TestInstantiationAwareBeanPostProcessor] after initialization "+ beanName);return bean;}@OverridepublicObject postProcessBeforeInstantiation(Class<?> beanClass,String beanName)throwsBeansException{System.out.println("[TestInstantiationAwareBeanPostProcessor] before instantiation "+ beanName);returnnull;}@Overridepublicboolean postProcessAfterInstantiation(Object bean,String beanName)throwsBeansException{System.out.println("[TestInstantiationAwareBeanPostProcessor] after instantiation "+ beanName);returntrue;}@OverridepublicPropertyValues postProcessPropertyValues(PropertyValues pvs,PropertyDescriptor[] pds,Object bean,String beanName)throwsBeansException{System.out.println("[TestInstantiationAwareBeanPostProcessor] postProcessPropertyValues "+ beanName);return pvs;}
7.SmartInstantiationAwareBeanPostProcessor
org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
該擴展接口有3個觸發(fā)點方法:
predictBeanType:該觸發(fā)點發(fā)生在postProcessBeforeInstantiation之前(在圖上并沒有標明撮胧,因為一般不太需要擴展這個點),這個方法用于預(yù)測Bean的類型老翘,返回第一個預(yù)測成功的Class類型芹啥,如果不能預(yù)測返回null;當(dāng)你調(diào)用BeanFactory.getType(name)時當(dāng)通過bean的名字無法得到bean類型信息時就調(diào)用該回調(diào)方法來決定類型信息铺峭。
determineCandidateConstructors:該觸發(fā)點發(fā)生在postProcessBeforeInstantiation之后墓怀,用于確定該bean的構(gòu)造函數(shù)之用,返回的是該bean的所有構(gòu)造函數(shù)列表卫键。用戶可以擴展這個點傀履,來自定義選擇相應(yīng)的構(gòu)造器來實例化這個bean。
getEarlyBeanReference:該觸發(fā)點發(fā)生在postProcessAfterInstantiation之后莉炉,當(dāng)有循環(huán)依賴的場景钓账,當(dāng)bean實例化好之后,為了防止有循環(huán)依賴呢袱,會提前暴露回調(diào)方法官扣,用于bean實例化的后置處理。這個方法就是在提前暴露的回調(diào)方法中觸發(fā)羞福。
擴展方式為:
publicclassTestSmartInstantiationAwareBeanPostProcessorimplementsSmartInstantiationAwareBeanPostProcessor{@OverridepublicClass<?> predictBeanType(Class<?> beanClass,String beanName)throwsBeansException{System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] predictBeanType "+ beanName);return beanClass;}@OverridepublicConstructor<?>[] determineCandidateConstructors(Class<?> beanClass,String beanName)throwsBeansException{System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] determineCandidateConstructors "+ beanName);returnnull;}@OverridepublicObject getEarlyBeanReference(Object bean,String beanName)throwsBeansException{System.out.println("[TestSmartInstantiationAwareBeanPostProcessor] getEarlyBeanReference "+ beanName);return bean;}}
8.BeanFactoryAware
org.springframework.beans.factory.BeanFactoryAware
這個類只有一個觸發(fā)點惕蹄,發(fā)生在bean的實例化之后,注入屬性之前,也就是Setter之前卖陵。這個類的擴展點方法為setBeanFactory遭顶,可以拿到BeanFactory這個屬性。
使用場景為泪蔫,你可以在bean實例化之后棒旗,但還未初始化之前,拿到 BeanFactory撩荣,在這個時候铣揉,可以對每個bean作特殊化的定制。也或者可以把BeanFactory拿到進行緩存餐曹,日后使用逛拱。
擴展方式為:
publicclassTestBeanFactoryAwareimplementsBeanFactoryAware{@Overridepublicvoid setBeanFactory(BeanFactory beanFactory)throwsBeansException{System.out.println("[TestBeanFactoryAware] "+ beanFactory.getBean(TestBeanFactoryAware.class).getClass().getSimpleName());}}
9.ApplicationContextAwareProcessor
org.springframework.context.support.ApplicationContextAwareProcessor
該類本身并沒有擴展點,但是該類內(nèi)部卻有6個擴展點可供實現(xiàn) 台猴,這些類觸發(fā)的時機在bean實例化之后朽合,初始化之前
可以看到,該類用于執(zhí)行各種驅(qū)動接口饱狂,在bean實例化之后曹步,屬性填充之后,通過執(zhí)行以上紅框標出的擴展接口休讳,來獲取對應(yīng)容器的變量讲婚。所以這里應(yīng)該來說是有6個擴展點,這里就放一起來說了
EnvironmentAware:用于獲取EnviromentAware的一個擴展類衍腥,這個變量非常有用磺樱, 可以獲得系統(tǒng)內(nèi)的所有參數(shù)纳猫。當(dāng)然個人認為這個Aware沒必要去擴展婆咸,因為spring內(nèi)部都可以通過注入的方式來直接獲得。
EmbeddedValueResolverAware:用于獲取StringValueResolver的一個擴展類芜辕, StringValueResolver用于獲取基于String類型的properties的變量尚骄,一般我們都用@Value的方式去獲取,如果實現(xiàn)了這個Aware接口侵续,把StringValueResolver緩存起來倔丈,通過這個類去獲取String類型的變量,效果是一樣的状蜗。
ResourceLoaderAware:用于獲取ResourceLoader的一個擴展類需五,ResourceLoader可以用于獲取classpath內(nèi)所有的資源對象,可以擴展此類來拿到ResourceLoader對象轧坎。
ApplicationEventPublisherAware:用于獲取ApplicationEventPublisher的一個擴展類宏邮,ApplicationEventPublisher可以用來發(fā)布事件,結(jié)合ApplicationListener來共同使用,下文在介紹ApplicationListener時會詳細提到蜜氨。這個對象也可以通過spring注入的方式來獲得械筛。
MessageSourceAware:用于獲取MessageSource的一個擴展類,MessageSource主要用來做國際化飒炎。
ApplicationContextAware:用來獲取ApplicationContext的一個擴展類埋哟,ApplicationContext應(yīng)該是很多人非常熟悉的一個類了,就是spring上下文管理器郎汪,可以手動的獲取任何在spring上下文注冊的bean赤赊,我們經(jīng)常擴展這個接口來緩存spring上下文,包裝成靜態(tài)方法煞赢。同時ApplicationContext也實現(xiàn)了BeanFactory砍鸠,MessageSource,ApplicationEventPublisher等接口耕驰,也可以用來做相關(guān)接口的事情爷辱。
10.BeanNameAware
org.springframework.beans.factory.BeanNameAware
可以看到,這個類也是Aware擴展的一種朦肘,觸發(fā)點在bean的初始化之前饭弓,也就是postProcessBeforeInitialization之前,這個類的觸發(fā)點方法只有一個:setBeanName
使用場景為:用戶可以擴展這個點媒抠,在初始化bean之前拿到spring容器中注冊的的beanName弟断,來自行修改這個beanName的值。
擴展方式為:
publicclassNormalBeanAimplementsBeanNameAware{publicNormalBeanA(){System.out.println("NormalBean constructor");}@Overridepublicvoid setBeanName(String name){System.out.println("[BeanNameAware] "+ name);}}
11.@PostConstruct
javax.annotation.PostConstruct
這個并不算一個擴展點趴生,其實就是一個標注阀趴。其作用是在bean的初始化階段,如果對一個方法標注了@PostConstruct苍匆,會先調(diào)用這個方法刘急。這里重點是要關(guān)注下這個標準的觸發(fā)點,這個觸發(fā)點是在postProcessBeforeInitialization之后浸踩,InitializingBean.afterPropertiesSet之前叔汁。
使用場景:用戶可以對某一方法進行標注,來進行初始化某一個屬性
擴展方式為:
publicclassNormalBeanA{publicNormalBeanA(){System.out.println("NormalBean constructor");}@PostConstructpublicvoid init(){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è)務(wù)指標的初始化工作。
擴展方式為:
publicclassNormalBeanAimplementsInitializingBean{@Overridepublicvoid afterPropertiesSet()throwsException{System.out.println("[InitializingBean] NormalBeanA");}}
13.FactoryBean
org.springframework.beans.factory.FactoryBean
一般情況下苟耻,Spring通過反射機制利用bean的class屬性指定支線類去實例化bean篇恒,在某些情況下,實例化Bean過程比較復(fù)雜凶杖,如果按照傳統(tǒng)的方式胁艰,則需要在bean中提供大量的配置信息。配置方式的靈活性是受限的智蝠,這時采用編碼的方式可能會得到一個簡單的方案腾么。Spring為此提供了一個org.springframework.bean.factory.FactoryBean的工廠類接口,用戶可以通過實現(xiàn)該接口定制實例化Bean的邏輯杈湾。FactoryBean接口對于Spring框架來說占用重要的地位解虱,Spring自身就提供了70多個FactoryBean的實現(xiàn)。它們隱藏了實例化一些復(fù)雜bean的細節(jié)漆撞,給上層應(yīng)用帶來了便利殴泰。從Spring3.0開始,F(xiàn)actoryBean開始支持泛型浮驳,即接口聲明改為FactoryBean的形式
使用場景:用戶可以擴展這個類悍汛,來為要實例化的bean作一個代理,比如為該對象的所有的方法作一個攔截至会,在調(diào)用前后輸出一行l(wèi)og离咐,模仿ProxyFactoryBean的功能。
擴展方式為:
publicclassTestFactoryBeanimplementsFactoryBean<TestFactoryBean.TestFactoryInnerBean>{@OverridepublicTestFactoryBean.TestFactoryInnerBean getObject()throwsException{System.out.println("[FactoryBean] getObject");returnnewTestFactoryBean.TestFactoryInnerBean();}@OverridepublicClass<?> getObjectType(){returnTestFactoryBean.TestFactoryInnerBean.class;}@Overridepublicboolean isSingleton(){returntrue;}publicstaticclassTestFactoryInnerBean{}}
14.SmartInitializingSingleton
org.springframework.beans.factory.SmartInitializingSingleton
這個接口中只有一個方法afterSingletonsInstantiated奉件,其作用是是 在spring容器管理的所有單例對象(非懶加載對象)初始化完成之后調(diào)用的回調(diào)接口宵蛀。其觸發(fā)時機為postProcessAfterInitialization之后。
使用場景:用戶可以擴展此接口在對所有單例對象初始化完畢后县貌,做一些后置的業(yè)務(wù)處理术陶。
擴展方式為:
publicclassTestSmartInitializingSingletonimplementsSmartInitializingSingleton{@Overridepublicvoid afterSingletonsInstantiated(){System.out.println("[TestSmartInitializingSingleton]");}}
15.CommandLineRunner
org.springframework.boot.CommandLineRunner
這個接口也只有一個方法:run(String… args),觸發(fā)時機為整個項目啟動完畢后窃这,自動執(zhí)行瞳别。如果有多個CommandLineRunner征候,可以利用@Order來進行排序杭攻。
使用場景:用戶擴展此接口,進行啟動項目之后一些業(yè)務(wù)的預(yù)處理疤坝。
擴展方式為:
publicclassTestCommandLineRunnerimplementsCommandLineRunner{@Overridepublicvoid run(String... args)throwsException{System.out.println("[TestCommandLineRunner]");}}
16.DisposableBean
org.springframework.beans.factory.DisposableBean
這個擴展點也只有一個方法:destroy()兆解,其觸發(fā)時機為當(dāng)此對象銷毀時,會自動執(zhí)行這個方法跑揉。比如說運行applicationContext.registerShutdownHook時锅睛,就會觸發(fā)這個方法埠巨。
擴展方式為:
publicclassNormalBeanAimplementsDisposableBean{@Overridepublicvoid destroy()throwsException{System.out.println("[DisposableBean] NormalBeanA");}}
17.ApplicationListener
org.springframework.context.ApplicationListener
準確的說,這個應(yīng)該不算spring&springboot當(dāng)中的一個擴展點现拒,ApplicationListener可以監(jiān)聽某個事件的event辣垒,觸發(fā)時機可以穿插在業(yè)務(wù)方法執(zhí)行過程中,用戶可以自定義某個業(yè)務(wù)事件印蔬。但是spring內(nèi)部也有一些內(nèi)置事件勋桶,這種事件,可以穿插在啟動調(diào)用中侥猬。我們也可以利用這個特性例驹,來自己做一些內(nèi)置事件的監(jiān)聽器來達到和前面一些觸發(fā)點大致相同的事情。
接下來羅列下spring主要的內(nèi)置事件:
ContextRefreshedEvent
ApplicationContext 被初始化或刷新時退唠,該事件被發(fā)布鹃锈。這也可以在ConfigurableApplicationContext接口中使用 refresh()方法來發(fā)生。此處的初始化是指:所有的Bean被成功裝載瞧预,后處理Bean被檢測并激活屎债,所有Singleton Bean 被預(yù)實例化,ApplicationContext容器已就緒可用垢油。
ContextStartedEvent
當(dāng)使用 ConfigurableApplicationContext (ApplicationContext子接口)接口中的 start() 方法啟動 ApplicationContext時扔茅,該事件被發(fā)布。你可以調(diào)查你的數(shù)據(jù)庫秸苗,或者你可以在接受到這個事件后重啟任何停止的應(yīng)用程序召娜。
ContextStoppedEvent
當(dāng)使用 ConfigurableApplicationContext接口中的 stop()停止ApplicationContext 時,發(fā)布這個事件惊楼。你可以在接受到這個事件后做必要的清理的工作
ContextClosedEvent
當(dāng)使用 ConfigurableApplicationContext接口中的 close()方法關(guān)閉 ApplicationContext 時玖瘸,該事件被發(fā)布。一個已關(guān)閉的上下文到達生命周期末端檀咙;它不能被刷新或重啟
RequestHandledEvent
這是一個 web-specific 事件雅倒,告訴所有 bean HTTP 請求已經(jīng)被服務(wù)。只能應(yīng)用于使用DispatcherServlet的Web應(yīng)用弧可。在使用Spring作為前端的MVC控制器時蔑匣,當(dāng)Spring處理用戶請求結(jié)束后,系統(tǒng)會自動觸發(fā)該事件