spring2.5中的@注释配置

程序员文章站 2022-03-02 14:38:13

...

下面这篇文章写得很更清晰

http://haowei0315.iteye.com/blog/439836

注释配置和 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 配置依然拥有不可替代的地位。

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

bean的作用域

package com.baobaotao;    
import org.springframework.context.annotation.Scope;    
…    
@Scope("prototype")    
@Component("boss")    
public class Boss {    
    …    
}

默认情况下，从bean工厂所取得的实例为Singleton（bean的singleton属性）
Singleton:
Spring容器只存在一个共享的bean实例，默认的配置。
<bean id="example" class="com.tarena.bean.Example"/>
Prototype:
每次对bean的请求都会创建一个新的bean实例。
<bean id="example" class="com.tarena.bean.Example" singleton=”false”/>

二者选择的原则：有状态的bean都使用Prototype作用域，而对无状态的bean则应该使用singleton作用域。

在Spring2.0中除了以前的Singleton和Prototype外又加入了三个新的web作用域，分别为request、session和global session。
如果你希望容器里的某个bean拥有其中某种新的web作用域，除了在bean级上配置相应的scope属性，还必须在容器级做一个额外的初始化配置。即在web应用的web.xml中增加这么一个ContextListener：
<web-app>
   <listener>
         <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
   </listener>
</web-app>
以上是针对Servlet 2.4以后的版本。
比如Request作用域：
<bean id="loginAction" class="com.tarena.LoginAction" scope="request"/>

清单 23. 简化版的 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.baobaotao"/>    
</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+

下面是一个简单的例子：

<context:component-scan base-package="com.baobaotao">    
    <context:include-filter type="regex"     
        expression="com\.baobaotao\.service\..*"/>    
    <context:exclude-filter type="aspectj"     
        expression="com.baobaotao.util..*"/>    
</context:component-scan>

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

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

@PostConstruct 和 @PreDestroy

Spring 容器中的 Bean 是有生命周期的，Spring 允许在 Bean 在初始化完成后以及 Bean 销毁前执行特定的操作，您既可以通过实现 InitializingBean/DisposableBean 接口来定制初始化之后 / 销毁之前的操作方法，也可以通过 <bean> 元素的 init-method/destroy-method 属性指定初始化之后 / 销毁之前调用的操作方法。关于 Spring 的生命周期，笔者在《精通 Spring 2.x—企业应用开发精解》第 3 章进行了详细的描述，有兴趣的读者可以查阅。

JSR-250 为初始化之后/销毁之前方法的指定定义了两个注释类，分别是 @PostConstruct 和 @PreDestroy，这两个注释只能应用于方法上。标注了 @PostConstruct 注释的方法将在类实例化后调用，而标注了 @PreDestroy 的方法将在类销毁之前调用。


清单 17. 使用 @PostConstruct 和 @PreDestroy 注释的 Boss.java

                    
package com.baobaotao;    
   
import javax.annotation.Resource;    
import javax.annotation.PostConstruct;    
import javax.annotation.PreDestroy;    
   
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，这些方法就会在 Bean 初始化后或销毁之前被 Spring 容器执行了。

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

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


清单 18. 测试类代码

package com.baobaotao;    
   
import org.springframework.context.support.ClassPathXmlApplicationContext;    
   
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 销毁方法的执行    
    }    
}

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

@Autowired 注释进行自动注入时，Spring 容器中匹配的候选 Bean 数目必须有且仅有一个。当找不到一个匹配的 Bean 时，Spring 容器将抛出 BeanCreationException 异常，并指出必须至少拥有一个匹配的 Bean。我们可以来做一个实验：

清单 10. 候选 Bean 数目为 0 时

                   
<?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 class="org.springframework.beans.factory.annotation.    
        AutowiredAnnotationBeanPostProcessor"/>     
   
    <bean id="boss" class="com.baobaotao.Boss"/>    
   
    <!-- 将 office Bean 注释掉 -->    
    <!-- <bean id="office" class="com.baobaotao.Office">    
    <property name="officeNo" value="001"/>    
    </bean>-->    
   
    <bean id="car" class="com.baobaotao.Car" scope="singleton">    
        <property name="brand" value=" 红旗 CA72"/>    
        <property name="price" value="2000"/>    
    </bean>    
</beans>

由于 office Bean 被注释掉了，所以 Spring 容器中将没有类型为 Office 的 Bean 了，而 Boss 的 office 属性标注了 @Autowired，当启动 Spring 容器时，异常就产生了。

当不能确定 Spring 容器中一定拥有某个类的 Bean 时，可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false)，这等于告诉 Spring：在找不到匹配 Bean 时也不报错。来看一下具体的例子：


清单 11. 使用 @Autowired(required = false)

package com.baobaotao;    
   
import org.springframework.beans.factory.annotation.Autowired;    
import org.springframework.beans.factory.annotation.Required;    
   
public class Boss {    
   
    private Car car;    
    private Office office;    
   
    @Autowired   
    public void setCar(Car car) {    
        this.car = car;    
    }    
    @Autowired(required = false)    
    public void setOffice(Office office) {    
        this.office = office;    
    }    
    …    
}

当然，一般情况下，使用 @Autowired 的地方都是需要注入 Bean 的，使用了自动注入而又允许不注入的情况一般仅会在开发期或测试期碰到（如为了快速启动 Spring 容器，仅引入一些模块的 Spring 配置文件），所以 @Autowired(required = false) 会很少用到。

和找不到一个类型匹配 Bean 相反的一个错误是：如果 Spring 容器中拥有多个候选 Bean，Spring 容器在启动时也会抛出 BeanCreationException 异常。来看下面的例子：


清单 12. 在 beans.xml 中配置两个 Office 类型的 Bean

…     
<bean id="office" class="com.baobaotao.Office">    
    <property name="officeNo" value="001"/>    
</bean>    
<bean id="office2" class="com.baobaotao.Office">    
    <property name="officeNo" value="001"/>    
</bean>    
…

我们在 Spring 容器中配置了两个类型为 Office 类型的 Bean，当对 Boss 的 office 成员变量进行自动注入时，Spring 容器将无法确定到底要用哪一个 Bean，因此异常发生了。

Spring 允许我们通过 @Qualifier 注释指定注入 Bean 的名称，这样歧义就消除了，可以通过下面的方法解决异常：


清单 13. 使用 @Qualifier 注释指定注入 Bean 的名称

@Autowired   
public void setOffice(@Qualifier("office")Office office) {    
    this.office = office;    
}

@Qualifier("office") 中的 office 是 Bean 的名称，所以 @Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变成 byName 了。@Autowired 可以对成员变量、方法以及构造函数进行注释，而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同，所以 Spring 不将 @Autowired 和 @Qualifier 统一成一个注释类。下面是对成员变量和构造函数入参进行注释的代码：

对成员变量进行注释：

清单 14. 对成员变量使用 @Qualifier 注释

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

对构造函数入参进行注释：


清单 15. 对构造函数变量使用 @Qualifier 注释

public class Boss {    
    private Car car;    
    private Office office;    
   
    @Autowired   
    public Boss(Car car , @Qualifier("office")Office office){    
        this.car = car;    
        this.office = office ;    
    }    
}

@Qualifier 只能和 @Autowired 结合使用，是对 @Autowired 有益的补充。一般来讲，@Qualifier 对方法签名中入参进行注释会降低代码的可读性，而对成员变量注释则相对好一些。

上一篇： springboot 整合 sitemesh3

下一篇： spring2.5整合jpa

spring2.5中的@注释配置

详解Nginx服务器中map模块的配置与使用

Nginx中的root&alias文件路径及索引目录配置详解

Spring在web.xml中的配置详细介绍

Python中的单行、多行、中文注释方法

Winform中实现根据配置文件重新加载ZedGraph属性的实现思路

在Python的web框架中配置app的教程

使用url_helper简化Python中Django框架的url配置教程

Go语言系列：（1）在VsCode中配置Go的开发环境

Windows 8 IIS中配置PHP运行环境的方法

Win7中IIS的ASP.NET环境配置简洁版