Spring Bean生命周期之Bean的注冊詳解
前言
上篇文章介紹了Bean元信息的配置與解析過程,限于篇幅Bean注冊過程就沒展開。
這里主要圍繞BeanDefinitionReaderUtils#registerBeanDefinition
展開分析下Bean注冊過程
public static void registerBeanDefinition( BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) throws BeanDefinitionStoreException { // Register bean definition under primary name. String beanName = definitionHolder.getBeanName(); registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition()); // Register aliases for bean name, if any. String[] aliases = definitionHolder.getAliases(); if (aliases != null) { for (String alias : aliases) { registry.registerAlias(beanName, alias); } } }
上面無論是注冊bd還是建立alias-beanName之間的關(guān)系,均用到了BeanDefinitionRegistry
,因此我們就以它為突破口來展開
BeanFactory的繼承體系
對圖中常用接口或類進行說明:
ListableBeanFactory
集合類型BeanFactory 提供一種可以查找所有Bean實例的能力getBeanNamesForType(Class)
根據(jù)類型去查找Bean名稱列表不會強制Bean的初始化,可從源碼中看出來getBeansOfType(Class)
根據(jù)類型去查找Bean實例列表,會強制Bean的初始化,可從源碼中看出來getBeanNamesForAnnotation(Class)
根據(jù)注解類型獲取Bean名稱列表getBeansWithAnnotation(Class)
根據(jù)注解類型獲取Bean實例列表findAnnotationOnBean(String,Class)
根據(jù)指定名稱+標注類型獲取Bean實例
Hierarchical([?ha???rɑ?k?kl])BeanFactory
層次性BeanFactory,有父子容器的概念,可在ConfigurableListableBeanFactory
設(shè)置其父容器getParentBeanFactory()
獲取父容器boolean containsLocalBean(String name)
在當前容器中查找是否存在該名稱的Bean實例
SingletonBeanRegistry
單實例BeanFactory
,與單實例有關(guān)ConfigurableBeanFactory
可配置的BeanFactory
,這個一般不用于應用程序,是給其他BeanFactory擴展用的。的確,定義了很多配置方法ConfigurableListableBeanFactory
可配置的集合類型的BeanFactoryAutowireCapableBeanFactory
提供具有自動裝配能力的BeanFactory
透過繼承體系可以看出,BeanDefinitionRegistry
的實現(xiàn)類是DefaultListableBeanFactory
,該類同時實現(xiàn)了諸多接口,可謂是BeanFactory中集大成者,因此我們到DefaultListableBeanFactory
中閱讀下bd注冊及別名注冊的源碼
Bean的注冊
先來分析下DefaultListableBeanFactory
的幾個重要的成員屬性
// 這個實質(zhì)上就是IoC容器中Bean的載體,沒錯 它很重要,但它是無序的 private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256); //它代表了bd名稱的集合,它是有序的 遵循bd注冊的順序 private volatile List<String> beanDefinitionNames = new ArrayList<>(256); // 這是已創(chuàng)建bd名稱的集合,在doGetBean方法根據(jù)beanName創(chuàng)建Bean時,beanName會被加到此集合中 private final Set<String> alreadyCreated = Collections.newSetFromMap(new ConcurrentHashMap<>(256));
上面兩個屬性都比較重要,兩者結(jié)合使用的話可以實現(xiàn)bd的順序訪問(其實就是遍歷beanDefinitionNames集合時,使用beanDefinitionMap去獲取bd)
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException { //對beanName、bd進行非空驗證 Assert.hasText(beanName, "Bean name must not be empty"); Assert.notNull(beanDefinition, "BeanDefinition must not be null"); //如果bd是AbstractBeanDefinition類型,則對bd進行驗證(一般情況下 我們場景的bd都是繼承自AbstractBeanDefinition的) if (beanDefinition instanceof AbstractBeanDefinition) { try { //bd驗證 ((AbstractBeanDefinition) beanDefinition).validate(); } catch (BeanDefinitionValidationException ex) { //省略異常代碼 } } //從beanDefinitionMap根據(jù)beanName取bd BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName); //如果beanName名稱的bd已經(jīng)存在 if (existingDefinition != null) { //如果不允許Bean被重新注冊 則拋出異常,這里默認值是true if (!isAllowBeanDefinitionOverriding()) { throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition); } //如果已被注冊bd的角色值小于當前待注冊bd的角色值 else if (existingDefinition.getRole() < beanDefinition.getRole()) { // 省略日志輸出 } //如果已注冊的同名bd 與本次注冊的bd不相同 else if (!beanDefinition.equals(existingDefinition)) { //省略日志輸出 } else { //省略日志輸出 } //將beanName-bd鍵值對放入beanDefinitionMap集合 this.beanDefinitionMap.put(beanName, beanDefinition); } else { //流程走到這里 說明在beanDefinitionMap中不存在同名bd //條件成立 說明alreadyCreated不為空 即有bd已被創(chuàng)建 if (hasBeanCreationStarted()) { // 如果在此之間 有bean正在被創(chuàng)建 則這里進行加鎖處理 synchronized (this.beanDefinitionMap) { //將beanName-bd鍵值對放入beanDefinitionMap集合 this.beanDefinitionMap.put(beanName, beanDefinition); //將beanName添加到beanDefinitionNames集合中 List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1); updatedDefinitions.addAll(this.beanDefinitionNames); updatedDefinitions.add(beanName); this.beanDefinitionNames = updatedDefinitions; //如果beanName是手動注冊的單例Bean名稱,則更新manualSingletonNames if (this.manualSingletonNames.contains(beanName)) { Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames); //這里從集合中刪除的原因個人理解: //manualSingletonNames記錄的是在registerSingleton時被添加的單實例beanName,而這里注入的不是單實例Bean。因為manualSingletonNames包含了此beanName,因此需要剔除 updatedSingletons.remove(beanName); this.manualSingletonNames = updatedSingletons; } } } else { //如果沒有bean在被創(chuàng)建 //將beanName-bd鍵值對放入beanDefinitionMap集合 this.beanDefinitionMap.put(beanName, beanDefinition); //將beanName添加到集合中 this.beanDefinitionNames.add(beanName); //這里從manualSingletonNames中剔除,個人理解為拖地操作,畢竟若集合中沒有此beanName 也remove不了 this.manualSingletonNames.remove(beanName); } //這個集合表示凍結(jié)配置時緩存的beanName集合,暫時未理解透此集合的用途 this.frozenBeanDefinitionNames = null; } //如果已存在同名bd或已存在同名的單例對象,則重置所有已被緩存的同名的bd數(shù)據(jù),因此這里bd注冊成功后,肯定后續(xù)還會再生成Bean的 if (existingDefinition != null || containsSingleton(beanName)) { resetBeanDefinition(beanName); } }
其實分析下來發(fā)現(xiàn)Bean注冊的過程還是比較容易理解的,下面試著總結(jié)一下:
- 若bd未被注冊過,則將bd信息存入BeanDefinitionMap等集合中
- 若bd已被注冊過,允許覆蓋注冊的情況下,將bd信息存入BeanDefinitionMap等集合中,并清除已被緩存的同名bd信息
下面看一下清除bd信息的代碼邏輯
protected void resetBeanDefinition(String beanName) { // 如果此bd屬于被合并的BeanDefinition,則這里將其從MergeBeanDefinition集合中剔除 clearMergedBeanDefinition(beanName); // 如果已存在同名的單例對象 則銷毀,具體細節(jié)先不展開 destroySingleton(beanName); // 這里for循環(huán)邏輯與MergeBeanDefinition相關(guān),如果存在MergedBeanDefinitionPostProcessor,則重置此bd for (BeanPostProcessor processor : getBeanPostProcessors()) { if (processor instanceof MergedBeanDefinitionPostProcessor) { ((MergedBeanDefinitionPostProcessor) processor).resetBeanDefinition(beanName); } } // BeanDefinition運行有層級的,如果此bd擁有多個父級bd,那么這里遞歸地重置其父bd for (String bdName : this.beanDefinitionNames) { if (!beanName.equals(bdName)) { BeanDefinition bd = this.beanDefinitionMap.get(bdName); if (beanName.equals(bd.getParentName())) { resetBeanDefinition(bdName); } } } }
alias別名的注冊
看了Bean的注冊,再來看別名的注冊 發(fā)現(xiàn)流程比較清晰,基本上一目了然。
//注意 這里的name 不要具象為beanName,雖然我們是從建立beanName--alias關(guān)系出發(fā)追溯到這里的 public void registerAlias(String name, String alias) { //對name、alias進行斷言驗證 Assert.hasText(name, "'name' must not be empty"); Assert.hasText(alias, "'alias' must not be empty"); synchronized (this.aliasMap) { //如果別名與beanName相同,那別名就沒有必要存在了,因此選擇直接從this.aliasMap中移除此別名 if (alias.equals(name)) { this.aliasMap.remove(alias); //省略日志輸出 } else { //從aliasMap中根據(jù)別名獲取name String registeredName = this.aliasMap.get(alias); if (registeredName != null) { //如果已存在的registeredName與此此要注冊的name一致,那就沒必要注冊了 if (registeredName.equals(name)) { return; } //流程走到這里,說明同一個別名,對應兩個name,如果不允許alias覆蓋 則拋出異常 if (!allowAliasOverriding()) { //省略異常及日志輸出 } //這里對alias進行循環(huán)檢查,避免出現(xiàn)A的別名是B,B的別名是A的情況 checkForAliasCircle(name, alias); //將alias--name 放入aliasMap this.aliasMap.put(alias, name); //省略日志輸出 } } }
alias與beanName的映射關(guān)系,為根據(jù)名稱查找Bean又提供了一種思路。就是說除了根據(jù)beanName外,也可以根據(jù)alias去查找Bean。
這部分源碼如下
//name可以是beanName,也可以是alias public String canonicalName(String name) { //局部變量賦值 String canonicalName = name; // Handle aliasing... String resolvedName; do { //如果從aliasMap中能根據(jù)alias分析出beanName resolvedName = this.aliasMap.get(canonicalName); if (resolvedName != null) { canonicalName = resolvedName; } } while (resolvedName != null); // 無論入?yún)ame是beanName還是alias,這里返回的都應該是beanName了 return canonicalName; }
總結(jié)
好了,這篇主要分析了BeanDefinition的注冊,順帶著也說了別名的注冊情況。既然BeanDefinition已經(jīng)注冊完成,那緊接著就是BeanDefinition的實例化過程了,這個放到下次分析吧。
本篇文章就到這里了,希望能夠給你帶來幫助,也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容!
相關(guān)文章
推薦兩款java開發(fā)實用工具 hutool 和 lombok
通過本文給大家推薦兩款java開發(fā)實用工具 hutool 和 lombok,本文通過實例代碼給大家介紹的非常詳細,需要的朋友參考下吧2021-04-04Java并發(fā)系列之JUC中的Lock鎖與synchronized同步代碼塊問題
這篇文章主要介紹了Java并發(fā)系列之JUC中的Lock鎖與synchronized同步代碼塊,簡單介紹了lock鎖及鎖的底層知識,結(jié)合案例給大家介紹的非常詳細,需要的朋友可以參考下2022-04-04JAVA 筆記 ClassLoader.getResourceAsStream() 與 Class.getResourc
這篇文章主要介紹了JAVA 筆記 ClassLoader.getResourceAsStream() 與 Class.getResourceAsStream()的區(qū)別,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-07-07java基礎(chǔ)篇之Date類型最常用的時間計算(相當全面)
這篇文章主要給大家介紹了關(guān)于java基礎(chǔ)篇之Date類型最常用的時間計算的相關(guān)資料,Java中的Date類是用來表示日期和時間的類,它提供了一些常用的方法來處理日期和時間的操作,需要的朋友可以參考下2023-12-12java用接口、多態(tài)、繼承、類計算三角形和矩形周長及面積的方法
這篇文章主要介紹了java用接口、多態(tài)、繼承、類計算三角形和矩形周長及面積的方法,涉及java面向?qū)ο笾蓄?、接口、多態(tài)等的使用技巧,需要的朋友可以參考下2015-05-05SpringBoot多數(shù)據(jù)源讀寫分離的自定義配置問題及解決方法
這篇文章主要介紹了SpringBoot多數(shù)據(jù)源讀寫分離的自定義配置,我們可以通過自定義配置數(shù)據(jù)庫配置類來解決這個問題,方式有很多,不同的業(yè)務采用的方式也不同,下面我簡單的介紹我們項目的使用的方法2022-06-06java 中 String format 和Math類實例詳解
這篇文章主要介紹了java 中 String format 和Math類實例詳解的相關(guān)資料,需要的朋友可以參考下2017-06-06