首页 > 代码库 > 详解@Autowired、@Qualifier和@Required

详解@Autowired、@Qualifier和@Required

A、@Autowired

org.springframework.beans.factory.annotation.Autowired

public @interface Autowired

Marks a constructor, field, setter method or config method as to be autowired by Spring‘s dependency injection facilities.

标注一个构造函数,字段,setter方法或者配置方法,让它通过spring的依赖注入方法自动装填。

 

Only one constructor (at max) of any given bean class may carry this annotation, indicating the constructor to autowire when used as a Spring bean. Such a constructor does not have to be public.

任何一个给定的bean类只能有一个构造函数可以携带这个注释,表示这个类作为一个spring的bean使用时,这个构造器将用于自动装配。这个构造函数不是必须是public。

 

Fields are injected right after construction of a bean, before any config methods are invoked. Such a config field does not have to be public.

在一个bean创建之后,任何方法被调用之前,这个字段被注入。这个字段不是必须是public。

 

Config methods may have an arbitrary name and any number of arguments; each of those arguments will be autowired with a matching bean in the Spring container. Bean property setter methods are effectively just a special case of such a general config method. Such config methods do not have to be public.

配置方法它可以是任意名称和有任意多个参数。这个方法的任何一个参数都将使用spring容器中匹配的bean来自动装填。Bean属性的setter方法也是有效的,它是普通的配置方法的一个特例。配置方法不是必须是public。

 

In the case of multiple argument methods, the ‘required‘ parameter is applicable for all arguments.

当有多个参数的方法情况下,‘required‘将适用于所有参数。

 

In case of a Collection or Map dependency type, the container will autowire all beans matching the declared value type. In case of a Map, the keys must be declared as type String and will be resolved to the corresponding bean names.

Collection或Map依赖类型情况,容器将自动装配bean匹配声明的值类型,这个Map的key必须是String,Map的values必须是已知的类型。

 

属性

boolean required

Declares whether the annotated dependency is required.

Defaults to true.

声明这个注释依赖是否需要,默认是true。

 

A.1、数组、Set、Map

当我们用@Autowired来注释数组、Set、Map时,容器将自动绑定容器中所有匹配的bean。我们在上节的例子上修改来说明这个问题。

 

范例1

1.Foo

对数组使用自动绑定

 

Java代码  收藏代码
  1. public class Foo {    
  2.     @Autowired  
  3.     private Bar[] bars;  
  4. }  

 

2.配置文件

配置文件中有2Bar,故这两bean(对象)将自动装配到foo中。

 

Xml代码  收藏代码
  1. <beans>  
  2.     <context:annotation-config/>  
  3.     <bean id="foo" class="x.y.Foo" />  
  4.     <bean id="bar1" class="x.y.Bar">  
  5.        <property name="a" value=http://www.mamicode.com/"bar1" />  
  6.     </bean>  
  7.     <bean id="bar2" class="x.y.Bar">  
  8.        <property name="a" value=http://www.mamicode.com/"bar2" />  
  9.     </bean>  
  10. </beans>  

 

3.测试类

测试类中将返回结果为2。

 

Java代码  收藏代码
  1. Foo foo = (Foo) ctx.getBean("foo");  
  2. Bar[] bars=foo.getBars();  
  3. System.out.println(bars.length);  

Set和Map实现方法类似,就是定义时有要求,必须定义为以下格式:

Set<Bar>

Map<String,Bar>

 

A.2、required

上例中若容器中没有Bar,将会报错,有时我们允许自动装配的属性为null,我们就需要这样来定义:

 

Java代码  收藏代码
  1. @Autowired(required=false)  
  2. private Bar bar;  

这样若容器中没有Bar,它将自动装配null。

 

 

B、@Qualifier

org.springframework.beans.factory.annotation.Qualifier

public @interface Qualifier

This annotation may be used on a field or parameter as a qualifier for candidate beans when autowiring. It may also be used to annotate other custom annotations that can then in turn be used as qualifiers.

@Qualifier用于注释一个字段或参数,当自动绑定时它作为候选bean的限定器。它也可以用于自定义的限定器注释。

 

属性

value

 

B.1、举例说明

我们使用@AutoWired按照类型自动绑定,当容器中有多个匹配的bean时,将绑定那一个呢?我们可以通过在需要绑定的字段或参数上使用@Qualifier(value=http://www.mamicode.com/” bar1”)来指定要绑定的bean。并在bean定义中使用<bean id="bar1"<qualifier value="http://www.mamicode.com/bar1"/>来关联。

 

范例1

1.Foo

 

Java代码  收藏代码
  1. public class Foo {    
  2.     @Autowired  
  3.     @Qualifier(value=http://www.mamicode.com/"bar1")  
  4.     private Bar bar;  
  5. }  

 

2.配置文件

配置文件中有2Bar,一个bean使用qualifier进行标注,一个使用id进行标注,容器将选择和@Qualifier(value)匹配的bean来进行绑定。

 

Xml代码  收藏代码
  1. <beans>  
  2.     <context:annotation-config/>  
  3.     <bean id="foo" class="x.y.Foo" />  
  4.     <bean class="x.y.Bar">  
  5.        <qualifier value=http://www.mamicode.com/"bar2"/>  
  6.        <property name="a" value=http://www.mamicode.com/"bar2" />  
  7.     </bean>  
  8.     <bean id="bar1" class="x.y.Bar">  
  9.        <property name="a" value=http://www.mamicode.com/"bar1" />  
  10.     </bean>  
  11. </beans>  

 

 

C、@Required

org.springframework.beans.factory.annotation.Required

public @interface Required

Marks a method (typically a JavaBean setter method) as being ‘required‘: that is, the setter method must be configured to be dependency-injected with a value.

标注一个方法(通常是一个JavaBean的setter方法)是@Required,也就是,这个setter方法必须定义为通过一个值来依赖注入。

详解@Autowired、@Qualifier和@Required