使用 @Autowired

JSR 330 的 @Inject 注解可以替代 Spring 的 @Autowired 注解用于本节的示例中。更多详情请参阅 此处

你可以将 @Autowired 注解应用于构造函数,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	private final CustomerPreferenceDao customerPreferenceDao;

	@Autowired
	public MovieRecommender(CustomerPreferenceDao customerPreferenceDao) {
		this.customerPreferenceDao = customerPreferenceDao;
	}

	// ...
}
class MovieRecommender @Autowired constructor(
	private val customerPreferenceDao: CustomerPreferenceDao)

从 Spring Framework 4.3 开始,如果目标 bean 只定义一个构造函数,那么在该构造函数上使用 @Autowired 注解就不再是必需的。然而,如果有多个构造函数可用且没有主/默认构造函数,那么至少有一个构造函数必须使用 @Autowired 注解,以指示容器使用哪一个。有关详细信息,请参阅 构造函数解析的讨论。

你还可以将 @Autowired 注解应用于 传统 setter 方法,如以下示例所示:

  • Java

  • Kotlin

public class SimpleMovieLister {

	private MovieFinder movieFinder;

	@Autowired
	public void setMovieFinder(MovieFinder movieFinder) {
		this.movieFinder = movieFinder;
	}

	// ...
}
class SimpleMovieLister {

	@set:Autowired
	lateinit var movieFinder: MovieFinder

	// ...

}

你还可以将注解应用于具有任意名称和多个参数的方法,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	private MovieCatalog movieCatalog;

	private CustomerPreferenceDao customerPreferenceDao;

	@Autowired
	public void prepare(MovieCatalog movieCatalog,
			CustomerPreferenceDao customerPreferenceDao) {
		this.movieCatalog = movieCatalog;
		this.customerPreferenceDao = customerPreferenceDao;
	}

	// ...
}
class MovieRecommender {

	private lateinit var movieCatalog: MovieCatalog

	private lateinit var customerPreferenceDao: CustomerPreferenceDao

	@Autowired
	fun prepare(movieCatalog: MovieCatalog,
				customerPreferenceDao: CustomerPreferenceDao) {
		this.movieCatalog = movieCatalog
		this.customerPreferenceDao = customerPreferenceDao
	}

	// ...
}

你还可以将 @Autowired 应用于字段,甚至可以将其与构造函数混合使用,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	private final CustomerPreferenceDao customerPreferenceDao;

	@Autowired
	private MovieCatalog movieCatalog;

	@Autowired
	public MovieRecommender(CustomerPreferenceDao customerPreferenceDao) {
		this.customerPreferenceDao = customerPreferenceDao;
	}

	// ...
}
class MovieRecommender @Autowired constructor(
	private val customerPreferenceDao: CustomerPreferenceDao) {

	@Autowired
	private lateinit var movieCatalog: MovieCatalog

	// ...
}

请确保你的目标组件(例如,MovieCatalogCustomerPreferenceDao)始终通过你用于 @Autowired 注解的注入点的类型来声明。否则,注入可能会在运行时因“未找到类型匹配”错误而失败。对于 XML 定义的 bean 或通过 classpath 扫描找到的组件类,容器通常会提前知道具体类型。然而,对于 @Bean 工厂方法,你需要确保声明的返回类型足够具有表现力。对于实现多个接口的组件或可能通过其实现类型引用的组件,请考虑在工厂方法上声明最具体的返回类型(至少与引用你的 bean 的注入点所要求的具体程度相同)。

[id="beans-autowired-annotation-self-injection"][id="beans-autowired-annotation-self-injection"][id="beans-autowired-annotation-self-injection"]自注入

@Autowired 也考虑自引用进行注入(即,引用回当前正在注入的 bean)。 但请注意,自注入是一种回退机制。对其他组件的常规依赖始终具有优先权。从这个意义上讲,自引用不参与常规的自动装配候选选择,因此尤其永远不是主要的。相反,它们总是以最低优先级结束。 在实践中,自引用应仅作为最后的手段使用——例如,通过 bean 的事务代理调用同一实例上的其他方法。作为替代方案,在这种情况下,可以考虑将受影响的方法分解到一个单独的委托 bean 中。 另一种替代方法是使用 @Resource,它可以通过其唯一名称获取指向当前 bean 的代理。

尝试在同一个 @Configuration 类中注入 @Bean 方法的结果也实际上是一种自引用场景。可以懒惰地在实际需要的方法签名中解析此类引用(而不是在配置类中的自动装配字段中),或者将受影响的 @Bean 方法声明为 static,将它们与包含配置类实例及其生命周期解耦。 否则,此类 bean 仅在回退阶段考虑,而其他配置类上的匹配 bean 将被选为主要候选(如果可用)。

你还可以通过将 @Autowired 注解添加到期望该类型的数组的字段或方法中,指示 Spring 从 ApplicationContext 提供特定类型的所有 bean,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	private MovieCatalog[] movieCatalogs;

	// ...
}
class MovieRecommender {

	@Autowired
	private lateinit var movieCatalogs: Array<MovieCatalog>

	// ...
}

对于类型化集合也是如此,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	private Set<MovieCatalog> movieCatalogs;

	@Autowired
	public void setMovieCatalogs(Set<MovieCatalog> movieCatalogs) {
		this.movieCatalogs = movieCatalogs;
	}

	// ...
}
class MovieRecommender {

	@Autowired
	lateinit var movieCatalogs: Set<MovieCatalog>

	// ...
}

如果希望数组或列表中的项目按特定顺序排序,你的目标 bean 可以实现 org.springframework.core.Ordered 接口或使用 @Order 或标准 @Priority 注解。否则,它们的顺序遵循容器中相应目标 bean 定义的注册顺序。 你可以在目标类级别和 @Bean 方法上声明 @Order 注解,可能用于单个 bean 定义(在多个定义使用相同 bean 类的情况下)。@Order 值可能会影响注入点的优先级,但请注意,它们不影响单例启动顺序,这与由依赖关系和 @DependsOn 声明决定的正交问题无关。 请注意,配置类上的 @Order 注解仅影响启动时整个配置类集中的评估顺序。此类配置级别的顺序值完全不影响所包含的 @Bean 方法。对于 bean 级别的排序,每个 @Bean 方法都需要有自己的 @Order 注解,该注解适用于特定 bean 类型(由工厂方法返回)的多个匹配项集合中。 请注意,标准 jakarta.annotation.Priority 注解在 @Bean 级别不可用,因为它不能在方法上声明。它的语义可以通过 @Order 值与每个类型上的单个 bean 的 @Primary 结合来建模。

即使是类型化的 Map 实例也可以自动装配,只要预期的键类型是 String。map 值包含所有预期类型的 bean,键包含相应的 bean 名称,如以下示例所示:

  • Java

  • Kotlin

public class MovieRecommender {

	private Map<String, MovieCatalog> movieCatalogs;

	@Autowired
	public void setMovieCatalogs(Map<String, MovieCatalog> movieCatalogs) {
		this.movieCatalogs = movieCatalogs;
	}

	// ...
}
class MovieRecommender {

	@Autowired
	lateinit var movieCatalogs: Map<String, MovieCatalog>

	// ...
}

默认情况下,当给定注入点没有匹配的候选 bean 可用时,自动装配会失败。在声明数组、集合或映射的情况下,至少需要一个匹配元素。

默认行为是将带注解的方法和字段视为指示必需的依赖项。你可以更改此行为,如以下示例所示,通过将其标记为非必需(即,通过将 @Autowired 中的 required 属性设置为 false)来使框架跳过无法满足的注入点:

  • Java

  • Kotlin

public class SimpleMovieLister {

	private MovieFinder movieFinder;

	@Autowired(required = false)
	public void setMovieFinder(MovieFinder movieFinder) {
		this.movieFinder = movieFinder;
	}

	// ...
}
class SimpleMovieLister {

	@Autowired(required = false)
	var movieFinder: MovieFinder? = null

	// ...
}

如果一个非必需方法的一个或多个依赖项(在多个参数的情况下)不可用,则该方法将完全不会被调用。在这种情况下,一个非必需字段将完全不会被填充,其默认值将保持不变。 换句话说,将 required 属性设置为 false 表示相应的属性对于自动装配目的而言是 可选的,并且如果无法自动装配,则该属性将被忽略。这允许属性被分配默认值,这些默认值可以通过依赖注入选择性地覆盖。

注入的构造函数和工厂方法参数是一种特殊情况,因为 @Autowired 中的 required 属性具有不同的含义,这是由于 Spring 的构造函数解析算法可能处理多个构造函数。构造函数和工厂方法参数默认是必需的,但在单构造函数场景中有一些特殊规则,例如多元素注入点(数组、集合、映射)在没有匹配 bean 可用时解析为空实例。这允许一种常见的实现模式,其中所有依赖项都可以在一个独特的、多参数的构造函数中声明——例如,声明为没有 @Autowired 注解的单个公共构造函数。

任何给定 bean 类中只有一个构造函数可以声明 @Autowired 并将 required 属性设置为 true,指示当用作 Spring bean 时要自动装配的构造函数。因此,如果 required 属性保留其默认值 true,则只能有一个构造函数可以注解 @Autowired。如果多个构造函数声明了该注解,它们都必须声明 required=false 才能被视为自动装配的候选者(类似于 XML 中的 autowire=constructor)。将选择具有最多依赖项的构造函数,这些依赖项可以通过 Spring 容器中的匹配 bean 来满足。如果没有候选者可以满足,则将使用主/默认构造函数(如果存在)。类似地,如果一个类声明了多个构造函数但都没有注解 @Autowired,则将使用主/默认构造函数(如果存在)。如果一个类只声明了一个构造函数,它将始终被使用,即使没有注解。请注意,带注解的构造函数不必是 public。

或者,你可以通过 Java 8 的 java.util.Optional 来表达特定依赖项的非必需性质,如以下示例所示:

public class SimpleMovieLister {

	@Autowired
	public void setMovieFinder(Optional<MovieFinder> movieFinder) {
		...
	}
}

你还可以使用参数级别的 @Nullable 注解(任何包中的任何类型——例如,JSR-305 中的 javax.annotation.Nullable)或直接利用 Kotlin 内置的 null 安全支持:

  • Java

  • Kotlin

public class SimpleMovieLister {

	@Autowired
	public void setMovieFinder(@Nullable MovieFinder movieFinder) {
		...
	}
class SimpleMovieLister {

	@Autowired
	var movieFinder: MovieFinder? = null

	// ...
}

Spring Framework 6.2 尚不支持类型级别的 @Nullable 注解(例如来自 JSpecify)。你需要升级到 Spring Framework 7.0,届时框架将检测类型级别注解并在其自己的代码库中一致地声明 JSpecify。

你还可以将 @Autowired 用于众所周知的可解析依赖项接口:BeanFactoryApplicationContextEnvironmentResourceLoaderApplicationEventPublisherMessageSource。这些接口及其扩展接口,例如 ConfigurableApplicationContextResourcePatternResolver,会自动解析,无需特殊设置。以下示例自动装配一个 ApplicationContext 对象:

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	private ApplicationContext context;

	public MovieRecommender() {
	}

	// ...
}
class MovieRecommender {

	@Autowired
	lateinit var context: ApplicationContext

	// ...
}

@Autowired@Inject@Value@Resource 注解由 Spring BeanPostProcessor 实现处理。这意味着你不能在自己的 BeanPostProcessorBeanFactoryPostProcessor 类型(如果有)中应用这些注解。 这些类型必须通过使用 XML 或 Spring @Bean 方法明确“连接”起来。