zoukankan      html  css  js  c++  java
  • Spring @Autowired 注解 指定自动装配

    下面是 3 个实体类,它们分别是 Office、Car 和 Boss。

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

    传统的xml配置方式

    在 Spring 容器中将 Office 和 Car 声明为 Bean,并注入到 Boss Bean 中:

    下面是使用传统 XML 完成这个工作的配置文件 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.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>

    当我们运行以下代码时,控制台将正确打出 boss 的信息:

    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);
        }
    }

     

    使用 @Autowired 注释

    Spring 2.5 引入了 @Autowired 注释,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。

     

    一、使用@Autowired 进行成员变量自动注入的代码:

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

    Spring 通过一个 BeanPostProcessor 对 @Autowired 进行解析,所以要让@Autowired 起作用必须事先在 Spring 容器中声明AutowiredAnnotationBeanPostProcessor 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"
        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>

     这样,当 Spring 容器启动时,AutowiredAnnotationBeanPostProcessor 将扫描 Spring 容器中所有 Bean,当发现 Bean 中拥有@Autowired 注释时就找到和其匹配(默认按类型匹配)的 Bean,并注入到对应的地方中去

    按照上面的配置,Spring 将直接采用 Java 反射机制对 Boss 中的 car 和 office 这两个私有成员变量进行自动注入。所以对成员变量使用@Autowired后,可将它们的 setter 方法(setCar() 和 setOffice())从 Boss 中删除。



    二、通过 @Autowired 对方法或构造函数进行标注,来看下面的代码:

    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 将查找被标注的方法的入参类型的 Bean,并调用方法自动注入这些 Bean。

    三、使用 @Autowired   对构造函数进行标注:

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

    由于 Boss() 构造函数有两个入参,分别是 car 和 office@Autowired 将分别寻找和它们类型匹配的 Bean,将它们作为Boss(Car car ,Office office)的入参来创建 Boss Bean。

    当候选 Bean 数目不为 1 时的应对方法

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

    候选 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 时也不报错。来看一下具体的例子:

     使用 @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 异常。来看下面的例子:

    在 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 的名称,这样歧义就消除了,可以通过下面的方法解决异常:

    使用 @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 对方法签名中入参进行注释会降低代码的可读性,而对成员变量注释则相对好一些。

    使用 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

    import javax.annotation.Resource;
    
    public class Boss {
        // 自动注入类型为 Car 的 Bean
        @Resource
        private Car car;
    
        // 自动注入 bean 名称为 office 的 Bean
        @Resource(name = "office")
        private Office office;
    } 

    一般情况下,我们无需使用类似于 @Resource(type=Car.class) 的注释方式,因为 Bean 的类型信息可以通过 Java 反射从代码中获取。

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

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

    CommonAnnotationBeanPostProcessor 实现了 BeanPostProcessor 接口,它负责扫描使用了 JSR-250 注释的 Bean,并对它们进行相应的操作。

    @PostConstruct 和 @PreDestroy

    Spring 容器中的 Bean 是有生命周期的,Spring 允许在 Bean 在初始化完成后以及 Bean 销毁前执行特定的操作,您既可以通过实现 InitializingBean/DisposableBean 接口来定制初始化之后 / 销毁之前的操作方法,也可以通过 <bean> 元素的 init-method/destroy-method 属性指定初始化之后 / 销毁之前调用的操作方法。

    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 的时候被触发执行。

    使用 @Component

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

    为什么 @Repository 只能标注在 DAO 类上呢?这是因为该注解的作用不只是将类识别为 Bean,同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring 本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构,用于封装不同的持久层框架抛出的异常,使得异常独立于底层的框架。

    Spring 2.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

    package com.baobaotao;
    
    import org.springframework.stereotype.Component;
    
    @Component
    public class Car {
        …
    }

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

    package com.baobaotao;
    
    import org.springframework.stereotype.Component;
    
    @Component
    public class Office {
        private String officeNo = "001";
        …
    } 

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

    使用 @Component 注释的 Boss.java

    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 的名称。

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

    清单 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/> 还允许定义过滤器将基包下的某些类纳入或排除。

    REF

    https://blog.csdn.net/zhh1072773034/article/details/71216407

  • 相关阅读:
    HDU2059(龟兔赛跑)
    pat 1012 The Best Rank
    pat 1010 Radix
    pat 1007 Maximum Subsequence Sum
    pat 1005 Sign In and Sign Out
    pat 1005 Spell It Right
    pat 1004 Counting Leaves
    1003 Emergency
    第7章 输入/输出系统
    第六章 总线
  • 原文地址:https://www.cnblogs.com/emanlee/p/15724317.html
Copyright © 2011-2022 走看看