Spring之注解详解
概述
注释配置相对于XML配置具有很多的优势：
它可以充分利用Java的反射机制获取类结构信息，这些信息可以有效减少配置的工作。如使用JPA注释配置ORM映射时，我们就不需要指定PO的属性名、类型等信息，如果关系表字段和PO属性名、类型都一致，您甚至无需编写任务属性映射信息——因为这些信息都可以通过Java反射机制获取。
注释和Java代码位于一个文件中，而XML配置采用独立的配置文件，大多数配置信息在程序开发完成后都不会调整，如果配置信息和Java代码放在一起，有助于增强程序的内聚性。而采用独立的XML配置文件，程序员在编写一个功能时，往往需要在程序文件和配置文件中不停切换，这种思维上的不连贯会降低开发效率。
因此在很多情况下，注释配置比XML配置更受欢迎，注释配置有进一步流行的趋势。Spring2.5的一大增强就是引入了很多注释类，现在您已经可以使用注释配置完成大部分XML配置的功能。在这篇文章里，我们将向您讲述使用注释进行Bean定义和依赖注入的内容。
原来我们是怎么做的
在使用注释配置之前，先来回顾一下传统上是如何配置Bean并完成Bean之间依赖关系的建立。下面是3个类，它们分别是Office、Car和Boss，这3个类需要在Spring容器中配置为Bean：
Office仅有一个属性：
清单1.Office.java
packagecom.baobaotao;
publicclassOffice{
privateStringofficeNo=”001”;
//省略get/setter
@Override
publicStringtoString(){
return"officeNo:"+officeNo;
}
}
Car拥有两个属性：
清单2.Car.java
packagecom.baobaotao;
publicclassCar{
privateStringbrand;
privatedoubleprice;
//省略get/setter
@Override
publicStringtoString(){
return"brand:"+brand+","+"price:"+price;
}
}
Boss拥有Office和Car类型的两个属性：
清单3.Boss.java
packagecom.baobaotao;
publicclassBoss{
privateCarcar;
privateOfficeoffice;
//省略get/setter
@Override
publicStringtoString(){
return"car:"+car+"\n"+"office:"+office;
}
}
我们在Spring容器中将Office和Car声明为Bean，并注入到BossBean中：下面是使用传统XML完成这个工作的配置文件beans.xml：
清单4.beans.xml将以上三个类配置成Bean
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
当我们运行以下代码时，控制台将正确打出boss的信息：
清单5.测试类：AnnoIoCTest.java
importorg.springframework.context.ApplicationContext;
importorg.springframework.context.support.ClassPathXmlApplicationContext;
publicclassAnnoIoCTest{
publicstaticvoidmain(String[]args){
String[]locations={"beans.xml"};
ApplicationContextctx=
newClassPathXmlApplicationContext(locations);
Bossboss=(Boss)ctx.getBean("boss");
System.out.println(boss);
}
}
这说明Spring容器已经正确完成了Bean创建和装配的工作。
使用@Autowired注释
Spring2.5引入了@Autowired注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。来看一下使用@Autowired进行成员变量自动注入的代码：
清单6.使用@Autowired注释的Boss.java
packagecom.baobaotao;
importorg.springframework.beans.factory.annotation.Autowired;
publicclassBoss{
@Autowired
privateCarcar;
@Autowired
privateOfficeoffice;
…
}
Spring通过一个BeanPostProcessor对@Autowired进行解析，所以要让@Autowired起作用必须事先在Spring容器中声明AutowiredAnnotationBeanPostProcessorBean。
清单7.让@Autowired注释工作起来
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
这样，当Spring容器启动时，AutowiredAnnotationBeanPostProcessor将扫描Spring容器中所有Bean，当发现Bean中拥有@Autowired注释时就找到和其匹配（默认按类型匹配）的Bean，并注入到对应的地方中去。
按照上面的配置，Spring将直接采用Java反射机制对Boss中的car和office这两个私有成员变量进行自动注入。所以对成员变量使用@Autowired后，您大可将它们的setter方法（setCar()和setOffice()）从Boss中删除。
当然，您也可以通过@Autowired对方法或构造函数进行标注，来看下面的代码：
清单8.将@Autowired注释标注在Setter方法上
packagecom.baobaotao;
publicclassBoss{
privateCarcar;
privateOfficeoffice;
@Autowired
publicvoidsetCar(Carcar){
this.car=car;
}
@Autowired
publicvoidsetOffice(Officeoffice){
this.office=office;
}
…
}
这时，@Autowired将查找被标注的方法的入参类型的Bean，并调用方法自动注入这些Bean。而下面的使用方法则对构造函数进行标注：
清单9.将@Autowired注释标注在构造函数上
packagecom.baobaotao;
publicclassBoss{
privateCarcar;
privateOfficeoffice;
@Autowired
publicBoss(Carcar,Officeoffice){
this.car=car;
this.office=office;
}
…
}
由于Boss()构造函数有两个入参，分别是car和office，@Autowired将分别寻找和它们类型匹配的Bean，将它们作为Boss(Carcar,Officeoffice)的入参来创建BossBean。
当候选Bean数目不为1时的应对方法
在默认情况下使用@Autowired注释进行自动注入时，Spring容器中匹配的候选Bean数目必须有且仅有一个。当找不到一个匹配的Bean时，Spring容器将抛出BeanCreationException异常，并指出必须至少拥有一个匹配的Bean。我们可以来做一个实验：
清单10.候选Bean数目为0时
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=springframewww.wang027.comwork.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
由于officeBean被注释掉了，所以Spring容器中将没有类型为Office的Bean了，而Boss的office属性标注了@Autowired，当启动Spring容器时，异常就产生了。
当不能确定Spring容器中一定拥有某个类的Bean时，可以在需要自动注入该类Bean的地方可以使用@Autowired(required=false)，这等于告诉Spring：在找不到匹配Bean时也不报错。来看一下具体的例子：
清单11.使用@Autowired(required=false)
packagecom.baobaotao;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.beans.factory.annotation.Required;
publicclassBoss{
privateCarcar;
privateOfficeoffice;
@Autowired
publicvoidsetCar(Carcar){
this.car=car;
}
@Autowired(required=false)
publicvoidsetOffice(Officeoffice){
this.office=office;
}
…
}
当然，一般情况下，使用@Autowired的地方都是需要注入Bean的，使用了自动注入而又允许不注入的情况一般仅会在开发期或测试期碰到（如为了快速启动Spring容器，仅引入一些模块的Spring配置文件），所以@Autowired(required=false)会很少用到。
和找不到一个类型匹配Bean相反的一个错误是：如果Spring容器中拥有多个候选Bean，Spring容器在启动时也会抛出BeanCreationException异常。来看下面的例子：
清单12.在beans.xml中配置两个Office类型的Bean
…
…
我们在Spring容器中配置了两个类型为Office类型的Bean，当对Boss的office成员变量进行自动注入时，Spring容器将无法确定到底要用哪一个Bean，因此异常发生了。
Spring允许我们通过@Qualifier注释指定注入Bean的名称，这样歧义就消除了，可以通过下面的方法解决异常：
清单13.使用@Qualifier注释指定注入Bean的名称
@Autowired
publicvoidsetOffice(@Qualifier("office")Officeoffice){
this.office=office;
}
@Qualifier("office")中的office是Bean的名称，所以@Autowired和@Qualifier结合使用时，自动注入的策略就从byType转变成byName了。@Autowired可以对成员变量、方法以及构造函数进行注释，而@Qualifier的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同，所以Spring不将@Autowired和@Qualifier统一成一个注释类。下面是对成员变量和构造函数入参进行注释的代码：
对成员变量进行注释：
清单14.对成员变量使用@Qualifier注释
publicclassBoss{
@Autowired
privateCarcar;
@Autowired
@Qualifier("office")
privateOfficeoffice;
…
}
对构造函数入参进行注释：
清单15.对构造函数变量使用@Qualifier注释
publicclassBoss{
privateCarcar;
privateOfficeoffice;
@Autowired
publicBoss(Carcar,@Qualifier("office")Officeoffice){
this.car=car;
this.office=office;
}
}
@Qualifier只能和@Autowired结合使用，是对@Autowired有益的补充。一般来讲，@Qualifier对方法签名中入参进行注释会降低代码的可读性，而对成员变量注释则相对好一些。
使用JSR-250的注释
Spring不但支持自己定义的@Autowired的注释，还支持几个由JSR-250规范定义的注释，它们分别是@Resource、@PostConstruct以及@PreDestroy。
@Resource
@Resource的作用相当于@Autowired，只不过@Autowired按byType自动注入，面@Resource默认按byName自动注入罢了。@Resource有两个属性是比较重要的，分别是name和type，Spring将@Resource注释的name属性解析为Bean的名字，而type属性则解析为Bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。
Resource注释类位于Spring发布包的lib/j2ee/common-annotations.jar类包中，因此在使用之前必须将其加入到项目的类库中。来看一个使用@Resource的例子：
清单16.使用@Resource注释的Boss.java
packagecom.baobaotao;
importjavax.annotation.Resource;
publicclassBoss{
//自动注入类型为Car的Bean
@Resource
privateCarcar;
//自动注入bean名称为office的Bean
@Resource(name="office")
privateOfficeoffice;
}
一般情况下，我们无需使用类似于@Resource(type=Car.class)的注释方式，因为Bean的类型信息可以通过Java反射从代码中获取。
要让JSR-250的注释生效，除了在Bean类中标注这些注释外，还需要在Spring容器中注册一个负责处理这些注释的BeanPostProcessor：
class="org.springframework.context.annotation.CommonAnnotationBeanPostProcessor"/>
CommonAnnotationBeanPostProcessor实现了BeanPostProcessor接口，它负责扫描使用了JSR-250注释的Bean，并对它们进行相应的操作。
@PostConstruct和@PreDestroy
Spring容器中的Bean是有生命周期的，Spring允许在Bean在初始化完成后以及Bean销毁前执行特定的操作，您既可以通过实现InitializingBean/DisposableBean接口来定制初始化之后/销毁之前的操作方法，也可以通过元素的init-method/destroy-method属性指定初始化之后/销毁之前调用的操作方法。关于Spring的生命周期，笔者在《精通Spring2.x—企业应用开发精解》第3章进行了详细的描述，有兴趣的读者可以查阅。
JSR-250为初始化之后/销毁之前方法的指定定义了两个注释类，分别是@PostConstruct和@PreDestroy，这两个注释只能应用于方法上。标注了@PostConstruct注释的方法将在类实例化后调用，而标注了@PreDestroy的方法将在类销毁之前调用。
清单17.使用@PostConstruct和@PreDestroy注释的Boss.java
packagecom.baobaotao;
importjavax.annotation.Resource;
importjavax.annotation.PostConstruct;
importjavax.annotation.PreDestroy;
publicclassBoss{
@Resource
privateCarcar;
@Resource(name="office")
privateOfficeoffice;
@PostConstruct
publicvoidpostConstruct1(){
System.out.println("postConstruct1");
}
@PreDestroy
publicvoidpreDestroy1(){
System.out.println("preDestroy1");
}
…
}
您只需要在方法前标注@PostConstruct或@PreDestroy，这些方法就会在Bean初始化后或销毁之前被Spring容器执行了。
我们知道，不管是通过实现InitializingBean/DisposableBean接口，还是通过元素的init-method/destroy-method属性进行配置，都只能为Bean指定一个初始化/销毁的方法。但是使用@PostConstruct和@PreDestroy注释却可以指定多个初始化/销毁方法，那些被标注@PostConstruct或@PreDestroy注释的方法都会在初始化/销毁时被执行。
通过以下的测试代码，您将可以看到Bean的初始化/销毁方法是如何被执行的：
清单18.测试类代码
packagecom.baobaotao;
importorg.springframework.context.support.ClassPathXmlApplicationContext;
publicclassAnnoIoCTest{
publicstaticvoidmain(String[]args){
String[]locations={"beans.xml"};
ClassPathXmlApplicationContextctx=
newClassPathXmlApplicationContext(locations);
Bossboss=(Boss)ctx.getBean("boss");
System.out.println(boss);
ctx.destroy();//关闭Spring容器，以触发Bean销毁方法的执行
}
}
这时，您将看到标注了@PostConstruct的postConstruct1()方法将在Spring容器启动时，创建BossBean的时候被触发执行，而标注了@PreDestroy注释的preDestroy1()方法将在Spring容器关闭前销毁BossBean的时候被触发执行。
使用简化配置
Spring2.1添加了一个新的context的Schema命名空间，该命名空间对注释驱动、属性文件引入、加载期织入等功能提供了便捷的配置。我们知道注释本身是不会做任何事情的，它仅提供元数据信息。要使元数据信息真正起作用，必须让负责处理这些元数据的处理器工作起来。
而我们前面所介绍的AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是处理这些注释元数据的处理器。但是直接在Spring配置文件中定义这些Bean显得比较笨拙。Spring为我们提供了一种方便的注册这些BeanPostProcessor的方式，这就是。请看下面的配置：
清单19.调整beans.xml配置文件
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-2.5.xsd">
将隐式地向Spring容器注册AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor、PersistenceAnnotationBeanPostProcessor以及equiredAnnotationBeanPostProcessor这4个BeanPostProcessor。
在配置文件中使用context命名空间之前，必须在元素中声明context命名空间。
使用@Component
虽然我们可以通过@Autowired或@Resource在Bean类中使用自动注入功能，但是Bean还是在XML文件中通过进行定义——也就是说，在XML配置文件中定义Bean，通过@Autowired或@Resource为Bean的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注释定义Bean，从XML配置文件中完全移除Bean定义的配置呢？答案是肯定的，我们通过Spring2.5提供的@Component注释就可以达到这个目标了。
为什么@Repository只能标注在DAO类上呢？这是因为该注解的作用不只是将类识别为Bean，同时它还能将所标注的类中抛出的数据访问异常封装为Spring的数据访问异常类型。Spring本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。
Spring2.5在@Repository的基础上增加了功能类似的额外三个注解：@Component、@Service、@Constroller，它们分别用于软件系统的不同层次：
@Component是一个泛化的概念，仅仅表示一个组件(Bean)，可以作用在任何层次。
@Service通常作用在业务层，但是目前该功能与@Component相同。
@Constroller通常作用在控制层，但是目前该功能与@Component相同。
通过在类上使用@Repository、@Component、@Service和@Constroller注解，Spring会自动创建相应的BeanDefinition对象，并注册到ApplicationContext中。这些类就成了Spring受管组件。这三个注解除了作用于不同软件层次的类，其使用方式与@Repository是完全相同的。
下面，我们完全使用注释定义Bean并完成Bean之间装配：
清单20.使用@Component注释的Car.java
packagecom.baobaotao;
importorg.springframework.stereotype.Component;
@Component
publicclassCar{
…
}
仅需要在类定义处，使用@Component注释就可以将一个类定义了Spring容器中的Bean。下面的代码将Office定义为一个Bean：
清单21.使用@Component注释的Office.java
packagecom.baobaotao;
importorg.springframework.stereotype.Component;
@Component
publicclassOffice{
privateStringofficeNo="001";
…
}
这样，我们就可以在Boss类中通过@Autowired注入前面定义的Car和OfficeBean了。
清单22.使用@Component注释的Boss.java
packagecom.baobaotao;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.beans.factory.annotation.Required;
importorg.springframework.beans.factory.annotation.Qualifier;
importorg.springframework.stereotype.Component;
@Component("boss")
publicclassBoss{
@Autowired
privateCarcar;
@Autowired
privateOfficeoffice;
…
}
@Component有一个可选的入参，用于指定Bean的名称，在Boss中，我们就将Bean名称定义为“boss”。一般情况下，Bean都是singleton的，需要注入Bean的地方仅需要通过byType策略就可以自动注入了，所以大可不必指定Bean的名称。
在使用@Component注释后，Spring容器必须启用类扫描机制以启用注释驱动Bean定义和注释驱动Bean自动注入的策略。Spring2.5对context命名空间进行了扩展，提供了这一功能，请看下面的配置：
清单23.简化版的beans.xml
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.baiyuewang.net/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-2.5.xsd">
这里，所有通过元素定义Bean的配置内容已经被移除，仅需要添加一行配置就解决所有问题了——SpringXML配置文件得到了极致的简化（当然配置元数据还是需要的，只不过以注释形式存在罢了）。的base-package属性指定了需要扫描的类包，类包及其递归子包中所有的类都会被处理。
还允许定义过滤器将基包下的某些类纳入或排除。Spring支持以下4种类型的过滤方式，通过下表说明：
表1.扫描过滤方式
过滤器类型 说明
注释 假如com.baobaotao.SomeAnnotation是一个注释类，我们可以将使用该注释的类过滤出来。
类名指定 通过全限定类名进行过滤，如您可以指定将com.baobaotao.Boss纳入扫描，而将com.baobaotao.Car排除在外。
正则表达式 通过正则表达式定义过滤的类，如下所示：com\.baobaotao\.Default.
AspectJ表达式 通过AspectJ表达式定义过滤的类，如下所示：com.baobaotao..Service+
下面是一个简单的例子：
expression="com\.baobaotao\.service\.."/>
expression="com.baobaotao.util.."/>
值得注意的是配置项不但启用了对类包进行扫描以实施注释驱动Bean定义的功能，同时还启用了注释驱动自动注入的功能（即还隐式地在内部注册了AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor），因此当使用后，就可以将移除了。
默认情况下通过@Component定义的Bean都是singleton的，如果需要使用其它作用范围的Bean，可以通过@Scope注释来达到目标，如以下代码所示：
@scopee
清单24.通过@Scope指定Bean的作用范围
packagecom.baobaotao;
importorg.springframework.context.annotation.Scope;
…
@Scope("prototype")
@Component("boss")
publicclassBoss{
…
}
这样，当从Spring容器中获取bossBean时，每次返回的都是新的实例了。
采用具有特殊语义的注释
Spring2.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注入之前将这两种配置方式的元信息融合在一起。
|
|
