Spring鉤子方法和鉤子接口的使用詳解

https://www.sohu.com/a/166804449_714863

前言

SpringFramework其實具有很高的擴展性,只是很少人喜歡挖掘那些擴展點,而且官方的Refrence也很少提到那些Hook類或Hook接口,至於是不是Spring官方有意爲之就不得而知。

目前看到的Spring的一些對外開放的擴展點、Hook接口或者Hook類,如果有什麼錯誤,希望多多交流指正,一切以Spring的源碼爲準,文章編寫使用的Spring版本爲4.3.8.Release,對應SpringBoot的版本爲1.5.3.RELEASE

1、Aware接口族

Spring中提供了各種Aware接口,方便從上下文中獲取當前的運行環境,比較常見的幾個子接口有:

BeanFactoryAware,BeanNameAware,ApplicationContextAware,EnvironmentAware,BeanClassLoaderAware等,這些Aware的作用都可以從命名得知,並且其使用也是十分簡單。

例如我們經常看到SpringContext工具類:

實現ApplicationContextAware接口可以獲取ApplicationContext

又例如想獲取到當前的一個Spring Bean的BeanFactory:

一般來說,拿到的應該是DefaultListableBeanFactory,因爲這個BeanFactory是BeanFactory一族的最底層的BeanFactory實現類,擁有所有父BeanFactory的功能。

其他的Aware可以自己嘗試下功能。

2、InitializingBean接口和DisposableBean接口

InitializingBean接口只有一個方法#afterPropertiesSet,作用是:當一個Bean實現InitializingBean,#afterPropertiesSet方法裏面可以添加自定義的初始化方法或者做一些資源初始化操作(Invoked by a BeanFactory after it has set all bean properties supplied ==> "當BeanFactory 設置完所有的Bean屬性之後纔會調用#afterPropertiesSet方法")。

DisposableBean接口只有一個方法#destroy,作用是:當一個單例Bean實現DisposableBean,#destroy可以添加自定義的一些銷燬方法或者資源釋放操作(Invoked by a BeanFactory on destruction of a singleton ==>"單例銷燬時由BeanFactory調用#destroy")

使用例子:

3、ImportBeanDefinitionRegistrar接口

功能:

先看官方的註釋

翻譯一下大概如下:

1.當處理Java編程式配置類(使用了@Configuration的類)的時候,ImportBeanDefinitionRegistrar接口的實現類可以註冊額外的bean definitions;

2.ImportBeanDefinitionRegistrar接口的實現類必須提供給@Import註解或者是ImportSelector接口返回值

3.ImportBeanDefinitionRegistrar接口的實現類可能還會實現下面org.springframework.beans.factory.Aware接口中的一個或者多個,它們各自的方法優先於ImportBeanDefinitionRegistrar#registerBeanDefinitions被調用

org.springframework.beans.factory.Aware的部分接口如下:

  • org.springframework.context.EnvironmentAware(讀取或者修改Environment的變量)

  • org.springframework.beans.factory.BeanFactoryAware (獲取Bean自身的Bean工廠)

  • org.springframework.beans.factory.BeanClassLoaderAware(獲取Bean自身的類加載器)

  • org.springframework.context.ResourceLoaderAware(獲取Bean自身的資源加載器)

個人理解:

1.首先需要自定義一個類去實現ImportBeanDefinitionRegistrar接口, #registerBeanDefinitions方法的參數有(使用了@Import的類型)元註解AnnotationMetadata以及BeanDefinitionRegistry(Bean註冊相關方法的提供接口),通過BeanDefinitionRegistry的方法可以實現BeanDefinition註冊、移除等相關操作;

2.爲了保證1生效,必須定義一個Java配置類(帶有註解@Configuration)通過@Import指定1中定義的實現類

一個例子:

目標是通過自定義註解@EnableThrowable裏面的targets屬性指定需要註冊進去Spring容器的class,當註解使用在@Configuration的類上,實現指定class的註冊,然後可以使用@Autowire實現自動注入。

定義ImportBeanDefinitionRegistrar的實現類EnableThrowableRegistrar:

定義一個註解@EnableThrowable:

定義一個Java配置類ConcreteConfiguration:

定義一個非Spring管理的Service類ConcreteService:

測試代碼:

結果:

可以看到讀取Environment屬性成功,同時普通Java類ConcreteService成功註冊到Spring容器並且自動注入和調用成功。

4、BeanPostProcessor接口和BeanFactoryPostProcessor接口

一般我們叫這兩個接口爲Spring的Bean後置處理器接口,作用是爲Bean的初始化前後提供可擴展的空間。先看接口的方法:

BeanPostProcessor

BeanFactoryPostProcessor

BeanFactoryPostProcessor可以對bean的定義(配置元數據)進行處理。也就是說,Spring IoC容器允許BeanFactoryPostProcessor在容器實際實例化任何其它的bean之前讀取配置元數據,並有可能修改它。

如果你願意,你可以配置多個BeanFactoryPostProcessor。你還能通過設置'order'屬性來控制BeanFactoryPostProcessor的執行次序。(大概可以這樣理解:Spring容器加載了bean的定義文件之後,在bean實例化之前執行的)

實現BeanPostProcessor接口可以在Bean(實例化之後)初始化的前後做一些自定義的操作,但是拿到的參數只有BeanDefinition實例和BeanDefinition的名稱,也就是無法修改BeanDefinition元數據,這裏說的Bean的初始化是:

1)bean實現了InitializingBean接口,對應的方法爲afterPropertiesSet

2)在bean定義的時候,通過init-method設置的方法

PS:BeanFactoryPostProcessor回調會先於BeanPostProcessor

使用例子:

實現一個BeanPostProcessor==>ConcreteBeanPostProcessor

實現一個BeanFactoryPostProcessor==>ConcreteBeanFactoryPostProcessor

定義一個Spring的Bean

測試類:

結果:

5、BeanDefinitionRegistryPostProcessor 接口

BeanDefinitionRegistryPostProcessor 接口可以看作是BeanFactoryPostProcessor和ImportBeanDefinitionRegistrar的功能集合,既可以獲取和修改BeanDefinition的元數據,也可以實現BeanDefinition的註冊、移除等操作。

例子:

定義一個BeanDefinitionRegistryPostProcessor==>ConcreteBeanDefinitionRegistryPostProcessor

定義一個普通的Java類:

測試類:

結果:

6、FactoryBean接口

首先第一眼要注意,是FactoryBean接口而不是BeanFactory接口。一般情況下,Spring通過反射機制利用bean的class屬性指定實現類來實例化bean ,實例化bean過程比較複雜。

FactoryBean接口就是爲了簡化此過程,把bean的實例化定製邏輯下發給使用者。

在該接口中還定義了以下3個方法。

T getObject():返回由FactoryBean創建的bean實例,如果isSingleton()返回true,則該實例會放到Spring容器中單實例緩存池中。

boolean isSingleton():返回由FactoryBean創建的bean實例的作用域是singleton還是prototype。

Class<T> getObjectType():返回FactoryBean創建的bean類型。

注意一點:通過Spring容器的getBean()方法返回的不是FactoryBean本身,而是FactoryBean#getObject()方法所返回的對象,相當於FactoryBean#getObject()代理了getBean()方法。

如果希望獲取CarFactoryBean的實例,則需要在使用getBean(beanName) 方法時在beanName前顯示的加上 "&" 前綴。

一個例子:

實體類:

自定義FactoryBean:

測試類:

結果:

結果和預期一樣,通過ApplicationContext#getBean(beanName)獲取到的實際上是FactoryBean#getObject的實例,ApplicationContext#getBean(“&” + beanName)獲取到的纔是FruitFactoryBean本身的實例。

7.ApplicationListener

ApplicationListener是一個接口,裏面只有一個onApplicationEvent(E event)方法,這個泛型E必須是ApplicationEvent的子類,而ApplicationEvent是Spring定義的事件,繼承於EventObject,構造要求必須傳入一個Object類型的source,這個source可以作爲一個存儲對象。

將會在ApplicationListener的onApplicationEvent裏面得到回調。如果在上下文中部署一個實現了ApplicationListener接口的bean,那麼每當在一個ApplicationEvent發佈到 ApplicationContext時,這個bean得到通知。

其實這就是標準的Oberver設計模式。另外,ApplicationEvent的發佈由ApplicationContext通過#publishEvent方法完成。其實這個實現從原理和代碼上看都有點像Guava的eventbus。

貼一個例子:

EmailEvent:

EmailApplicationListener:

測試類:

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章