4.8 容器擴展點 · Java 開源項目中文文檔

## 4.8 容器擴展點通常情況下，應用程序開發人員不需要編寫 ApplicationContext 實現類的子類。相反，Spring 的 IoC 容器可以通過插件的方式來擴展，就是實現特定的整合接口。下面的幾個章節會來說明這些整合接口。 ### 4.8.1 使用 BeanPostProcessor 來自定義 bean BeanPostProcessor 接口定義了你可以提供實現你自己的（或覆蓋容器默認的）實例邏輯，依賴解析邏輯等的回調方法。如果你想在 Spring 容器完成實例化，配置和初始化 bean 之后實現一些自定義邏輯，那么你可以使用一個或多個 BeanPostProcessor 實現類的插件。你可以配置多個 BeanPostProcessor 實例，而且你還可以通過設置 order 屬性來控制這些 BeanPostProcessor 執行的順序。僅當 BeanPostProcessor 實現了 Ordered 接口你才可以設置設個屬性；如果你想編寫你自己的 BeanPostProcessor，你也應該考慮實現 Ordered 接口。要了解更多細節，可以參考 JavaDoc 文檔中的 BeanPostProcessor 和 Ordered 接口。 > ![](img/note.gif) > 注意 > BeanPostProcessor 操作 bean（對象）實例；那也就是說，Spring 的 IoC 容器實例化 bean 的實例，之后 BeanPostProcessor 來做它們要做的事情。 BeanPostProcessor 的范圍是對于每一個容器來說的。如果你使用了容器繼承，那么這才有所關聯。如果你在一個容器中定義了 BeanPostProcessor，那么它僅僅會在那個容器中后處理 bean。換句話說，一個容器中定義的 bean 不會被另外一個容器中定義的 BeanPostProcessor 來進行后處理，即便是兩個容器都是相同繼承鏈上的一部分。要修改真正的 bean 定義（也就是說，定義 bean 的藍圖），你可以使用 4.8.2 節，“使用 BeanFactoryPostProcessor 來自定義配置元數據 ” 描述的 BeanFactoryPostProcessor 來進行。 org.springframework.beans.factory.config.BeanPostProcessor 接口由兩個回調方法構成。如果在容器中有一個類注冊為后處理器，對于容器創建的每個 bean 的實例，后處理器從容器中獲得回調方法，在容器初始化方法之前（比如 InitializingBean 的 afterPropertiesSet()方法和任意聲明為初始化的方法）被調用，還有在 bean 初始化回調之后被調用。后處理器可以對 bean 實例采取任何動作，包括完整忽略回調。通常來說 bean 的后處理器會對回調接口進行檢查，或者會使用代理包裝 bean。一些 Spring 的 AOP 基類也會作為 bean 的后處理器實現來提供代理包裝邏輯。 ApplicationContext 會自動檢測任意實現了 BeanPostProcessor 接口的 bean 定義的配置元數據。ApplicationContext 注冊這些 bean 作為后處理器，那么它們可以在 bean 創建之后被調用。Bean 的后處理器可以在容器中部署，就像其它 bean 那樣。 BeanPostProcessor 和 AOP 自動代理實現了 BeanPostProcessor 接口的類是特殊的，會被容器不同對待。所有它們參照的 BeanPostProcessor 和 bea n 會在啟動時被實例化，作為 ApplicationContext 啟動階段特殊的一部分。接下來，所有的 BeanPostProcessor 以排序的方式注冊并應用于容器中的其它 bean。因為 AOP 自動代理作為 BeanPostProcessor 本身的實現，它們為自動代理資格的直接引用的既不是 BeanPostProcessor 也不是 bean，因此沒有織入它們的方面。對于這樣的 bean，你應該看到一個信息級的日志消息：“Bean foo 沒有由所有BeanPostProcessor 接口處理的資格（比如：沒有自動代理的資格）”。下面的示例展示了如何在 ApplicationContext 中編寫，注冊和使用BeanPostProcessor。 #### 4.8.1.1 示例：BeanPostProcessor 風格的 Hello World 第一個示例說明了基本的用法。示例展示了一個自定義的 BeanPostProcessor 實現類來調用每個由容器創建 bean 的 toString()方法并打印出字符串到系統的控制臺中。自定義 BeanPostProcessor 實現類的定義： ``` package scripting; import org.springframework.beans.factory.config.BeanPostProcessor; import org.springframework.beans.BeansException; public class InstantiationTracingBeanPostProcessor implements BeanPostProcessor { // 簡單地返回實例化的bean public Object postProcessBeforeInitialization(Object bean, String beanName)throws BeansException { return bean; // 這里我們可能返回任意對象的引用... } public Object postProcessAfterInitialization(Object bean, String beanName)throws BeansException { System.out.println("Bean '" + beanName + "' created : " + bean.toString()); return bean; } } <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema -instance" xmlns:lang="http://www.springframework.org/schema/lang" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring -beans-3.0.xsd http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-3.0.xsd"> <lang:groovy id="messenger" script-source="classpath:org/springframework/scripting/gr oovy/Messenger.groovy"> <lang:property name="message" value="Fiona Apple Is Just So Dreamy."/> </lang:groovy>  <bean class="scripting.InstantiationTracingBeanPostProcessor" /> </beans> ``` 注意 InstantiationTracingBeanPostProcessor 僅僅是簡單地定義。它也沒有命名，因為它會像其它 bean 那樣被依賴注入。（前面的配置也可以定義成 Groovy 腳本支持的 bean。Spring 2.0 動態語言支持在第 27 章中來詳細說明）下面示例的 Java 應用程序執行了前面配置的代碼： ``` import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationConte xt; import org.springframework.scripting.Messenger; public final class Boot { public static void main(final String[] args) throws Exception { ApplicationContext ctx = new ClassPathXmlApplicationContext("scripting/beans.xml"); Messenger messenger = (Messenger) ctx.getBean("messenger"); System.out.println(messenger); } } ``` 上面應用程序的輸出類似于如下內容： ``` Bean 'messenger' created : org.springframework.scripting.groovy.GroovyMessenger@272961 org.springframework.scripting.groovy.GroovyMessenger@272961 ``` #### 4.8.1.2 示例：RequiredAnnotationBeanPostProcessor 配合自定義的 BeanPostProcessor 實現使用回調接口或者注解，是擴展 Spring IoC 容器的一種通用方式。Spring 的 RequiredAnnotationBeanPostProcessor 就是一個例子 – 一種 BeanPostProcessor 實現，隨著 Spring 一起發布，來保證 bean 中被（任意）注解所標記的 JavaBean 屬性在真正（配置）注入時有值。 ### 4.8.2 使用 BeanFactoryPostProcessor 自定義配置元數據下一個擴展點我們要來看看 org.springframework.beans.factory.config.BeanFactoryPostProcessor 。這個接口的語義和那些 BeanPostProcessor 是相似的，但有一個主要的不同點： BeanFactoryPostProcessor 操作 bean 的配置元數據；也就是說 Spring 的 IoC 容器允許 BeanFactoryPostProcessor 來讀取配置元數據并在容器實例化 BeanFactoryPostProcessor 以外的任何 bean 之前可以修改它。你可以配置多個 BeanFactoryPostProcessor，并且你也可以通過 order 屬性來控制這些 BeanFactoryPostProcessor 執行的順序。然而，僅當 BeanFactoryPostProcessor 實現 Ordered 接口時你才能設置這個屬性。如果編寫你自己的 BeanFactoryPostProcessor，你也應該考慮實現 Ordered 接口。參考 JavaDoc 文檔來獲取 BeanFactoryPostProcessor 和 Ordered 接口的更多細節。 > ![](img/note.gif) > 注意 > 如果你想改變真實的 bean 實例（也就是說，從配置元數據中創建的對象），那么你需要使用 BeanPostProcessor（在上面 4.8.1 節，“使用 BeanPostProcessor 來自定義 bean ”中描述）來代替。在 BeanFactoryPostProcessor （比如使用 BeanFactory.getBean()）中來使用這些 bea n 的實例雖然在技術上是可行的，但這么來做會引起 bean 過早實例化，違反標準的容器生命周期。這也會引發一些副作用，比如繞過 bean 的后處理。而且，BeanFactoryPostProcessor 的范圍也是對每一個容器來說的。如果你使用了容器的繼承的話，這就是唯一相關的點了。如果你在一個容器中定義了 BeanFactoryPostProcessor，那么它只會用于在那個容器中的 bean。一個容器中 Bean 的定義不會被另外一個容器中的 BeanFactoryPostProcessor 后處理，即便兩個容器都是相同繼承關系的一部分。當在 ApplicationContext 中聲明時，bean 工廠后處理器會自動被執行，這就可以對定義在容器中的配置元數據進行修改。Spring 包含了一些預定義的 bean 工廠后處理器，比如 PropertyOverrideConfigurer 和 PropertyPlaceholderConfigurer.。自定義的 BeanFactoryPostProcessor 也可以來用，比如，注冊自定義的屬性編輯器。 ApplicationContext 會自動檢測任意部署其中，且實現了 BeanFactoryPostProcessor 接口的 bean。在適當的時間，它用這些 bean 作為 bean 工廠后處理器。你可以部署這些后處理器 bean 作為你想用的任意其它的 bean。 > ![](img/note.gif) > 注意 > 和 BeanPostProcessor 一樣，通常你不會想配置 BeanFactoryPostProcessor 來進行延遲初始化。如果沒有其它 bean 引用 Bean(Factory)PostProcessor，那么后處理器就不會被初始化了。因此，標記它為延遲初始化就會被忽略，即便你在`<beans/>`元素聲明中設置 default-lazy-init 屬性為 true，那么 Bean(Factory)PostProcessor 也會正常被初始化。 #### 4.8.2.1 示例：PropertyPlaceholderConfigurer 你可以使用來對使用了標準 Java Properties 格式的分離文件中定義的 bean 來聲明屬性值。這么來做可以使得部署應用程序來自定義指定的環境屬性，比如數據庫的連接 URL 和密碼，不會有修改容器的主 XML 定義文件或其它文件的復雜性和風險。考慮一下下面這個基于 XML 的配置元數據代碼片段，這里的 dataSource 就使用了占位符來定義。這個示例展示了從 Properties 文件中配置屬性的方法。在運行時， PropertyPlaceholderConfigurer 就會用于元數據并為數據源替換一些屬性。指定替換的值作為${屬性-名}形式中的占位符，這里應用了 Ant/log4j/JSP EL 的風格。 ``` <bean class="org.springframework.beans.factory.config.PropertyPlaceho lderConfigurer"> <property name="locations" value="classpath:com/foo/jdbc.properties"/> </bean> <bean id="dataSource" destroy-method="close" class="org.apache.commons.dbcp.BasicDataSource"> <property name="driverClassName" value="${jdbc.driverClassName}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </bean> ``` 而真正的值是來自于標準的 Java Properties 格式的文件： ``` jdbc.driverClassName=org.hsqldb.jdbcDriver jdbc.url=jdbc:hsqldb:hsql://production:9002 jdbc.username=sa jdbc.password=root ``` 因此，字符串${jdbc.username}在運行時會被值’sa’替換，對于其它占位符來說也是相同的，匹配到了屬性文件中的鍵就會用其值替換占位符。 PropertyPlaceholderConfigurer 在很多 bean 定義的屬性中檢查占位符。此外，對占位符可以自定義前綴和后綴。使用 Spring 2.5 引入的 context 命名空間，也可以使用專用的配置元素來配置屬性占位符。在 location 屬性中，可以提供一個或多個以逗號分隔的列表。 ``` <context:property-placeholder location="classpath:com/foo/jdbc.properties"/> ``` PropertyPlaceholderConfigurer 不僅僅查看在 Properties 文件中指定的屬性。默認情況下，如果它不能在指定的屬性文件中發現屬性，它也會檢查 Java System 屬性。你可以通過設置 systemPropertiesMode 屬性，使用下面整數的三者之一來自定義這種行為： never(0)：從不檢查系統屬性 fallback(1)：如果沒有在指定的屬性文件中解析到屬性，那么就檢查系統屬性。這是默認的情況。 override(2)：在檢查指定的屬性文件之前，首先去檢查系統屬性。這就允許系統屬性覆蓋其它任意的屬性資源。查看 PropertyPlaceholderConfigurer 的 JavaDoc 文檔來獲取更多信息。類名替換你可以使用 PropertyPlaceholderConfigurer 來替換類名，在運行時，當你不得不去選擇一個特定的實現類時，這是很有用的。比如： ``` <bean class="org.springframework.beans.factory.config.PropertyPlac eholderConfigurer"> <property name="locations"> <value>classpath:com/foo/strategy.properties< /value> </property> <property name="properties"> <value>custom.strategy.class=com.foo.DefaultStrategy< / value> </property> </bean> <bean id="serviceStrategy" class="${custom.strategy.class}"/> ``` 如果類在運行時不能解析成一個有效的類，那么在即將創建時，bean 的解析就失敗了，這是 ApplicationContext 在對非延遲初始化 bean 的 preInstantiateSingletons()階段發生的。 #### 4.8.2.2 示例：PropertyOverrideConfigurer PropertyOverrideConfigurer ，另外一種 bean 工廠后處理器，類似于 PropertyPlaceholderConfigurer，但不像后者，對于所有 bean 的屬性，原始定義可以有默認值或沒有值。如果一個 Properties 覆蓋文件沒有特定 bean 的屬性配置項，那么就會使用默認的上下文定義。注意，bean 定義是不知道被覆蓋的，所以從 XML 定義文件中不能立即明顯反應覆蓋配置。在多個 PropertyOverrideConfigurer 實例的情況下，為相同 bean 的屬性定義不同的值，那么最后一個有效，這就是覆蓋機制。屬性文件配置行像這種格式： ``` beanName.property=value ``` 比如： ``` dataSource.driverClassName=com.mysql.jdbc.Driver dataSource.url=jdbc:mysql:mydb ``` 這個示例文件可以用于包含了 dataSource bean 的容器，它有 driver 和 url 屬性。復合屬性名也是支持的，除了最終的屬性被覆蓋，只要路徑中的每個組件都是非空的（假設由構造方法初始化）。在這個例子中... ``` foo.fred.bob.sammy=123 ``` ...foo bean 的 fred 屬性的 bob 屬性的 sammy 屬性的值設置為標量 123。注意指定的覆蓋值通常是文字值；它們不會被翻譯成 bean 的引用。當 XML 中的 bean 定義的原始值指定了 bean 引用時，這個約定也適用。使用 Spring 2.5 引入的 context 命名空間，可以使用專用的配置元素來配置屬性覆蓋： ``` <context:property-override location="classpath:override.properties"/> ``` ### 4.8.3 使用 FactoryBean 來自定義實例化邏輯實現了 org.springframework.beans.factory.FactoryBean 接口的對象它們就是自己的工廠。 FactoryBean 接口就是 Spring IoC 容器實例化邏輯的可插拔點。如果你的初始化代碼很復雜，那么相對于（潛在地）大量詳細的 XML 而言，最好是使用 Java 語言來表達。你可以創建自己的 FactoryBean ，在類中編寫復雜的初始化代碼，之后將你自定義的 FactoryBean 插入到容器中。 FactoryBean 接口提供下面三個方法： Object getObject()：返回工廠創建對象的實例。這個實例可能被共享，那就是看這個工廠返回的是單例還是原型實例了。 boolean isSingleton()：如果 FactoryBean 返回單例的實例，那么該方法返回 true，否則就返回 false。 Class getObjectType()：返回由 getObject()方法返回的對象類型，或者事先不知道類型時返回 null。 FactoryBean 的概念和接口被用于 Spring Framework 中的很多地方；隨 Spring 發行，有超過 50 個 FactoryBean 接口的實現類。當你需要向容器請求一個真實的 FactoryBean 實例，而不是它生產的 bean，當調用 ApplicationContext 的 getBean()方法時，在 bean 的 id 之前要有連字符（&）。所以對于一個給定 id 為 myBean 的 FactoryBean，調用容器的 getBean("myBean")方法返回的 FactoryBean 產品；而調用 getBean("&myBean")方法則返回 FactoryBean 實例本身。