跳到主要内容

自动装配协作者

ChatGPT-4o 中英对照 Autowiring Collaborators

Spring 容器可以自动装配协作 bean 之间的关系。通过检查 ApplicationContext 的内容,你可以让 Spring 自动为你的 bean 解析协作者(其他 bean)。自动装配具有以下优点:

  • 自动装配可以显著减少指定属性或构造函数参数的需求。(其他机制,如 bean 模板在本章其他地方讨论,在这方面也很有价值。)

  • 自动装配可以在对象演变时更新配置。例如,如果你需要为一个类添加依赖项,该依赖项可以自动满足,而无需修改配置。因此,自动装配在开发过程中尤其有用,同时在代码库变得更稳定时,仍然可以选择切换到显式装配。

当使用基于 XML 的配置元数据时(参见依赖注入),可以通过 <bean/> 元素的 autowire 属性为 bean 定义指定自动装配模式。自动装配功能有四种模式。可以为每个 bean 指定自动装配,从而选择要自动装配的 bean。下表描述了四种自动装配模式:

表 1. 自动装配模式

模式解释
no(默认)无自动装配。Bean 引用必须通过 ref 元素定义。不建议在较大部署中更改默认设置,因为显式指定协作者可以提供更大的控制和清晰度。在某种程度上,它记录了系统的结构。
byName按属性名称自动装配。Spring 会查找与需要自动装配的属性同名的 bean。例如,如果一个 bean 定义设置为按名称自动装配,并且它包含一个 master 属性(即它有一个 setMaster(..) 方法),Spring 会查找一个名为 master 的 bean 定义并使用它来设置该属性。
byType如果容器中恰好存在一个属性类型的 bean,则允许自动装配该属性。如果存在多个,则会抛出致命异常,这表明您不能对该 bean 使用 byType 自动装配。如果没有匹配的 bean,则什么也不发生(属性不会被设置)。
constructor类似于 byType,但适用于构造函数参数。如果容器中没有恰好一个构造函数参数类型的 bean,则会引发致命错误。

使用 byTypeconstructor 自动装配模式时,可以装配数组和类型化集合。在这种情况下,容器中所有与预期类型匹配的自动装配候选者都会被提供以满足依赖关系。如果预期的键类型是 String,则可以自动装配强类型的 Map 实例。自动装配的 Map 实例的值由所有与预期类型匹配的 bean 实例组成,而 Map 实例的键包含相应的 bean 名称。

自动装配的限制和缺点

自动装配在整个项目中一致使用时效果最佳。如果通常不使用自动装配,仅使用它来装配一两个 bean 定义可能会让开发人员感到困惑。

考虑自动装配的局限性和缺点:

  • propertyconstructor-arg 设置中的显式依赖关系总是会覆盖自动装配。你不能自动装配简单属性,例如基本类型、StringClass(以及这些简单属性的数组)。这种限制是设计使然。

  • 自动装配不如显式装配精确。尽管如前表所述,Spring 在可能产生意外结果的情况下会小心避免猜测。你 Spring 管理的对象之间的关系不再被明确记录。

  • 工具可能无法获取从 Spring 容器生成文档所需的装配信息。

  • 容器内的多个 bean 定义可能与要自动装配的 setter 方法或构造函数参数指定的类型匹配。对于数组、集合或 Map 实例,这不一定是个问题。然而,对于期望单一值的依赖关系,这种模糊性不会被随意解决。如果没有唯一的 bean 定义可用,则会抛出异常。

在后一种情况下,您有几种选择:

  • 放弃自动装配,转而使用显式装配。

  • 通过将 bean 定义的 autowire-candidate 属性设置为 false 来避免自动装配,如下一节所述。

  • 通过将 <bean/> 元素的 primary 属性设置为 true,将单个 bean 定义指定为主要候选者。

  • 实现基于注解配置的更细粒度控制,如基于注解的容器配置中所述。

从自动装配中排除一个 Bean

在每个 bean 的基础上,你可以将一个 bean 排除在自动装配之外。在 Spring 的 XML 格式中,将 <bean/> 元素的 autowire-candidate 属性设置为 false;使用 @Bean 注解时,该属性名为 autowireCandidate。容器会使特定的 bean 定义对自动装配基础设施不可用,包括基于注解的注入点,例如 @Autowired

备注

autowire-candidate 属性旨在仅影响基于类型的自动装配。它不会影响按名称的显式引用,即使指定的 bean 未标记为自动装配候选者,也会被解析。因此,如果名称匹配,按名称自动装配仍然会注入一个 bean。

您还可以基于对 bean 名称的模式匹配来限制自动装配候选者。顶级 <beans/> 元素在其 default-autowire-candidates 属性中接受一个或多个模式。例如,要将自动装配候选者状态限制为名称以 Repository 结尾的任何 bean,请提供值 *Repository。要提供多个模式,请在逗号分隔的列表中定义它们。对于 bean 定义的 autowire-candidate 属性的显式值 truefalse 总是优先。对于这样的 bean,模式匹配规则不适用。

这些技术对于那些你不希望通过自动装配注入到其他 bean 中的 bean 非常有用。这并不意味着被排除的 bean 不能通过自动装配进行配置。相反,该 bean 本身不是自动装配其他 bean 的候选者。

备注

从 6.2 版本开始,@Bean 方法支持两种自动装配候选标志的变体:autowireCandidatedefaultCandidate

当使用限定符时,一个标记为 defaultCandidate=false 的 bean 仅在存在额外限定符指示的注入点可用。这对于在特定区域中可注入但不应干扰其他地方相同类型的 bean 的受限委托非常有用。这样的 bean 永远不会仅通过声明的类型注入,而是通过类型加上特定的限定符。

相反,autowireCandidate=false 的行为完全像上面解释的 autowire-candidate 属性:这样的 bean 永远不会通过类型注入。