论坛首页 Java企业应用论坛

spring2.5注解驱动(二)

浏览 12532 次
精华帖 (3) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
作者 正文
   发表时间:2008-09-19  

 

Java代码
  1. package com.baobaotao;      
  2.      
  3. import javax.annotation.Resource;      
  4. import javax.annotation.PostConstruct;      
  5. import javax.annotation.PreDestroy;      
  6.      
  7. public class Boss {      
  8.     @Resource     
  9.     private Car car;      
  10.      
  11.     @Resource(name = "office")      
  12.     private Office office;      
  13.      
  14.     @PostConstruct     
  15.     public void postConstruct1(){      
  16.         System.out.println("postConstruct1");      
  17.     }      
  18.      
  19.     @PreDestroy     
  20.     public void preDestroy1(){      
  21.         System.out.println("preDestroy1");       
  22.     }      
  23.     …      
  24. }    


您只需要在方法前标注 @PostConstruct 或 @PreDestroy,这些方法就会在 Bean 初始化后或销毁之前被 Spring 容器执行了。

我们知道,不管是通过实现 InitializingBean/DisposableBean 接口,还是通过 <bean> 元素的 init-method/destroy-method 属性进行配置,都只能为 Bean 指定一个初始化 / 销毁的方法。但是使用 @PostConstruct 和 @PreDestroy 注释却可以指定多个初始化 / 销毁方法,那些被标注 @PostConstruct 或 @PreDestroy 注释的方法都会在初始化 / 销毁时被执行。

通过以下的测试代码,您将可以看到 Bean 的初始化 / 销毁方法是如何被执行的:


清单 18. 测试类代码

Java代码
  1. package com.baobaotao;      
  2.      
  3. import org.springframework.context.support.ClassPathXmlApplicationContext;      
  4.      
  5. public class AnnoIoCTest {      
  6.      
  7.     public static void main(String[] args) {      
  8.         String[] locations = {"beans.xml"};      
  9.         ClassPathXmlApplicationContext ctx =       
  10.             new ClassPathXmlApplicationContext(locations);      
  11.         Boss boss = (Boss) ctx.getBean("boss");      
  12.         System.out.println(boss);      
  13.         ctx.destroy();// 关闭 Spring 容器,以触发 Bean 销毁方法的执行      
  14.     }      
  15. }    


这时,您将看到标注了 @PostConstruct 的 postConstruct1() 方法将在 Spring 容器启动时,创建 Boss Bean 的时候被触发执行,而标注了 @PreDestroy 注释的 preDestroy1() 方法将在 Spring 容器关闭前销毁 Boss Bean 的时候被触发执行。





使用 <context:annotation-config/> 简化配置

Spring 2.1 添加了一个新的 context 的 Schema 命名空间,该命名空间对注释驱动、属性文件引入、加载期织入等功能提供了便捷的配置。我们知道注释本身是不会做任何事情的,它仅提供元数据信息。要使元数据信息真正起作用,必须让负责处理这些元数据的处理器工作起来。

而我们前面所介绍的 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor 就是处理这些注释元数据的处理器。但是直接在 Spring 配置文件中定义这些 Bean 显得比较笨拙。Spring 为我们提供了一种方便的注册这些 BeanPostProcessor 的方式,这就是 <context:annotation-config/>。请看下面的配置:


清单 19. 调整 beans.xml 配置文件

Java代码
  1. <?xml version="1.0" encoding="UTF-8" ?>     
  2. <beans xmlns="http://www.springframework.org/schema/beans"     
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     
  4.      xmlns:context="http://www.springframework.org/schema/context"     
  5.      xsi:schemaLocation="http://www.springframework.org/schema/beans       
  6.  http://www.springframework.org/schema/beans/spring-beans-2.5.xsd      
  7.  http://www.springframework.org/schema/context       
  8.  http://www.springframework.org/schema/context/spring-context-2.5.xsd">     
  9.        
  10.     <context:annotation-config/>       
  11.      
  12.     <bean id="boss" class="com.baobaotao.Boss"/>     
  13.     <bean id="office" class="com.baobaotao.Office">     
  14.         <property name="officeNo" value="001"/>     
  15.     </bean>     
  16.     <bean id="car" class="com.baobaotao.Car" scope="singleton">     
  17.         <property name="brand" value=" 红旗 CA72"/>     
  18.         <property name="price" value="2000"/>     
  19.     </bean>     
  20. </beans>    


<context:annotationconfig/> 将隐式地向 Spring 容器注册 AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor、PersistenceAnnotationBeanPostProcessor 以及 equiredAnnotationBeanPostProcessor 这 4 个 BeanPostProcessor。

在配置文件中使用 context 命名空间之前,必须在 <beans> 元素中声明 context 命名空间。





使用 @Component

虽然我们可以通过 @Autowired 或 @Resource 在 Bean 类中使用自动注入功能,但是 Bean 还是在 XML 文件中通过 <bean> 进行定义 —— 也就是说,在 XML 配置文件中定义 Bean,通过 @Autowired 或 @Resource 为 Bean 的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注释定义 Bean,从 XML 配置文件中完全移除 Bean 定义的配置呢?答案是肯定的,我们通过 Spring 2.5 提供的 @Component 注释就可以达到这个目标了。

下面,我们完全使用注释定义 Bean 并完成 Bean 之间装配:


清单 20. 使用 @Component 注释的 Car.java

Java代码
  1. package com.baobaotao;      
  2.      
  3. import org.springframework.stereotype.Component;      
  4.      
  5. @Component     
  6. public class Car {      
  7.     …      
  8. }    


仅需要在类定义处,使用 @Component 注释就可以将一个类定义了 Spring 容器中的 Bean。下面的代码将 Office 定义为一个 Bean:


清单 21. 使用 @Component 注释的 Office.java

Java代码
  1. package com.baobaotao;      
  2.      
  3. import org.springframework.stereotype.Component;      
  4.      
  5. @Component     
  6. public class Office {      
  7.     private String officeNo = "001";      
  8.     …      
  9. }     


这样,我们就可以在 Boss 类中通过 @Autowired 注入前面定义的 Car 和 Office Bean 了。


清单 22. 使用 @Component 注释的 Boss.java

Java代码
  1. package com.baobaotao;      
  2.      
  3. import org.springframework.beans.factory.annotation.Autowired;      
  4. import org.springframework.beans.factory.annotation.Required;      
  5. import org.springframework.beans.factory.annotation.Qualifier;      
  6. import org.springframework.stereotype.Component;      
  7.      
  8. @Component("boss")      
  9. public class Boss {      
  10.     @Autowired     
  11.     private Car car;      
  12.      
  13.     @Autowired     
  14.     private Office office;      
  15.     …      
  16. }    


@Component 有一个可选的入参,用于指定 Bean 的名称,在 Boss 中,我们就将 Bean 名称定义为“boss”。一般情况下,Bean 都是 singleton 的,需要注入 Bean 的地方仅需要通过 byType 策略就可以自动注入了,所以大可不必指定 Bean 的名称。

在使用 @Component 注释后,Spring 容器必须启用类扫描机制以启用注释驱动 Bean 定义和注释驱动 Bean 自动注入的策略。Spring 2.5 对 context 命名空间进行了扩展,提供了这一功能,请看下面的配置:


清单 23. 简化版的 beans.xml

Java代码
  1. <?xml version="1.0" encoding="UTF-8" ?>     
  2. <beans xmlns="http://www.springframework.org/schema/beans"     
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     
  4.     xmlns:context="http://www.springframework.org/schema/context"     
  5.     xsi:schemaLocation="http://www.springframework.org/schema/beans       
  6.  http://www.springframework.org/schema/beans/spring-beans-2.5.xsd      
  7.  http://www.springframework.org/schema/context       
  8.  http://www.springframework.org/schema/context/spring-context-2.5.xsd">     
  9.     <context:component-scan base-package="com.baobaotao"/>     
  10. </beans>    


这里,所有通过 <bean> 元素定义 Bean 的配置内容已经被移除,仅需要添加一行 <context:component-scan/> 配置就解决所有问题了——Spring XML 配置文件得到了极致的简化(当然配置元数据还是需要的,只不过以注释形式存在罢了)。<context:component-scan/> 的 base-package 属性指定了需要扫描的类包,类包及其递归子包中所有的类都会被处理。

<context:component-scan/> 还允许定义过滤器将基包下的某些类纳入或排除。Spring 支持以下 4 种类型的过滤方式,通过下表说明:


表 1. 扫描过滤方式
过滤器类型 说明
注释 假如 com.baobaotao.SomeAnnotation 是一个注释类,我们可以将使用该注释的类过滤出来。
类名指定 通过全限定类名进行过滤,如您可以指定将 com.baobaotao.Boss 纳入扫描,而将 com.baobaotao.Car 排除在外。
正则表达式 通过正则表达式定义过滤的类,如下所示: com\.baobaotao\.Default.*
AspectJ 表达式 通过 AspectJ 表达式定义过滤的类,如下所示: com. baobaotao..*Service+

下面是一个简单的例子:

Java代码
  1. <context:component-scan base-package="com.baobaotao">     
  2.     <context:include-filter type="regex"       
  3.         expression="com\.baobaotao\.service\..*"/>     
  4.     <context:exclude-filter type="aspectj"       
  5.         expression="com.baobaotao.util..*"/>     
  6. </context:component-scan>    


值得注意的是 <context:component-scan/> 配置项不但启用了对类包进行扫描以实施注释驱动 Bean 定义的功能,同时还启用了注释驱动自动注入的功能(即还隐式地在内部注册了 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor),因此当使用 <context:component-scan/> 后,就可以将 <context:annotation-config/> 移除了。

默认情况下通过 @Component 定义的 Bean 都是 singleton 的,如果需要使用其它作用范围的 Bean,可以通过 @Scope 注释来达到目标,如以下代码所示:


清单 24. 通过 @Scope 指定 Bean 的作用范围

Java代码
  1. package com.baobaotao;      
  2. import org.springframework.context.annotation.Scope;      
  3. …      
  4. @Scope("prototype")      
  5. @Component("boss")      
  6. public class Boss {      
  7.     …      
  8. }     


这样,当从 Spring 容器中获取 boss Bean 时,每次返回的都是新的实例了。
采用具有特殊语义的注释

Spring 2.5 中除了提供 @Component 注释外,还定义了几个拥有特殊语义的注释,它们分别是:@Repository、@Service 和 @Controller。在目前的 Spring 版本中,这 3 个注释和 @Component 是等效的,但是从注释类的命名上,很容易看出这 3 个注释分别和持久层、业务层和控制层(Web 层)相对应。虽然目前这 3 个注释和 @Component 相比没有什么新意,但 Spring 将在以后的版本中为它们添加特殊的功能。所以,如果 Web 应用程序采用了经典的三层分层结构的话,最好在持久层、业务层和控制层分别采用 @Repository、@Service 和 @Controller 对分层中的类进行注释,而用 @Component 对那些比较中立的类进行注释。


注释配置和 XML 配置的适用场合

是否有了这些 IOC 注释,我们就可以完全摒除原来 XML 配置的方式呢?答案是否定的。有以下几点原因:

注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的,(如 Service 使用了哪几个 DAO 类),这种配置信息不会在部署时发生调整,那么注释配置优于 XML 配置;反之如果这种依赖关系会在部署时发生调整,XML 配置显然又优于注释配置,因为注释是对 Java 源代码的调整,您需要重新改写源代码并重新编译才可以实施调整。
如果 Bean 不是自己编写的类(如 JdbcTemplate、SessionFactoryBean 等),注释配置将无法实施,此时 XML 配置是唯一可用的方式。
注释配置往往是类级别的,而 XML 配置则可以表现得更加灵活。比如相比于 @Transaction 事务注释,使用 aop/tx 命名空间的事务配置更加灵活和简单。
所以在实现应用中,我们往往需要同时使用注释配置和 XML 配置,对于类级别且不会发生变动的配置可以优先考虑注释配置;而对于那些第三方类以及容易发生调整的配置则应优先考虑使用 XML 配置。Spring 会在具体实施 Bean 创建和 Bean 注入之前将这两种配置方式的元信息融合在一起。

小结

Spring 在 2.1 以后对注释配置提供了强力的支持,注释配置功能成为 Spring 2.5 的最大的亮点之一。合理地使用 Spring 2.5 的注释配置,可以有效减少配置的工作量,提高程序的内聚性。但是这并不意味着传统 XML 配置将走向消亡,在第三方类 Bean 的配置,以及那些诸如数据源、缓存池、持久层操作模板类、事务管理等内容的配置上,XML 配置依然拥有不可替代的地位。

   发表时间:2008-09-20  
很好!

那些经常抱怨spring配置麻烦的人应该更新一下知识了。
0 请登录后投票
   发表时间:2008-10-25  
写的很不错,思路很清晰,很容易让人理解.
谢谢分享!
0 请登录后投票
   发表时间:2008-11-26  
不错不错,思路很清晰,spring2.5 很好,很强大!
0 请登录后投票
   发表时间:2008-11-26  
不错不错,思路很清晰!
0 请登录后投票
   发表时间:2009-04-09  
http://www.ibm.com/developerworks/cn/java/j-lo-spring25-ioc/
不知道谁抄袭谁的
0 请登录后投票
论坛首页 Java企业应用版

跳转论坛:
Global site tag (gtag.js) - Google Analytics