Spring Docs

主题

使用 JSR 330 标准注解 (Using JSR 330 Standard Annotations) ​

Spring 支持 JSR-330 标准注解（依赖注入）。这些注解的扫描方式与 Spring 自有注解相同。要使用它们，你需要将相关的 JAR 包添加到类路径中。

::: note 注意 如果你使用 Maven，jakarta.inject 构件在标准 Maven 仓库中可用（https://repo.maven.apache.org/maven2/jakarta/inject/jakarta.inject-api/2.0.0/）。你可以将以下依赖添加到你的 pom.xml 文件中：

xml
<dependency>
	<groupId>jakarta.inject</groupId>
	<artifactId>jakarta.inject-api</artifactId>
	<version>2.0.0</version>
</dependency>

:::

使用 @Inject 和 @Named 进行依赖注入 ​

你可以使用 @jakarta.inject.Inject 来代替 @Autowired，如下所示：

java
import jakarta.inject.Inject;

public class SimpleMovieLister {

	private MovieFinder movieFinder;

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

	public void listMovies() {
		this.movieFinder.findMovies(...);
		// ...
	}
}
kotlin
import jakarta.inject.Inject

class SimpleMovieLister {

	@Inject
	lateinit var movieFinder: MovieFinder


	fun listMovies() {
		movieFinder.findMovies(...)
		// ...
	}
}

与 @Autowired 一样，你可以在字段级别、方法级别和构造函数参数级别使用 @Inject。此外，你可以将注入点声明为 Provider，从而允许按需访问较短作用域的 Bean，或通过调用 Provider.get() 延迟访问其他 Bean。以下示例是前一个示例的变体：

java
import jakarta.inject.Inject;
import jakarta.inject.Provider;

public class SimpleMovieLister {

	private Provider<MovieFinder> movieFinder;

	@Inject
	public void setMovieFinder(Provider<MovieFinder> movieFinder) {
		this.movieFinder = movieFinder;
	}

	public void listMovies() {
		this.movieFinder.get().findMovies(...);
		// ...
	}
}
kotlin
import jakarta.inject.Inject
import jakarta.inject.Provider

class SimpleMovieLister {

	@Inject
	lateinit var movieFinder: Provider<MovieFinder>


	fun listMovies() {
		movieFinder.get().findMovies(...)
		// ...
	}
}

如果你想为应注入的依赖项使用限定名称，应使用 @Named 注解，如下例所示：

java
import jakarta.inject.Inject;
import jakarta.inject.Named;

public class SimpleMovieLister {

	private MovieFinder movieFinder;

	@Inject
	public void setMovieFinder(@Named("main") MovieFinder movieFinder) {
		this.movieFinder = movieFinder;
	}

	// ...
}
kotlin
import jakarta.inject.Inject
import jakarta.inject.Named

class SimpleMovieLister {

	private lateinit var movieFinder: MovieFinder

	@Inject
	fun setMovieFinder(@Named("main") movieFinder: MovieFinder) {
		this.movieFinder = movieFinder
	}

	// ...
}

与 @Autowired 一样，@Inject 也可以与 java.util.Optional 或 @Nullable 一起使用。这在这里甚至更适用，因为 @Inject 没有 required 属性。下面的一组示例展示了如何使用 @Inject 和 @Nullable：

java
public class SimpleMovieLister {

	@Inject
	public void setMovieFinder(Optional<MovieFinder> movieFinder) {
		// ...
	}
}
java
public class SimpleMovieLister {

	@Inject
	public void setMovieFinder(@Nullable MovieFinder movieFinder) {
		// ...
	}
}
kotlin
class SimpleMovieLister {

	@Inject
	var movieFinder: MovieFinder? = null
}

@Named 和 @ManagedBean：@Component 注解的标准等价物 ​

你可以使用 @jakarta.inject.Named 或 jakarta.annotation.ManagedBean 来代替 @Component，如下例所示：

java
import jakarta.inject.Inject;
import jakarta.inject.Named;

@Named("movieListener")  // 也可以使用 @ManagedBean("movieListener")
public class SimpleMovieLister {

	private MovieFinder movieFinder;

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

	// ...
}
kotlin
import jakarta.inject.Inject
import jakarta.inject.Named

@Named("movieListener")  // 也可以使用 @ManagedBean("movieListener")
class SimpleMovieLister {

	@Inject
	lateinit var movieFinder: MovieFinder

	// ...
}

不指定组件名称而使用 @Component 是非常常见的。@Named 也可以以类似的方式使用，如下例所示：

java
import jakarta.inject.Inject;
import jakarta.inject.Named;

@Named
public class SimpleMovieLister {

	private MovieFinder movieFinder;

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

	// ...
}
kotlin
import jakarta.inject.Inject
import jakarta.inject.Named

@Named
class SimpleMovieLister {

	@Inject
	lateinit var movieFinder: MovieFinder

	// ...
}

当你使用 @Named 或 @ManagedBean 时，你可以像使用 Spring 注解时一样使用组件扫描，如下例所示：

java
@Configuration
@ComponentScan(basePackages = "org.example")
public class AppConfig  {
	// ...
}
kotlin
@Configuration
@ComponentScan(basePackages = ["org.example"])
class AppConfig  {
	// ...
}

::: note 注意 与 @Component 不同，JSR-330 的 @Named 和 JSR-250 的 @ManagedBean 注解是 不可组合 (not composable) 的。你应该使用 Spring 的构造型模型（Stereotype model）来构建自定义组件注解。 :::

JSR-330 标准注解的局限性 ​

当你使用标准注解时，你应该知道一些重要的功能是不可用的，如下表所示：

表 1. Spring 组件模型元素与 JSR-330 变体的比较

Springjakarta.inject.*jakarta.inject 限制 / 说明
@Autowired@Inject@Inject 没有 required 属性。可以结合 Java 8 的 Optional 使用。
@Component@Named / @ManagedBeanJSR-330 不提供组合模型，只提供一种识别命名组件的方法。
@Scope("singleton")@SingletonJSR-330 的默认作用域类似于 Spring 的 prototype。但是，为了与 Spring 的通用默认值保持一致，在 Spring 容器中声明的 JSR-330 Bean 默认是 singleton。要使用 singleton 以外的作用域，你应该使用 Spring 的 @Scope 注解。jakarta.inject 也提供了一个 jakarta.inject.Scope 注解，但它仅用于创建自定义注解。
@Qualifier@Qualifier / @Namedjakarta.inject.Qualifier 只是一个用于构建自定义限定符的元注解。具体的字符串限定符（如 Spring 带有值的 @Qualifier）可以通过 jakarta.inject.Named 关联。
@Value-无等价物。
@Lazy-无等价物。
ObjectFactoryProviderjakarta.inject.Provider 是 Spring ObjectFactory 的直接替代品，只是方法名更短（get()）。它也可以与 Spring 的 @Autowired 结合使用，或者用于非注解的构造函数和 Setter 方法。

补充教学 —— 为什么要了解 JSR-330？ ​

作为开发者，你可能会问：“既然 Spring 的 @Autowired 这么好用，为什么我还要学 @Inject？”

1. 跨框架的通用性 JSR-330 (Dependency Injection for Java) 是一套 Java 标准。这意味着如果你编写的是一个通用的类库，或者你希望你的代码能够在不同的 DI 框架（如 Google Guice, Dagger, CDIs 等）之间无缝迁移，使用标准注解是更好的选择。

2. 核心区别：Required 属性 这是最显而易见的区别：

  • Spring 的 @Autowired(required = false) 允许依赖缺失。
  • JSR-330 的 @Inject 强制要求依赖必须存在。如果可能缺失，你必须使用 Optional<T>、Provider<T> 或者 @Nullable。这在某种程度上强制了更严谨的代码风格。

3. Provider 的妙用 虽然 Spring 有对应的 ObjectFactory，但 jakarta.inject.Provider 在业界更为流行。当你需要以下功能时，它是神器：

  • 延迟加载：只有在调用 provider.get() 时，对应的 Bean 才会真正执行初始化。
  • 打破循环依赖：如果 A 依赖 B，B 依赖 A，将其中一方注入为 Provider 可以有效缓解某些循环依赖问题。
  • 在 Singleton 中注入 Prototype：如果你在单例 Bean 中直接注入一个原型 Bean，该原型 Bean 只会被注入一次。但如果你注入 Provider<PrototypeBean>，由于每次 get() 都会向容器请求，你可以方便地获得多个原型实例。

4. 组合注解的缺失 这是 Spring 最大的优势所在。你可以把 @Service 和 @MyLog 组合成一个 @LoggingService，但在 JSR-330 世界里，你做不到这一点。如果你深度依赖 Spring 的“元注解（Meta-annotation）”特性，请坚持使用 Spring 自己的构造型注解。

总结建议：

  • 如果你在开发一个纯粹的 Spring 应用程序，请放心使用 Spring 的 @Autowired 和 @Component，它们功能更丰富、灵活性更高。
  • 如果你在开发公共库 (Library) 或对代码可移植性有极高要求，请使用 JSR-330 标准注解。

Based on Spring Framework.

Copyright © 2024 Spring 中文社区