Spring2.5 注释驱动的IoC功能

   基于注释（Annotation）的配置有越来越流行的趋势，Spring 2.5 顺应这种趋势，提供了完全基于注释配置

Bean、装配 Bean 的功能，可以使用基于注释的 Spring IoC 替换原来基于 XML 的配置。
  
   注释配置相对于xml配置的优势在于：
   1 注释和java文件位于同一个文件中，而xml配置采用的是独立的配置文件。大多数的配置信息在开发完成后不会修改，

把配置信息和java 代码放在一起，有助于增加程序的内聚性。采用独立的xml文件配置，往往在编程工程中需要在java文

件和xml文件之间切换，造成思维上的不连贯，降低了开发的效率。
   2 注释可以充分的利用java的反射机制，大量的减少配置工作。如使用JPA配置ORM映射关系时，不需要指定对象的属

性名，类型等信息。如果表字段名与对象的属性名称，类型全部一致，甚至不需要编写任务属性映射信息。

  

    使用xml的配置方式注入bean

  清单1    Office.java

 package com.travelsky.annotation;
 public class Office {
		private String officeNo = "001";
		public String getOfficeNo() {return officeNo;}
		public void setOfficeNo(String officeNo) {this.officeNo = officeNo;}
		public String toString(){return "OfficeNo:" + officeNo;}
	}

  清单2   Car.java

 package com.travelsky.annotation;
 public class Car {
		private String brand;private Double price;
		public String getBrand() {return brand;}
		public void setBrand(String brand) {this.brand = brand;}
		public Double getPrice() {return price;}
		public void setPrice(Double price) {this.price = price;}
		public String toString() { return "brand:"+brand+","+ "price:"+price;}
	}

 

清单3   Boss.java

 package com.travelsky.annotation;
 public class Boss {
    	private Car car; private Office office;public Car getCar() {return car;}
    	public void setCar(Car car) {this.car = car;}
    	public Office getOffice() {return office;}
   	public void setOffice(Office office) {this.office = office;}
    	public String toString() {return "car:" + car + "\n" + "office:" + office;}
	}

 清单4  beans.xml

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
	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">
    <bean id="boss" class="com.travelsky.annotation.Boss">
        <property name="car" ref="car"/>
        <property name="office" ref="office" />
    </bean>
    <bean id="office" class="com.travelsky.annotation.Office">
        <property name="officeNo" value="CAN"/>
    </bean>
    <bean id="car" class="com.travelsky.annotation.Car" scope="singleton">
        <property name="brand" value=" 宾利"/>
        <property name="price" value="2000"/>
    </bean>
</beans>

 清单5  测试类

package com.travelsky.annotation;
import org.springframework.context.ApplicationContext;
public class AnnoIoCTest {
	
public static void main(String[] args) {
        String[] locations = {"com/travelsky/annotation/beans.xml"};
        ApplicationContext ctx = 
		    new ClassPathXmlApplicationContext(locations);
        Boss boss = (Boss) ctx.getBean("boss");
        System.out.println(boss);
            }

}

 运行测试用例成功，说明Spring容器已经完成了Bean的创建和配置。

 

使用@Autowired注释

 

@Autowired：配置类成员，方法以及构造函数按照byType 策略完成自动加载。

清单6  修改Boss.java

package com.travelsky.annotation;
import org.springframework.beans.factory.annotation.Autowired;

public class Boss {

    @Autowired
    private Car car;

    @Autowired
    private Office office;

    …
}

 修改beans.xml。使@Autowired注释起作用，则需要在Spring 容器中声明

AutowiredAnnotationBeanPostProcessor Bean。

清单  7  beans.xml

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
	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">
 class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor"/>

    <bean id="boss" class="com.travelsky.annotation.Boss">
    </bean>
    <bean id="office" class="com.travelsky.annotation.Office">
        <property name="officeNo" value="002"/>
    </bean> 
    <bean id="car" class="com.travelsky.annotation.Car" scope="singleton">
        <property name="brand" value=" 宾利"/>
        <property name="price" value="2000"/>
    </bean>
</beans>

   当Spring启动时，AutowiredAnnotationBeanPostProcessor 将扫描 Spring 容器中所有 Bean，

当发现 Bean 中拥有 @Autowired 注释时就找到和其匹配（默认按类型匹配）的 Bean，并注入到对应的地方中去。

按照上面的配置，Spring 将直接采用 Java 反射机制对 Boss 中的 car 和 office 这两个私有成员变量进行自动注入。

@Autowired标签也可以注释到方法以及构造函数上，得到的效果完全相同。

清单8   Boss.java

package com.travelsky.annotation;
public class Boss {
    private Car car;
    private Office office;
 
    @Autowired
    public void setCar(Car car) {
        this.car = car;
    }
 
    @Autowired
    public void setOffice(Office office) {
        this.office = office;
    }

    @Autowired
    public Boss(Car car ,Office office){
        this.car = car;
        this.office = office ;
    }
 
    …
}

@Autowired 注释进行自动注入时，Spring 容器中匹配的候选 Bean 数目必须有且仅有一个。当找不到一个匹配的

 Bean 时，Spring 容器将抛出 BeanCreationException 异常，并指出必须至少拥有一个匹配的 Bean。我们

把beans.xml中的office去掉，运行测试用例，则会抛出异常。

当不能确定 Spring 容器中一定拥有某个类的 Bean 时，可以在需要自动注入该类 Bean 的地方可以使用

 @Autowired(required = false)，这等于告诉 Spring：在找不到匹配 Bean 时也不报错。

清单9  Boss.java

package com.travelsky.annotation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Required;

public class Boss {
    @Autowired
    private Car car;
    @Autowired(required = false)
    private Office office;
    …
}

 

和找不到一个类型匹配 Bean 相反的一个错误是：如果 Spring 容器中拥有多个候选 Bean，Spring 容器在启动时也会

抛出异常。这时可以通过@Qualifier注释制定bean的名称来装载制定的bean。在@Autowired与@Qualifier结合使用时，自动注入的策略就从bytype编程了byname。@Autowired一般是对成员变量，方法和构造函数做注释，@Qualifier一般是对成员变量，方法传入参数和构造函数传入参数做注释。在确保程序高可读性的考虑下，一般将@Qualifier注解加在成员变量上。

在beans.xml中，再加入一个id=office2，class=com.travelsky.annotation.office的bean。

清单 10  boss.java

public class Boss {
    @Autowired
    private Car car;
 
    @Autowired
    @Qualifier("office")
    private Office office;
    …
}

 

使用JSR-250的注释

Spring 不但支持自己定义的 @Autowired 的注释，还支持几个由 JSR-250 规范定义的注释，它们分别是

 @Resource、@PostConstruct 以及 @PreDestroy。

@Resource 的作用相当于 @Autowired，只不过 @Autowired 按 byType 自动注入，面 @Resource 默认按

 byName 自动注入罢了。@Resource 有两个属性是比较重要的，分别是 name 和 type，Spring 将 @Resource

注释的 name 属性解析为 Bean 的名字，而 type 属性则解析为 Bean 的类型。所以如果使用 name 属性，则使用

 byName 的自动注入策略，而使用 type 属性时则使用 byType 自动注入策略。如果既不指定 name 也不指定 type

 属性，这时将通过反射机制使用 byName 自动注入策略。

清单11  Boss.java

public class Boss {
    // 自动注入类型为 Car 的 Bean
    @Resource
    private Car car;

    // 自动注入 bean 名称为 office 的 Bean
    @Resource(name = "office")
    private Office office;
    ...
}

 

 

要让 JSR-250 的注释生效，除了在 Bean 类中标注这些注释外，还需要在 Spring 容器中注册一个负责处理这些注释

的 BeanPostProcessor：

清单12 beans.xml

<bean 
class="org.springframework.context.annotation.CommonAnnotationBeanPostProcessor"/>

 JSR-250 为初始化之后/销毁之前方法的指定定义了两个注释类，分别是 @PostConstruct 和 @PreDestroy，这两

个注释只能应用于方法上。标注了 @PostConstruct 注释的方法将在类实例化后调用，而标注了 @PreDestroy 的方

法将在类销毁之前调用。

清单13  Boss.java

public class Boss {
    @Resource
    private Car car;

    @Resource(name = "office")
    private Office office;

    @PostConstruct
    public void postConstruct1(){
        System.out.println("postConstruct1");
    }

    @PreDestroy
    public void preDestroy1(){
        System.out.println("preDestroy1"); 
    }
    …
}

 使用 @PostConstruct 和 @PreDestroy 注释可以指定多个初始化 / 销毁方法，那些被标注

@PostConstruct 或 @PreDestroy 注释的方法都会在初始化 / 销毁时被执行。

清单14 测试用例

public class AnnoIoCTest {

    public static void main(String[] args) {
        String[] locations = {"beans.xml"};
        ClassPathXmlApplicationContext ctx = 
            new ClassPathXmlApplicationContext(locations);
        Boss boss = (Boss) ctx.getBean("boss");
        System.out.println(boss);
        ctx.destroy();// 关闭 Spring 容器，以触发 Bean 销毁方法的执行
    }
}

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

<context:annotationconfig/> 将隐式地向 Spring 容器注册

AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor、

PersistenceAnnotationBeanPostProcessor 以及 equiredAnnotationBeanPostProcessor 这 4

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

清单15 调整beans.xml

<?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: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">
 
    <context:annotation-config/> 

    <bean id="boss" class="com.travelsky.annotation.Boss"/>
    <bean id="office" class="com.travelsky.annotation.Office">
        <property name="officeNo" value="001"/>
    </bean>
    <bean id="car" class="com.travelsky.annotation.Car" scope="singleton">
        <property name="brand" value=" 红旗 CA72"/>
        <property name="price" value="2000"/>
    </bean>
</beans>

 

使用@Component

虽然我们可以通过 @Autowired 或 @Resource 在 Bean 类中使用自动注入功能，但是 Bean 还是在 XML 文件中

通过 <bean> 进行定义 —— 也就是说，在 XML 配置文件中定义 Bean，通过 @Autowired 或 @Resource 为

Bean 的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注释定义 Bean，从 XML 配置文件中完全

移除 Bean 定义的配置呢？通过 Spring 2.5 提供的 @Component 注释就可以达到这个目标.

使用注释定义 Bean 并完成 Bean 之间装配：

清单 16  使用@Component注释

@Component
public class Car {
    …
}


@Component
public class Office {
    private String officeNo = "001";
    …
}

@Component("boss")
public class Boss {
    @Autowired
    private Car car;

    @Autowired
    private Office office;
    …
}

 

@Component 有一个可选的入参，用于指定 Bean 的名称，在 Boss 中，我们就将 Bean 名称定义为“boss”。

一般情况下，Bean 都是 singleton 的，需要注入 Bean 的地方仅需要通过 byType 策略就可以自动注入了，所以大可

不必指定 Bean 的名称。在使用 @Component 注释后，Spring 容器必须启用类扫描机制以启用注释驱动 Bean

定义和注释驱动 Bean 自动注入的策略。

清单17   简化beans.xml

<?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: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">
    <context:component-scan base-package="com.travelsky.annotation"/>
</beans>

 这里，所有通过 <bean> 元素定义 Bean 的配置内容已经被移除，仅需要添加一行 <context:component-scan/>

配置就解决所有问题了——Spring XML 配置文件得到了极致的简化。

<context:component-scan/> 配置项不但启用了对类包进行扫描以实施注释驱动 Bean 定义的功能，同时还启用了注

释驱动自动注入的功能（即还隐式地在内部注册了 AutowiredAnnotationBeanPostProcessor 和

 CommonAnnotationBeanPostProcessor），因此当使用 <context:component-scan/> 后，就可以将

 <context:annotation-config/> 移除了。

默认情况下通过 @Component 定义的 Bean 都是 singleton 的，如果需要使用其它作用范围的 Bean，可以通过

 @Scope 注释来达到目标

清单18   @Scope定义Bean的作用范围

@Scope("prototype")
@Component("boss")
public class Boss {
    …
}

 这样，当从 Spring 容器中获取 boss Bean 时，每次返回的都是新的实例了。 

Spring 2.5 中除了提供 @Component 注释外，还定义了几个拥有特殊语义的注释，它们分别是：@Repository、

@Service 和 @Controller。在目前的 Spring 版本中，这 3 个注释和 @Component 是等效的，但是从注释类

的命名上，很容易看出这 3 个注释分别和持久层、业务层和控制层（Web 层）相对应。虽然目前这 3 个注释和

@Component 相比没有什么新意，但 Spring 将在以后的版本中为它们添加特殊的功能。所以，如果 Web 应用程序采

用了经典的三层分层结构的话，最好在持久层、业务层和控制层分别采用 @Repository、@Service 和

@Controller 对分层中的类进行注释，而用 @Component 对那些比较中立的类进行注释。

 

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

 

1 注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的，（如 Service 使用了哪几个 DAO 类），

这种配置信息不会在部署时发生调整，那么注释配置优于 XML 配置；反之如果这种依赖关系会在部署时发生调整，XML

 配置显然又优于注释配置，因为注释是对 Java 源代码的调整，您需要重新改写源代码并重新编译才可以实施调整。

 

2如果 Bean 不是自己编写的类（如 JdbcTemplate、SessionFactoryBean 等），注释配置将无法实施，此时

 XML 配置是唯一可用的方式。

 

3 注释配置往往是类级别的，而 XML 配置则可以表现得更加灵活。比如相比于 @Transaction 事务注释，使用

 aop/tx 命名空间的事务配置更加灵活和简单。

 

所以在实现应用中，我们往往需要同时使用注释配置和 XML 配置，对于类级别且不会发生变动的配置可以优先考虑注释配

置；而对于那些第三方类以及容易发生调整的配置则应优先考虑使用 XML 配置。Spring 会在具体实施 Bean 创建和

 Bean 注入之前将这两种配置方式的元信息融合在一起。