1. 程式人生 > 程式設計 >Spring原始碼學習(五) 建立Bean過程中的擴充套件點

Spring原始碼學習(五) 建立Bean過程中的擴充套件點

引言

上班挺累
事事都煩
寫篇文章
兌現諾言

一圖勝所有

getbean的擴充套件點
getbean的擴充套件點

綠色的部一般用於Spring內部擴充套件,黃色的部分可用於自定義例項化。 本文僅僅聊聊InitializingBean,對於綠色部分,建議您檢視,其他人寫的blog my.oschina.net/xiaolyuh/bl…

InitializingBean介面

介面註釋

/**
 * 1. 實現的介面是個Bean,BeanFactory設定它所有的屬性後觸發。
 * 2. 可用於執行自定義例項化或校驗必要的屬性是否被設定。
 * 注:實現InitializingBean的另外一種方式是,
 *    制定一個自定義的init method,
 *    通過<bean> 元素的 init-method或者,使用@PostConstruct註解
*/
public interface InitializingBean {
   void afterPropertiesSet() throws Exception;
}

複製程式碼

應用舉例

找具體例子時,我鬼使神差的找到了mybatis與Spring結合的時候用到的SqlSessionFactoryBean類,實現如下:

public class SqlSessionFactoryBean implements 
FactoryBean<SqlSessionFactory>,InitializingBean,ApplicationListener<ApplicationEvent> {
    public void afterPropertiesSet() throws Exception {
      notNull(dataSource,"Property 'dataSource' is required"
); notNull(sqlSessionFactoryBuilder,"Property 'sqlSessionFactoryBuilder' is required"); state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null),"Property 'configuration' and 'configLocation' can not specified with together"
); this.sqlSessionFactory = buildSqlSessionFactory(); } //省略其他實現 ... } 複製程式碼

afterPropertiesSet的實現很簡單,就是建立了SqlSessionFactory。比起afterPropertiesSet,FactoryBean介面更令我好奇,待我仔細閱讀了FactoryBean的註釋,發現上邊的圖少了一個重要擴充套件點。

另一個重要擴充套件FactoryBean

解決例項化Bean過程比較複雜的問題,可以實現該FactoryBean介面定製例項化Bean的邏輯.
儘管FactoryBean以bean的風格定義,但是它總是對外暴露getObject()建立的物件。 -- 溫安適總結於 20191013

FactoryBean的程式設計契約如下

  1. 它的實現不應該依賴註解注入或者其他反射工具
  2. getObjectType(),getObject()的呼叫早於服務啟動,甚至早於任何 post-processor
  3. 如果你需要獲取其他的Bean,你需要實現BeanFactoryAware介面,並手動程式設計獲取其他bean。
  4. 最後FactoryBean物件參與BeanFactory的同步建立bean的過程,通常不需要內部同步,除了懶載入FactoryBean本身時。

註釋翻譯

/**
 *  1. 實現這個介面的是個bean,與BeanFactory結合使用。
 *  2. 它自己是單個物件的工廠。
 *  3.FactoryBean 支援單例和原形,並能按需提供懶載入或啟動時提前暴露。
 *  4. SmartFactoryBean允許暴露更多細粒度行為元資料
 *  5.Spring框架本身大量使用這個介面,
 *   例如{@link org.springframework.aop.framework.ProxyFactoryBean},
 * {@link org.springframework.jndi.JndiObjectFactoryBean}。
 */
public interface FactoryBean<T> {

   /**
    * 返回一個被當前工廠管理的例項(可能共享或獨立)
    * 與BeanFactory結合,支援單例,原形模式。
    * 如果FactoryBean在被呼叫時沒有完全的載入(例如存在迴圈引用)
    * 將丟擲FactoryBeanNotInitializedException。
    * Spring 2.0以後,FactoryBeans允許返回null,* 返回null時,不在丟擲FactoryBeanNotInitializedException,
    * FactoryBean的實現會視情況而定,
    *是否丟擲FactoryBeanNotInitializedException
    * BeanFactory的實現必須考慮這種情況.
    */
   @Nullable
   T getObject() throws Exception;

   /**
    * 返回FactoryBean建立物件的型別,如果事先不知道返回null
    *允許在例項化物件時檢查特定型別的bean(例如用於自動裝配時)。
    *在建立單例物件的實現時,該方法應儘量避免單例建立,它應該提前估計型別。
    *在建立原形型別的object時,也建議返回有意義的型別資訊。
    *這個方法,可以在FactoryBean完全例項化之前呼叫。它不能依賴於初始化。
    *注意:自動注入將簡單忽略factoryBean,這個方法會返回null。
    *因此,強烈建議使用factorybean的當前狀態正確地實現此方法。
    */
   @Nullable
   Class<?> getObjectType();

   /**
    * 返回true時, getobject()
    * 將始終返回相同的物件。
    * 注意:如果一個factorybean儲存一個單例物件,
    * 從 getObject()返回的物件
    * 可能被擁有它的BeanFaFactory快取。
    * factorybean本身的單例狀態通常是由擁有它的BeanFactory確定;
    */
   default boolean isSingleton() {
      return true;
   }

}

複製程式碼

BeanFactory與FactoryBean區別

介面名稱 BeanFactory FactoryBean
用途 BeanFactory是IOC容器的頂層介面。它的職責包括:例項化、定位、配置應用程式中的物件及建立這些物件間的依賴 解決例項化Bean過程比較複雜的問題。通過實現該介面定製例項化Bean的邏輯
管理的物件 所有bean getObject方法建立的物件