1.概述
从Spring 2.5开始,spring框架引入了由@Autowired
注解驱动的依赖注入。此注释允许Spring解析并将有依赖关系的bean注入到bean中。
在本文中,我们将了解如何启用自动装配、如何设置自动装配、设置@Autowired可选依赖属性、使用@Qualifier注释解决bean冲突以及潜在的异常场景。
2.启用@Autowired注解
如果应用程序是基于Java的配置,则可以使用AnnotationConfigApplicationContext
来加载注释配置,从而启用@Autowired
注解,如下所示:
@Configuration
@ComponentScan("com.baeldung.autowire.sample")
public class AppConfig {}
如果使用基于Spring XML的配置,可以在Spring XML文件中配置如下标签来启用@Autowired
注解:
<context:annotation-config/>
3.使用@Autowired
一旦启用了@Autowired,自动装配就可以用于属性、setter和构造函数。
3.1 @Autowired属性
注释可以直接在属性上使用,因此不需要getter和setter:
@Component("fooFormatter")
public class FooFormatter {
public String format() {
return "foo";
}
}
@Component
public class FooService {
@Autowired
private FooFormatter fooFormatter;
}
在上面的例子中,创建FooService时,Spring查找并注入fooFormatter。
3.2 @Autowired setter方法
@Autowired注解可以用在setter方法上。在下面的示例中,当在setter方法上使用注释时,在创建FooService时,将使用FooFormatter实例调用setter方法:
public class FooService {
private FooFormatter fooFormatter;
@Autowired
public void setFooFormatter(FooFormatter fooFormatter) {
this.fooFormatter = fooFormatter;
}
}
3.3 @Autowired在构造函数上
@Autowired注解也可以用在构造函数上。在下面的示例中,当在构造函数上使用注释时,在创建FooService时,将FooFormatter实例作为参数注入构造函数:
public class FooService {
private FooFormatter fooFormatter;
@Autowired
public FooService(FooFormatter fooFormatter) {
this.fooFormatter = fooFormatter;
}
}
4. @Autowired 可选依赖项
Spring希望在构造依赖bean时@Autowired依赖可以使用。如果框架无法解析依赖注入的bean,将抛出以下异常并阻止Spring容器成功启动:
`Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: ``No qualifying bean of type [com.autowire.sample.FooDAO] found ``for` `dependency: ``expected at least ``1` `bean which qualifies as autowire candidate ``for` `this` `dependency. ``Dependency annotations: ``{``@org``.springframework.beans.factory.annotation.Autowired(required=``true``)}`
为了避免这种情况的发生,可以如下指定一个可选的bean:
为了避免这种情况发生,可以 将@Autowired 可选项设置为required = false
,默认为true,如下所示:
public class FooService {
@Autowired(required = false)
private FooDAO dataAccessor;
}
5. 自动装配消除歧义
默认情况下,Spring 按类型解析@Autowired。如果容器中有多个同类型的Bean,框架将抛出一个致命异常,表明有多个Bean可用于自动装配。
5.1 通过@Qualifier消除歧义
@Qualifier用于解决不明确的依赖关系,即,它可以帮助@Autowired注解选择一种依赖关系。
@Component("fooFormatter")
public class FooFormatter implements Formatter {
public String format() {
return "foo";
}
}
@Component("barFormatter")
public class BarFormatter implements Formatter {
public String format() {
return "bar";
}
}
public class FooService {
@Autowired
private Formatter formatter;
}
因为有两个具体的Formatter实现可以被Spring容器注入,所以Spring 在构造FooService时会抛出NoUniqueBeanDefinitionException异常:
Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: ``No qualifying bean of type [com.autowire.sample.Formatter] is defined: ``expected single matching bean but found ``2``: barFormatter,fooFormatter`
可以通过使用@Qualifier注释缩小实现范围来避免这种情况:
public class FooService {
@Autowired
@Qualifier("fooFormatter")
private Formatter formatter;
}
通过使用特定实现的名称指定@Qualifier(在本例中为fooFormatter),我们可以在Spring发现多个相同类型的bean时避免歧义。
请注意,@Qualifier注释的值与我们的FooFormatter实现的@Component注释中声明的名称相匹配。
5.2 通过自定义Qualifier自动装配
Spring允许我们创建自己的@Qualifier注释。要创建自定义Qualifier,首先要定义一个注释并在定义中提供@Qualifier注释,如下所示:
@Qualifier
@Target({
ElementType.FIELD, ElementType.METHOD, ElementType.TYPE, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface FormatterType {
String value();
}
定义后,可以在各种实现中使用FormatterType来指定自定义值:
@FormatterType("Foo")
@Component
public class FooFormatter implements Formatter {
public String format() {
return "foo";
}
}
@FormatterType("Bar")
@Component
public class BarFormatter implements Formatter {
public String format() {
return "bar";
}
}
对实现进行注释后,可以按以下方式使用自定义Qualifier注释:
@Component
public class FooService {
@Autowired
@FormatterType("Foo")
private Formatter formatter;
}
@Target注释中指定的值限制了可以使用qualifier 标记注入点的位置。
在上面的代码片段中,可以使用qualifier 消除歧义,在这里Spring可以将bean注入到字段、方法、类型和参数中。
5.3 按名称自动装配
Spring使用Bean名称作为默认的Qualifier 值。
因此,通过定义bean属性名(在本例中为fooFormatter), Spring将其与fooFormatter实现相匹配,并在构造FooService时注入特定的实现:
public class FooService {
@Autowired
private Formatter fooFormatter;
}
6. 结论
虽然可以使用@Qualifier和bean 名称匹配来缩小特定bean的范围,但自动装配实际上是通过类型注入的,这是使用容器特性的最佳方式。