zoukankan      html  css  js  c++  java
  • 详解Java的Spring框架中的注解的用法

    转载:http://www.jb51.net/article/75460.htm

    1. 使用Spring注解来注入属性

    1.1. 使用注解以前我们是怎样注入属性的 
    类的实现:

    class UserManagerImpl implements UserManager { 
      private UserDao userDao; 
      public void setUserDao(UserDao userDao) { 
        this.userDao = userDao; 
      } 
      ... 
    }
    

    配置文件:

    <bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl"> 
      <property name="userDao" ref="userDao" /> 
    </bean> 
    <bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl"> 
      <property name="sessionFactory" ref="mySessionFactory" /> 
    </bean>
    
    

    1.2. 引入@Autowired注解(不推荐使用,建议使用@Resource) 
    类的实现(对成员变量进行标注)

    public class UserManagerImpl implements UserManager { 
      @Autowired 
      private UserDao userDao; 
      ... 
    }
    

    或者(对方法进行标注)

    UserManagerImpl implements UserManager { 
      private UserDao userDao; 
      @Autowired 
      public void setUserDao(UserDao userDao) { 
        this.userDao = userDao; 
      } 
      ... 
    }
    

    配置文件

    <bean id="userManagerImpl" class="com.kedacom.spring.annotation.service.UserManagerImpl" /> 
    <bean id="userDao" class="com.kedacom.spring.annotation.persistence.UserDaoImpl"> 
      <property name="sessionFactory" ref="mySessionFactory" /> 
    </bean>
    

    @Autowired可以对成员变量、方法和构造函数进行标注,来完成自动装配的工作。以上两种不同实现方式中,@Autowired的标注位置不同,它们都会在Spring在初始化userManagerImpl这个bean时,自动装配userDao这个属性,区别是:第一种实现中,Spring会直接将UserDao类型的唯一一个bean赋值给userDao这个成员变量;第二种实现中,Spring会调用setUserDao方法来将UserDao类型的唯一一个bean装配到userDao这个属性。

    1.3. 让@Autowired工作起来 
    要使@Autowired能够工作,还需要在配置文件中加入以下代码

    class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />
    
    

    1.4. @Qualifier 
    @Autowired是根据类型进行自动装配的。在上面的例子中,如果当Spring上下文中存在不止一个UserDao类型的bean时,就会抛出BeanCreationException异常;如果Spring上下文中不存在UserDao类型的bean,也会抛出BeanCreationException异常。我们可以使用@Qualifier配合@Autowired来解决这些问题。 
    1. 可能存在多个UserDao实例

    @Autowired 
    public void setUserDao(@Qualifier("userDao") UserDao userDao) { 
      this.userDao = userDao; 
    }
    

    这样,Spring会找到id为userDao的bean进行装配。 
    2. 可能不存在UserDao实例

    @Autowired(required = false) 
    public void setUserDao(UserDao userDao) { 
      this.userDao = userDao; 
    } 
    
    

    1.5. @Resource(JSR-250标准注解,推荐使用它来代替Spring专有的@Autowired注解) 
    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自动注入策略。 
    @Resource装配顺序

    如果同时指定了name和type,则从Spring上下文中找到唯一匹配的bean进行装配,找不到则抛出异常
    如果指定了name,则从上下文中查找名称(id)匹配的bean进行装配,找不到则抛出异常
    如果指定了type,则从上下文中找到类型匹配的唯一bean进行装配,找不到或者找到多个,都会抛出异常
    如果既没有指定name,又没有指定type,则自动按照byName方式进行装配(见2);如果没有匹配,则回退为一个原始类型(UserDao)进行匹配,如果匹配则自动装配;
    1.6. @PostConstruct(JSR-250) 
    在方法上加上注解@PostConstruct,这个方法就会在Bean初始化之后被Spring容器执行(注:Bean初始化包括,实例化Bean,并装配Bean的属性(依赖注入))。 
    它的一个典型的应用场景是,当你需要往Bean里注入一个其父类中定义的属性,而你又无法复写父类的属性或属性的setter方法时,如: 

    public class UserDaoImpl extends HibernateDaoSupport implements UserDao { 
      private SessionFactory mySessionFacotry; 
      @Resource 
      public void setMySessionFacotry(SessionFactory sessionFacotry) { 
        this.mySessionFacotry = sessionFacotry; 
      } 
      @PostConstruct 
      public void injectSessionFactory() { 
        super.setSessionFactory(mySessionFacotry); 
      } 
      ... 
    }
    

    这里通过@PostConstruct,为UserDaoImpl的父类里定义的一个sessionFactory私有属性,注入了我们自己定义的sessionFactory(父类的setSessionFactory方法为final,不可复写),之后我们就可以通过调用super.getSessionFactory()来访问该属性了。


    1.7. @PreDestroy(JSR-250) 
    在方法上加上注解@PreDestroy,这个方法就会在Bean初始化之后被Spring容器执行。由于我们当前还没有需要用到它的场景,这里不不去演示。其用法同@PostConstruct。

    1.8. 使用<context:annotation-config />简化配置 
    Spring2.1添加了一个新的context的Schema命名空间,该命名空间对注释驱动、属性文件引入、加载期织入等功能提供了便捷的配置。我们知道注释本身是不会做任何事情的,它仅提供元数据信息。要使元数据信息真正起作用,必须让负责处理这些元数据的处理器工作起来。 
    AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是处理这些注释元数据的处理器。但是直接在Spring配置文件中定义这些Bean显得比较笨拙。Spring为我们提供了一种方便的注册这些BeanPostProcessor的方式,这就是<context:annotation-config />:

    <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 /> 
    </beans>
    

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

    2. 使用Spring注解完成Bean的定义 
    以上我们介绍了通过@Autowired或@Resource来实现在Bean中自动注入的功能,下面我们将介绍如何注解Bean,从而从XML配置文件中完全移除Bean定义的配置。

    2.1. @Component(不推荐使用)、@Repository、@Service、@Controller 
    只需要在对应的类上加上一个@Component注解,就将该类定义为一个Bean了:

    @Component 
    public class UserDaoImpl extends HibernateDaoSupport implements UserDao { 
      ... 
    }
    

    使用@Component注解定义的Bean,默认的名称(id)是小写开头的非限定类名。如这里定义的Bean名称就是userDaoImpl。你也可以指定Bean的名称: 
    @Component("userDao") 
    @Component是所有受Spring管理组件的通用形式,Spring还提供了更加细化的注解形式:@Repository、@Service、@Controller,它们分别对应存储层Bean,业务层Bean,和展示层Bean。目前版本(2.5)中,这些注解与@Component的语义是一样的,完全通用,在Spring以后的版本中可能会给它们追加更多的语义。所以,我们推荐使用@Repository、@Service、@Controller来替代@Component。

    2.2. 使用<context:component-scan />让Bean定义注解工作起来

    <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.kedacom.ksoa" /> 
    </beans>
    
    

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

    过滤器类型 表达式范例 说明
    注解 org.example.SomeAnnotation 将所有使用SomeAnnotation注解的类过滤出来
    类名指定 org.example.SomeClass 过滤指定的类
    正则表达式 com.kedacom.spring.annotation.web..* 通过正则表达式过滤一些类
    AspectJ表达式 org.example..*Service+ 通过AspectJ表达式过滤一些类

    以正则表达式为例,我列举一个应用实例:

    <context:component-scan base-package="com.casheen.spring.annotation"> 
      <context:exclude-filter type="regex" expression="com.casheen.spring.annotation.web..*" /> 
    </context:component-scan>
    

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

    2.3. 使用@Scope来定义Bean的作用范围 
    在使用XML定义Bean时,我们可能还需要通过bean的scope属性来定义一个Bean的作用范围,我们同样可以通过@Scope注解来完成这项工作:

    @Scope("session") 
    @Component() 
    public class UserSessionBean implements Serializable { 
      ... 
    }
    
    

    3.在使用annotation之前定义三个bean之间的关系是这样的

    package com.baobaotao;
    public class Office {
      private String officeNo =”001”;
     
      //省略 get/setter
     
      @Override
      public String toString() {
        return "officeNo:" + officeNo;
      }
    }
    
    ackage com.baobaotao;
     
    public class Car {
      private String brand;
      private double price;
     
      // 省略 get/setter
     
      @Override
      public String toString() {
        return "brand:" + brand + "," + "price:" + price;
      }
    }
    
    package com.baobaotao;
     
    public class Boss {
      private Car car;
      private Office office;
     
      // 省略 get/setter
     
      @Override
      public String toString() {
        return "car:" + car + "
    " + "office:" + office;
      }
    }
    
    

    配置文件如下:

    <?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.baobaotao.Boss">
        <property name="car" ref="car"/>
        <property name="office" ref="office" />
      </bean>
      <bean id="office" class="com.baobaotao.Office">
        <property name="officeNo" value="002"/>
      </bean>
      <bean id="car" class="com.baobaotao.Car" scope="singleton">
        <property name="brand" value=" 红旗 CA72"/>
        <property name="price" value="2000"/>
      </bean>
    </beans>
    

    测试文件如下:

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

     
    4.接下来我们可以使用autowired来注解,他可以对成员变量,方法及构造函数进行标准,完成自动装配的工作。

    autoware来注解成员变量的用法

    package com.baobaotao;
    import org.springframework.beans.factory.annotation.Autowired;
     
    public class Boss {
     
      @Autowired
      private Car car;
     
      @Autowired
      private Office office;
     
      …
    }
    

    相应的配置文件如下:

    <?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">
     
      <!-- 该 BeanPostProcessor 将自动起作用,对标注 @Autowired 的 Bean 进行自动注入 -->
      <bean class="org.springframework.beans.factory.annotation.    AutowiredAnnotationBeanPostProcessor"/>
     
      <!-- 移除 boss Bean 的属性注入配置的信息 -->
      <bean id="boss" class="com.baobaotao.Boss"/>
     
      <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>
    

    autoware也可以用在setter方法及构造函数上

    package com.baobaotao;
     
    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;
      }
      …
    }
    
    package com.baobaotao;
     
    public class Boss {
      private Car car;
      private Office office;
     
      @Autowired
      public Boss(Car car ,Office office){
        this.car = car;
        this.office = office ;
      }
     
      …
    }
    
    

    当候选bean的数目为0时,我们可以使用@Autowired(required = false)来防止spring找不到bean时报错。

    当有多个候选bean的时候,我们可以通过@Qualifier 注释指定注入 Bean 的名称。

    @Autowired 和 @Qualifier 结合使用时,自动注入的策略就从 byType 转变成 byName 了。@Autowired 可以对成员变量、方法以及构造函数进行注释,而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同,所以 Spring 不将 @Autowired 和 @Qualifier 统一成一个注释类。

    5.@resorce是按照名字来进行反射,他有两个参数,name和type,使用name即按照byname来映射,使用type即按照bytype来进行映射。

    package com.baobaotao;
     
    import javax.annotation.Resource;
     
    public class Boss {
      // 自动注入类型为 Car 的 Bean
      @Resource
      private Car car;
     
      // 自动注入 bean 名称为 office 的 Bean
      @Resource(name = "office")
      private Office office;
    }
    @postconstructor和preDestory是用来注解类初始化后和销毁前的方法。 
    
    
    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"); 
      }
      …
    }
    
    

    6.@compent可以直接定义bean,这样xml配置文件中就不需要配置bean了

    package com.baobaotao;
     
    import org.springframework.stereotype.Component;
     
    @Component
    public class Car {
      …
    }
    
    package com.baobaotao;
     
    import org.springframework.stereotype.Component;
     
    @Component
    public class Office {
      private String officeNo = "001";
      …
    }
    
    package com.baobaotao;
     
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Required;
    import org.springframework.beans.factory.annotation.Qualifier;
    import org.springframework.stereotype.Component;
     
    @Component("boss")
    public class Boss {
      @Autowired
      private Car car;
     
      @Autowired
      private Office office;
      …
    }
    
    

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

    <?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>
    
    

    7.@scope可以用来指定其目标

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


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

  • 相关阅读:
    Ubuntu使用PBIS认证
    命令行运行Python脚本时传入参数的三种方式
    Python中调用shell
    Install chocolatey
    Configure vyatta
    Linux: Block Port With IPtables
    转:PHPStorm+XDebug进行调试图文教程
    转 Fira Code | 为写程序而生的字体
    转 [PHP]
    转:Drupal 如何得到字段的值?
  • 原文地址:https://www.cnblogs.com/jieliujas/p/8968851.html
Copyright © 2011-2022 走看看