Spring源碼學習(五) 建立Bean過程當中的擴展點

引言

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

一圖勝全部

綠色的部通常用於Spring內部擴展，黃色的部分可用於自定義實例化。 本文僅僅聊聊InitializingBean，對於綠色部分，建議您查看，其餘人寫的blog https://my.oschina.net/xiaolyuh/blog/3113215

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方法建立的對象