理解 @Configuration 和 @Bean 註釋
使用 AnnotationConfigApplicationContext 註冊配置類
配置 Web 應用程序
實現 bean 生命周期回調和範圍
我們將使用壹所在線大學的 “創建課程” 用例。在創建課程的過程中，還會創建主題或者模塊，而各主題可能又有著不同的作業。因此，我們要創建三個 bean，分別為 Course、Module 和 Assignment。Course bean 將包含壹個對 Module bean 的引用，後者包含對 Assignment bean 的引用。
理解 @Configuration 和 @Bean 註釋
在理想的場景中，您可以在表示應用程序上下文的 XML 中定義 bean。以下代碼展示了創建課程 用例中的上下文 XML 及 bean 定義：
清單 1. XML 與 bean 定義
<beans>
<bean id="course" class="demo.Course">
<property name="module" ref="module"/>
</bean>
<bean id="module" class="demo.Module">
<property name="assignment" ref="assignment"/>
</bean>
<bean id="assignment" class="demo.Assignment" />
</beans>
以上 XML 就是您在使用 Spring 配置 bean 時通常會編寫的代碼。這段 XML 代碼定義了 Course bean，它引用 Module bean。Module bean 有壹個 Assignment bean 的引用。您現在要刪除這段 XML，編寫同等效果的 Java 代碼。您將使用基於 Java 的配置定義上面指定的 bean。我們會將 XML 替換為 Java 類，這個 Java 類現在將用作 bean 配置的平臺。我們將這個類命名為 AppContext.java。以下代碼展示了 AppContext類。
清單 2. 包含 bean 定義的 AppContext 配置類
@Configuration
public class AppContext {
@Bean
public Course course() {
Course course = new Course();
course.setModule(module());
return course;
}
@Bean
public Module module() {
Module module = new Module();
module.setAssignment(assignment());
return module;
}
@Bean
public Assignment assignment() {
return new Assignment();
}
}
正如您通過以上代碼所看到的那樣，現在可以以編程的方式將 bean 定義為基於 Java 的配置的壹部分。AppContext 類現在就像 XML 壹樣表示配置類。這是通過利用 @Configuration 註釋實現的。@Configuration 註釋位於類的頂端。它告知 Spring 容器這個類是壹個擁有 bean 定義和依賴項的配置類。@Bean 註釋用於定義 bean。上述註釋位於實例化 bean 並設置依賴項的方法上方。方法名稱與 bean id 或默認名稱相同。該方法的返回類型是向 Spring 應用程序上下文註冊的 bean。您可使用 bean 的 setter 方法來設置依賴項，容器將調用它們來連接相關項。基於 Java 的配置也被視為基於註釋的配置。
使用 AnnotationConfigApplicationContext 註冊配置類
在傳統 XML 方法中，您可使用 ClassPathXmlApplicationContext 類來加載外部 XML 上下文文件。但在使用基於 Java 的配置時，有壹個AnnotationConfigApplicationContext 類。AnnotationConfigApplicationContext 類是 ApplicationContext 接口的壹個實現，使您能夠註冊所註釋的配置類。此處的配置類是使用 @Configuration 註釋聲明的 AppContext。在註冊了所述類之後，@Bean 註釋的方法返回的所有 bean 類型也會得到註冊。以下代碼演示了 AnnotationConfigApplicationContext 類的使用：
清單 3. 使用 AnnotationConfigApplicationContext 註冊 AppContext 類
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(AppContext.class);
Course course = ctx.getBean(Course.class);
course.getName();
}
正如以上代碼所示，AppContext 配置類的註冊方式是將其傳遞給 AnnotationConfigApplicationContext 構造函數。此外，您還可以使用所述上下文類的 register 方法來註冊配置類。以下代碼展示了另外壹種方法。
清單 4. 註冊 AppContext 類：另外壹種方法
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(AppContext.class)
}
註冊配置類將自動註冊 @Bean 註釋的方法名稱，因而其對應的 bean 就是 Course、Module 和 Assignment。隨後您可以使用 getBean 方法來獲取相關的 bean，並調用其業務方法。如您所見，編寫 Java 的配置類並將其註冊到 Spring 上下文非常簡單。下壹節將討論如何將基於 Java 的配置與 Web 應用程序配合使用。
配置 Web 應用程序
過去，您通常要利用 XmlWebApplicationContext 上下文來配置 Spring Web 應用程序，即在 Web 部署描述符文件 web.xml 中指定外部 XML 上下文文件的路徑。XMLWebApplicationContext 是 Web 應用程序使用的默認上下文類。以下代碼描述了 web.xml 中指向將由ContextLoaderListener 監聽器類載入的外部 XML 上下文文件的元素。
清單 5. 使用外部 XML 上下文文件的 web.xml
<web-app>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<servlet>
<servlet-name>sampleServlet</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
</servlet>
...
</web-app>
現在，您要將 web.xml 中的上述代碼更改為使用 AnnotationConfigApplicationContext 類。切記，XmlWebApplicationContext 是 Spring 為 Web 應用程序使用的默認上下文實現，因此您永遠不必在您的 web.xml 文件中顯式指定這個上下文類。現在，您將使用基於 Java 的配置，因此在配置 Web 應用程序時，需要在 web.xml 文件中指定 AnnotationConfigApplicationContext 類。上述代碼將修改如下：
清單 6. 修改後的使用 AnnotationConfigApplicationContext 的 web.xml
<web-app>
<context-param>
<param-name>contextClass</param-name>
<param-value>
org.springframework.web.context.
support.AnnotationConfigWebApplicationContext
</param-value>
</context-param>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
demo.AppContext
</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<servlet>
<servlet-name>sampleServlet</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<init-param>
<param-name>contextClass</param-name>
<param-value>
org.springframework.web.context.
support.AnnotationConfigWebApplicationContext
</param-value>
</init-param>
</servlet>
...
</web-app>
以上修改後的 web.xml 現在定義了 AnnotationConfigWebApplicationContext 上下文類，並將其作為上下文參數和 servlet 元素的壹部分。上下文配置位置現在指向 AppContext 配置類。這非常簡單。下壹節將演示 bean 的生命周期回調和範圍的實現。
實現 bean 生命周期回調和範圍
生命周期回調
您還可以使用基於 Java 的配置來管理 bean 的生命周期。@Bean 支持兩種屬性，即 initMethod 和 destroyMethod，這些屬性可用於定義生命周期方法。在實例化 bean 或即將銷毀它時，容器便可調用生命周期方法。生命周期方法也稱為回調方法，因為它將由容器調用。使用 @Bean註釋註冊的 bean 也支持 JSR-250 規定的標準 @PostConstruct 和 @PreDestroy 註釋。如果您正在使用 XML 方法來定義 bean，那麽就應該使用 bean 元素來定義生命周期回調方法。以下代碼顯示了在 XML 配置中通常使用 bean 元素定義回調的方法。
清單 7. 使用 XML 方法實現生命周期回調
<bean id="course" class="demo.Course" init-method="setup" destroy-method="cleanup" >
<property name="module" ref="module"/>
</bean>
以下代碼演示了使用 Java 配置的生命周期方法
清單 8. 使用 AppContext 配置類實現 bean 生命周期方法
@Configuration
public class AppContext {
@Bean(initMethod = "setup", destroyMethod = "cleanup")
public Course course() {
Course course = new Course();
course.setModule(module());
return course;
}
@Bean(initMethod = "setup", destroyMethod = "cleanup")
public Module module() {
Module module = new Module();
module.setAssignment(assignment());
return module;
}
...
}
public class Course {
private Module module;
private String name;
public Course() {
}
public void setup() {
this.name = "M100 Pythagoras Theorems"
}
public void setModule(Module module) {
this.module = module;
}
public void cleanup() {
module = null;
}
}
上面的代碼重新訪問了 AppContext 配置類。@Bean 註釋現在有兩個額外的屬性，即 initMethod 和 destroyMethod。它們定義了生命周期方法的設置和清除。這些方法是在已經註冊的 bean 中實現的，最終由容器在 bean 初始化及其銷毀之前調用它。這裏以 Course bean 為例，提供了生命周期方法實現。所實現的方法是 setup 和 cleanup。同樣，您還可以在 Module 和 Assignment bean 中實現這些方法。
Bean 範圍
bean 的方法是使用 @Scope 註釋定義的。XML 中實現這壹目標的方法是指定 bean 元素中的 scope 屬性。
清單 9. 使用 XML 方法定義 bean 範圍
<bean id="course" class="demo.Course" scope="prototype" >
<property name="module" ref="module"/>
</bean>
以下代碼展示了使用 Java 配置的 bean 範圍定義：
清單 10. 使用 AppContext 配置類定義 bean 範圍
@Configuration
public class AppContext {
@Bean(initMethod = "setup", destroyMethod = "cleanup")
@Scope("prototype")
public Course course() {
Course course = new Course();
course.setModule(module());
return course;
}
...
}
正如您在上面的代碼中所看到的那樣，在 Java 配置類中定義 bean 的範圍非常簡單。上面的 AppContext 配置類使用 @Scope 註釋為 Coursebean 定義了壹個 prototype 範圍。默認範圍是 singleton。
利用 Java 配置可以做許多事情。本文只觸及了壹些基礎內容。使用 Java 配置並無顯著優勢，它僅僅是 Spring 提供的 XML 配置的替代方法。對於不喜歡在框架中使用 XML 的人來說，這是實現配置的壹種出色方法。但缺點也是顯而易見的，如果您對 Java 類中的配置做出了任何更改，就必須重新編譯應用程序。
/webservices/ws-springjava/