Spring原始碼系列:BeanDefinition原始碼解析

glmapper發表於2018-01-22

Bean的定義主要由BeanDefinition來描述的。作為Spring中用於包裝Bean的資料結構,今天就來看看它的面紗下的真容吧。

首先就是BeanDefinition的類定義:

public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement
複製程式碼

對,沒錯,這貨是個介面,而不是類,是不是有點莫名奇妙呢?我們都知道在JAVA中,介面是不能用來new出新的物件的,那麼在Spring中,到底將XML解析出來的Bean包裝成了什麼呢?(這個密等下揭開)

先來看看BeanDefinition一個繼承結構吧(均是與BeanDefinition有直接關聯的類或者介面)!

Spring原始碼系列:BeanDefinition原始碼解析
從類圖中可以看出,BeanDefinition繼承了AttributeAccessor和BeanMetadataElement兩個介面;一個一個看。

AttributeAccessor

AttributeAccessor介面定義了最基本的對任意物件的後設資料的修改或者獲取,主要方法有:

//將name定義的屬性設定為提供的value值。如果value的值為null,則該屬性為{@link #removeAttribute removed}。
//通常,使用者應該注意通過使用完全限定的名稱(可能使用類或包名稱作為字首)來防止與其他後設資料屬性重疊。
void setAttribute(String name, Object value);
//獲取標識為name的屬性的值。
Object getAttribute(String name);
//刪除標識為name的屬性,並返回屬性值
Object removeAttribute(String name);
//如果名為name的屬性是否存在,存在返回true,否則返回false。
boolean hasAttribute(String name);
//返回所有屬性的名稱。
String[] attributeNames();
複製程式碼

BeanMetadataElement

BeanMetadataElement介面提供了一個getResource()方法,用來傳輸一個可配置的源物件。

//返回此後設資料元素的配置源物件(可能為null)。
Object getSource();
複製程式碼

BeanDifinition原始碼分析

一個BeanDefinition描述了一個bean的例項,包括屬性值,構造方法引數值和繼承自它的類的更多資訊。BeanDefinition僅僅是一個最簡單的介面,主要功能是允許BeanFactoryPostProcessor 例如PropertyPlaceHolderConfigure 能夠檢索並修改屬性值和別的bean的後設資料(譯註)。

//標準單例作用域的作用域識別符號:“singleton”。
//對於擴充套件的bean工廠可能支援更多的作用域。
String SCOPE_SINGLETON = ConfigurableBeanFactory.SCOPE_SINGLETON;
複製程式碼
//標準原型作用域的範圍識別符號:“prototype”。
//對於擴充套件的bean工廠可能支援更多的作用域。
String SCOPE_PROTOTYPE = ConfigurableBeanFactory.SCOPE_PROTOTYPE;
複製程式碼
//表示BeanDefinition是應用程式主要部分的角色提示。 通常對應於使用者定義的bean。
int ROLE_APPLICATION = 0;
複製程式碼

ROLE_SUPPORT =1實際上就是說,我這個Bean是使用者的,是從配置檔案中過來的。

//表示BeanDefinition是某些大型配置的支援部分的角色提示,通常是一個外部ComponentDefinition。
//當檢視某個特定的ComponentDefinition時,認為bean非常重要,
//以便在檢視應用程式的整體配置時能夠意識到這一點。
int ROLE_SUPPORT = 1;
複製程式碼

ROLE_INFRASTRUCTURE = 2就是我這Bean是Spring自己的,和你使用者沒有一毛錢關係。

//角色提示表明一個BeanDefinition是提供一個完全背景的角色,並且與終端使用者沒有關係。
//這個提示用於註冊完全是ComponentDefinition內部工作的一部分的bean
int ROLE_INFRASTRUCTURE = 2;
複製程式碼

上面是BeanDifinition的一些基本屬性資訊,一個就是標識下當前Bean的作用域,另外就是標識一下這個Bean是內部的還是外部的。下面來看這個介面為其子類都提供了哪些具體的行為方法:

1.當前Bean父類名稱get&set方法

//如果父類存在,設定這個bean定義的父定義的名稱。
void setParentName(String parentName);
//如果父類存在,則返回當前Bean的父類的名稱
String getParentName();
複製程式碼

2.當前Bean的className get&set方法

//指定此bean定義的bean類名稱。
//類名稱可以在bean factory後期處理中修改,通常用它的解析變體替換原來的類名稱。
void setBeanClassName(String beanClassName);

//返回此bean定義的當前bean類名稱。
//需要注意的是,這不一定是在執行時使用的實際類名,以防子類定義覆蓋/繼承其父類的類名。
//此外,這可能只是呼叫工廠方法的類,或者它 在呼叫方法的工廠bean引用的情況下甚至可能是空的。
//因此,不要認為這是在執行時定義的bean型別,而只是將其用於在單獨的bean定義級別進行解析。
String getBeanClassName();
複製程式碼

3.Bean的作用域get&set方法

//覆蓋此bean的目標範圍,指定一個新的範圍名稱。
void setScope(String scope);
//返回此bean的當前目標作用域的名稱,如果沒有確定,返回null
String getScope();
複製程式碼

4.懶載入的get&set方法

//設定這個bean是否應該被延遲初始化。如果{false},那麼這個bean將在啟動時由bean工廠例項化,
//這些工廠執行單例的立即初始化。
//懶載入 <bean lazy-init="true/false">
void setLazyInit(boolean lazyInit);
//返回這個bean是否應該被延遲初始化,即不是在啟動時立即例項化。只適用於單例bean。
boolean isLazyInit();
複製程式碼

5.依賴關係設定

//設定這個bean依賴被初始化的bean的名字。 bean工廠將保證這些bean首先被初始化。
//<bean depends-on="">
void setDependsOn(String... dependsOn);
//返回這個bean依賴的bean名稱。
String[] getDependsOn();
複製程式碼

6.是否是自動轉配設定

//設定這個bean是否是獲得自動裝配到其他bean的候選人。
//需要注意是,此標誌旨在僅影響基於型別的自動裝配。
//它不會影響按名稱的顯式引用,即使指定的bean沒有標記為autowire候選,也可以解決這個問題。
//因此,如果名稱匹配,通過名稱的自動裝配將注入一個bean。
void setAutowireCandidate(boolean autowireCandidate);

//返回這個bean是否是自動裝配到其他bean的候選者。就是是否在其他類中使用autowired來注入當前Bean的
//是否為被自動裝配 <bean autowire-candidate="true/false">
boolean isAutowireCandidate();
複製程式碼

7.主候選Bean

//是否為主候選bean    使用註解:@Primary
void setPrimary(boolean primary);
//返回這個bean是否是主要的autowire候選者。
boolean isPrimary();
複製程式碼

8.定義建立該Bean物件的工廠類

//指定要使用的工廠bean(如果有的話)。 這是呼叫指定的工廠方法的bean的名稱。
void setFactoryBeanName(String factoryBeanName);
//返回工廠bean的名字,如果有的話。
String getFactoryBeanName();
複製程式碼

9.建立該Bean物件的工廠方法

//如果有的話,指定工廠方法。
//這個方法先將通過建構函式引數被呼叫,或者如果引數,將呼叫該方法的無引數構造。
//方法將在指定的工廠bean(如果有的話)上被呼叫,或者作為本地bean類的靜態方法被呼叫。
void setFactoryMethodName(String factoryMethodName);
//如果存在,返回工廠方法名
String getFactoryMethodName();
複製程式碼

10.返回此bean的建構函式引數值。

//返回此bean的建構函式引數值。
ConstructorArgumentValues getConstructorArgumentValues();
複製程式碼

11.獲取普通屬性集合

//獲取普通屬性集合
MutablePropertyValues getPropertyValues();
複製程式碼

12.當前Bean的基本特性

//是否是單例的
boolean isSingleton();
//是否是多例的
boolean isPrototype();
//是否是抽象類
boolean isAbstract();
複製程式碼

13.當前Bean的應用

//獲取這個bean的應用
int getRole();
複製程式碼

13.可讀描述

//返回對bean定義的可讀描述。
String getDescription();
複製程式碼
//返回該bean定義來自的資源的描述
String getResourceDescription();
複製程式碼
//返回原始的BeanDefinition;如果沒有,則返回null。允許檢索裝飾的bean定義(如果有的話)。
//注意,這個方法返回直接的發起者。 迭代原始鏈,找到使用者定義的原始BeanDefinition。
BeanDefinition getOriginatingBeanDefinition();
複製程式碼

從上面的屬性和方法分析可以看出,BeanDefinition對於一個Bean的描述做了較為完整的一套約束。這為後續的子類提供的最基本的職責和屬性。

歡迎關注glmapper工作室公眾號

Spring原始碼系列:BeanDefinition原始碼解析

相關文章