Spring @Autowired详解

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的范围,但自动装配实际上是通过类型注入的,这是使用容器特性的最佳方式。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容