类路径扫描和托管组件

本章中的大多数示例使用 XML 来指定生成 Spring 容器中每个 BeanDefinition 的配置元数据。上一节 (基于注解的容器配置) 演示了如何通过源代码级别的注解提供大量配置元数据。但是，即使在这些示例中，"基本" bean 定义也是在 XML 文件中显式定义的，而注解只驱动依赖注入。本节介绍了一种通过扫描类路径来隐式检测候选组件的选项。候选组件是与过滤器条件匹配并具有在容器中注册的相应 bean 定义的类。这消除了使用 XML 执行 bean 注册的需要。相反，您可以使用注解（例如，@Component）、AspectJ 类型表达式或您自己的自定义过滤器条件来选择哪些类在容器中注册了 bean 定义。

您可以使用 Java 而不是 XML 文件来定义 bean。查看 @Configuration、@Bean、@Import 和 @DependsOn 注解，了解如何使用这些功能的示例。

@Component 和其他立体类型注解

@Repository 注解是任何履行存储库角色或立体类型的类的标记（也称为数据访问对象或 DAO）。此标记的用途之一是自动异常转换，如 异常转换 中所述。

Spring 提供了更多立体注释：@Component、@Service 和 @Controller。@Component 是任何 Spring 管理组件的通用立体注释。@Repository、@Service 和 @Controller 是 @Component 的特化，用于更具体的用例（分别在持久层、服务层和表示层）。因此，您可以使用 @Component 注释您的组件类，但通过使用 @Repository、@Service 或 @Controller 注释它们，您的类更适合由工具处理或与方面关联。例如，这些立体注释是切点的理想目标。@Repository、@Service 和 @Controller 也可能在 Spring 框架的未来版本中具有额外的语义。因此，如果您在使用 @Component 或 @Service 用于服务层之间进行选择，@Service 显然是更好的选择。同样，如前所述，@Repository 已经支持作为持久层中自动异常转换的标记。

使用元注释和组合注释

Spring 提供的许多注释可以在您自己的代码中用作元注释。元注释是可应用于另一个注释的注释。例如，前面提到的 @Service 注释使用 @Component 进行元注释，如下例所示

  • Java

  • Kotlin

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component (1)
public @interface Service {

	// ...
}
1 @Component 使 @Service 的处理方式与 @Component 相同。 
@Target(AnnotationTarget.TYPE)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
@Component (1)
annotation class Service {

	// ...
}
1 @Component 使 @Service 的处理方式与 @Component 相同。

您还可以组合元注释来创建“组合注释”。例如，来自 Spring MVC 的 @RestController 注释由 @Controller 和 @ResponseBody 组成。

此外，组合注释可以选择性地重新声明元注释中的属性以允许自定义。当您只想公开元注释属性的子集时，这可能特别有用。例如，Spring 的 @SessionScope 注释将范围名称硬编码为 session，但仍然允许自定义 proxyMode。以下清单显示了 SessionScope 注释的定义

  • Java

  • Kotlin

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Scope(WebApplicationContext.SCOPE_SESSION)
public @interface SessionScope {

	/**
	 * Alias for {@link Scope#proxyMode}.
	 * <p>Defaults to {@link ScopedProxyMode#TARGET_CLASS}.
	 */
	@AliasFor(annotation = Scope.class)
	ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;

}
@Target(AnnotationTarget.TYPE, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
@Scope(WebApplicationContext.SCOPE_SESSION)
annotation class SessionScope(
		@get:AliasFor(annotation = Scope::class)
		val proxyMode: ScopedProxyMode = ScopedProxyMode.TARGET_CLASS
)

然后，您可以使用 @SessionScope 而不声明 proxyMode，如下所示

  • Java

  • Kotlin

@Service
@SessionScope
public class SessionScopedService {
	// ...
}
@Service
@SessionScope
class SessionScopedService {
	// ...
}

您也可以覆盖proxyMode的值，如下例所示

  • Java

  • Kotlin

@Service
@SessionScope(proxyMode = ScopedProxyMode.INTERFACES)
public class SessionScopedUserService implements UserService {
	// ...
}
@Service
@SessionScope(proxyMode = ScopedProxyMode.INTERFACES)
class SessionScopedUserService : UserService {
	// ...
}

有关更多详细信息，请参阅Spring 注解编程模型维基页面。

自动检测类并注册 Bean 定义

Spring 可以自动检测符合特定模式的类，并使用相应的BeanDefinition实例注册到ApplicationContext。例如，以下两个类符合此类自动检测的条件

  • Java

  • Kotlin

@Service
public class SimpleMovieLister {

	private MovieFinder movieFinder;

	public SimpleMovieLister(MovieFinder movieFinder) {
		this.movieFinder = movieFinder;
	}
}
@Service
class SimpleMovieLister(private val movieFinder: MovieFinder)

  • Java

  • Kotlin

@Repository
public class JpaMovieFinder implements MovieFinder {
	// implementation elided for clarity
}
@Repository
class JpaMovieFinder : MovieFinder {
	// implementation elided for clarity
}

要自动检测这些类并注册相应的 Bean，您需要在您的@Configuration类中添加@ComponentScan，其中basePackages属性是这两个类的共同父包。（或者，您可以指定一个用逗号、分号或空格分隔的列表，其中包含每个类的父包。）

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "org.example")
public class AppConfig  {
	// ...
}
@Configuration
@ComponentScan(basePackages = ["org.example"])
class AppConfig  {
	// ...
}
为了简洁起见，前面的示例可以使用该注解的value属性（即@ComponentScan("org.example")）。

以下替代方案使用 XML

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context
		https://www.springframework.org/schema/context/spring-context.xsd">

	<context:component-scan base-package="org.example"/>

</beans>
使用<context:component-scan>会隐式启用<context:annotation-config>的功能。在使用<context:component-scan>时，通常不需要包含<context:annotation-config>元素。

扫描类路径包需要类路径中存在相应的目录条目。当您使用 Ant 构建 JAR 时，请确保您没有激活 JAR 任务的仅文件开关。此外，基于某些环境中的安全策略，类路径目录可能无法公开——例如，JDK 1.7.0_45 及更高版本上的独立应用程序（这需要在您的清单文件中设置“Trusted-Library”——请参阅stackoverflow.com/questions/19394570/java-jre-7u45-breaks-classloader-getresources）。

在 JDK 9 的模块路径（Jigsaw）上，Spring 的类路径扫描通常按预期工作。但是，请确保您的组件类在您的module-info描述符中导出。如果您希望 Spring 调用您类的非公共成员，请确保它们是“打开的”（也就是说，它们在您的module-info描述符中使用opens声明而不是exports声明）。

此外，当您使用 component-scan 元素时，AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor都会被隐式包含。这意味着这两个组件会自动检测并相互连接——所有这些都无需在 XML 中提供任何 Bean 配置元数据。

您可以通过将annotation-config属性的值设置为false来禁用AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor的注册。

使用过滤器自定义扫描

默认情况下，仅检测到使用@Component、@Repository、@Service、@Controller、@Configuration或自定义注释（本身使用@Component注释）注释的类作为候选组件。但是，您可以通过应用自定义过滤器来修改和扩展此行为。将它们添加为@ComponentScan注释的includeFilters或excludeFilters属性（或作为<context:component-scan>元素在 XML 配置中的<context:include-filter />或<context:exclude-filter />子元素）。每个过滤器元素都需要type和expression属性。下表描述了过滤选项

表 1. 过滤器类型
过滤器类型 示例表达式 描述

annotation（默认）

org.example.SomeAnnotation

目标组件类型级别上存在或元存在的注释。

assignable

org.example.SomeClass

目标组件可分配到的类（或接口）（扩展或实现）。

aspectj

org.example..*Service+

目标组件匹配的 AspectJ 类型表达式。

regex

org\.example\.Default.*

目标组件类名匹配的正则表达式。

custom

org.example.MyTypeFilter

org.springframework.core.type.TypeFilter接口的自定义实现。

以下示例显示了忽略所有@Repository注释并使用“存根”存储库的配置

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "org.example",
		includeFilters = @Filter(type = FilterType.REGEX, pattern = ".*Stub.*Repository"),
		excludeFilters = @Filter(Repository.class))
public class AppConfig {
	// ...
}
@Configuration
@ComponentScan(basePackages = ["org.example"],
		includeFilters = [Filter(type = FilterType.REGEX, pattern = [".*Stub.*Repository"])],
		excludeFilters = [Filter(Repository::class)])
class AppConfig {
	// ...
}

以下清单显示了等效的 XML

<beans>
	<context:component-scan base-package="org.example">
		<context:include-filter type="regex"
				expression=".*Stub.*Repository"/>
		<context:exclude-filter type="annotation"
				expression="org.springframework.stereotype.Repository"/>
	</context:component-scan>
</beans>
您还可以通过在注释上设置useDefaultFilters=false或通过在<component-scan/>元素的属性中提供use-default-filters="false"来禁用默认过滤器。这实际上禁用了对使用@Component、@Repository、@Service、@Controller、@RestController或@Configuration注释或元注释的类的自动检测。

在组件中定义 Bean 元数据

Spring 组件还可以向容器贡献 Bean 定义元数据。您可以使用与在@Configuration注释的类中定义 Bean 元数据相同的@Bean注释来执行此操作。以下示例显示了如何执行此操作

  • Java

  • Kotlin

@Component
public class FactoryMethodComponent {

	@Bean
	@Qualifier("public")
	public TestBean publicInstance() {
		return new TestBean("publicInstance");
	}

	public void doWork() {
		// Component method implementation omitted
	}
}
@Component
class FactoryMethodComponent {

	@Bean
	@Qualifier("public")
	fun publicInstance() = TestBean("publicInstance")

	fun doWork() {
		// Component method implementation omitted
	}
}

前面的类是一个 Spring 组件，在其doWork()方法中具有特定于应用程序的代码。但是，它还贡献了一个 Bean 定义，该定义具有一个指向publicInstance()方法的工厂方法。@Bean注释标识工厂方法和其他 Bean 定义属性，例如通过@Qualifier注释的限定符值。可以指定的其他方法级注释是@Scope、@Lazy和自定义限定符注释。

除了用于组件初始化的作用外，您还可以将@Lazy注释放在使用@Autowired或@Inject标记的注入点上。在这种情况下，它会导致注入延迟解析代理。但是，这种代理方法相当有限。对于复杂的延迟交互，尤其是在与可选依赖项结合使用时，我们建议使用ObjectProvider<MyTargetBean>。

如前所述，支持自动装配字段和方法，并额外支持自动装配 @Bean 方法。以下示例展示了如何实现。

  • Java

  • Kotlin

@Component
public class FactoryMethodComponent {

	private static int i;

	@Bean
	@Qualifier("public")
	public TestBean publicInstance() {
		return new TestBean("publicInstance");
	}

	// use of a custom qualifier and autowiring of method parameters
	@Bean
	protected TestBean protectedInstance(
			@Qualifier("public") TestBean spouse,
			@Value("#{privateInstance.age}") String country) {
		TestBean tb = new TestBean("protectedInstance", 1);
		tb.setSpouse(spouse);
		tb.setCountry(country);
		return tb;
	}

	@Bean
	private TestBean privateInstance() {
		return new TestBean("privateInstance", i++);
	}

	@Bean
	@RequestScope
	public TestBean requestScopedInstance() {
		return new TestBean("requestScopedInstance", 3);
	}
}
@Component
class FactoryMethodComponent {

	companion object {
		private var i: Int = 0
	}

	@Bean
	@Qualifier("public")
	fun publicInstance() = TestBean("publicInstance")

	// use of a custom qualifier and autowiring of method parameters
	@Bean
	protected fun protectedInstance(
			@Qualifier("public") spouse: TestBean,
			@Value("#{privateInstance.age}") country: String) = TestBean("protectedInstance", 1).apply {
		this.spouse = spouse
		this.country = country
	}

	@Bean
	private fun privateInstance() = TestBean("privateInstance", i++)

	@Bean
	@RequestScope
	fun requestScopedInstance() = TestBean("requestScopedInstance", 3)
}

该示例将 String 方法参数 country 自动装配到名为 privateInstance 的另一个 bean 上的 age 属性的值。Spring 表达式语言元素通过 #{ <expression> } 符号定义属性的值。对于 @Value 注解，表达式解析器预先配置为在解析表达式文本时查找 bean 名称。

从 Spring Framework 4.3 开始，您还可以声明类型为 InjectionPoint（或其更具体的子类：DependencyDescriptor）的工厂方法参数，以访问触发当前 bean 创建的请求注入点。请注意，这仅适用于实际创建 bean 实例，不适用于注入现有实例。因此，此功能对于原型范围的 bean 意义最大。对于其他范围，工厂方法仅在给定范围内看到触发新 bean 实例创建的注入点（例如，触发创建延迟单例 bean 的依赖项）。在这些情况下，您可以谨慎地使用提供的注入点元数据。以下示例展示了如何使用 InjectionPoint。

  • Java

  • Kotlin

@Component
public class FactoryMethodComponent {

	@Bean @Scope("prototype")
	public TestBean prototypeInstance(InjectionPoint injectionPoint) {
		return new TestBean("prototypeInstance for " + injectionPoint.getMember());
	}
}
@Component
class FactoryMethodComponent {

	@Bean
	@Scope("prototype")
	fun prototypeInstance(injectionPoint: InjectionPoint) =
			TestBean("prototypeInstance for ${injectionPoint.member}")
}

常规 Spring 组件中的 @Bean 方法的处理方式不同于 Spring @Configuration 类中的对应方法。区别在于 @Component 类不会使用 CGLIB 进行增强以拦截方法和字段的调用。CGLIB 代理是 @Configuration 类中 @Bean 方法内调用方法或字段的方式，它创建与协作对象的 bean 元数据引用。这些方法不是使用正常的 Java 语义调用，而是通过容器调用，以提供 Spring bean 的通常生命周期管理和代理，即使通过对 @Bean 方法的编程调用引用其他 bean 也是如此。相反，在普通 @Component 类中，@Bean 方法内调用方法或字段具有标准的 Java 语义，没有特殊的 CGLIB 处理或其他约束适用。

您可以将 @Bean 方法声明为 static，允许在不创建其包含的配置类作为实例的情况下调用它们。当定义后处理器 bean（例如，类型为 BeanFactoryPostProcessor 或 BeanPostProcessor）时，这一点特别有意义，因为这些 bean 在容器生命周期的早期初始化，并且应该避免在该点触发配置的其他部分。

由于技术限制，对静态@Bean方法的调用永远不会被容器拦截，即使是在@Configuration类中（如本节前面所述），因为CGLIB子类化只能覆盖非静态方法。因此，对另一个@Bean方法的直接调用具有标准的Java语义，导致直接从工厂方法本身返回一个独立的实例。

@Bean方法的Java语言可见性不会对Spring容器中生成的bean定义产生直接影响。您可以自由地根据需要在非@Configuration类中声明您的工厂方法，以及在任何地方声明静态方法。但是，@Configuration类中的常规@Bean方法需要是可覆盖的，也就是说，它们不能声明为private或final。

@Bean方法也会在给定组件或配置类的基类上被发现，以及在组件或配置类实现的接口中声明的Java 8默认方法上。这允许在组合复杂的配置安排方面有很大的灵活性，甚至可以通过Java 8默认方法实现多重继承，从Spring 4.2开始。

最后，一个类可以为同一个bean包含多个@Bean方法，作为多个工厂方法的安排，根据运行时可用的依赖关系使用。这与在其他配置场景中选择“最贪婪”的构造函数或工厂方法的算法相同：在构造时，选择具有最多可满足依赖关系的变体，类似于容器在多个@Autowired构造函数之间进行选择的方式。

命名自动检测的组件

当一个组件作为扫描过程的一部分被自动检测时，它的bean名称由该扫描器已知的BeanNameGenerator策略生成。

默认情况下，使用AnnotationBeanNameGenerator。对于Spring stereotype annotations，如果您通过注释的value属性提供一个名称，该名称将用作相应bean定义中的名称。当使用以下JSR-250和JSR-330注释代替Spring stereotype注释时，此约定也适用：@jakarta.annotation.ManagedBean、@javax.annotation.ManagedBean、@jakarta.inject.Named和@javax.inject.Named。

从Spring Framework 6.1开始，用于指定bean名称的注释属性的名称不再需要是value。自定义stereotype注释可以声明一个具有不同名称（例如name）的属性，并使用@AliasFor(annotation = Component.class, attribute = "value")注释该属性。有关具体示例，请参见ControllerAdvice#name()的源代码声明。

从Spring Framework 6.1开始，对基于约定的stereotype名称的支持已弃用，将在框架的未来版本中删除。因此，自定义stereotype注释必须使用@AliasFor为@Component中的value属性声明显式别名。有关具体示例，请参见Repository#value()和ControllerAdvice#name()的源代码声明。

如果无法从这样的注解中推导出显式 bean 名称，或者对于任何其他检测到的组件（例如由自定义过滤器发现的组件），默认 bean 名称生成器将返回未大写的非限定类名。例如，如果检测到以下组件类，则名称将为 myMovieLister 和 movieFinderImpl。

  • Java

  • Kotlin

@Service("myMovieLister")
public class SimpleMovieLister {
	// ...
}
@Service("myMovieLister")
class SimpleMovieLister {
	// ...
}

  • Java

  • Kotlin

@Repository
public class MovieFinderImpl implements MovieFinder {
	// ...
}
@Repository
class MovieFinderImpl : MovieFinder {
	// ...
}

如果您不想依赖默认的 bean 命名策略，可以提供自定义的 bean 命名策略。首先，实现 BeanNameGenerator 接口，并确保包含一个默认的无参数构造函数。然后，在配置扫描器时提供完全限定的类名，如下面的示例注解和 bean 定义所示。

如果您遇到命名冲突，原因是多个自动检测到的组件具有相同的非限定类名（即，具有相同名称但位于不同包中的类），您可能需要配置一个 BeanNameGenerator，该生成器默认将完全限定的类名用作生成的 bean 名称。从 Spring Framework 5.2.3 开始，位于 org.springframework.context.annotation 包中的 FullyQualifiedAnnotationBeanNameGenerator 可用于此目的。

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "org.example", nameGenerator = MyNameGenerator.class)
public class AppConfig {
	// ...
}
@Configuration
@ComponentScan(basePackages = ["org.example"], nameGenerator = MyNameGenerator::class)
class AppConfig {
	// ...
}
<beans>
	<context:component-scan base-package="org.example"
		name-generator="org.example.MyNameGenerator" />
</beans>

一般来说，请考虑在其他组件可能显式引用它时使用注解指定名称。另一方面，只要容器负责连接，自动生成的名称就足够了。

为自动检测到的组件提供范围

与一般的 Spring 管理组件一样，自动检测到的组件的默认范围和最常见范围是 singleton。但是，有时您需要不同的范围，可以通过 @Scope 注解指定。您可以在注解中提供范围的名称，如下面的示例所示

  • Java

  • Kotlin

@Scope("prototype")
@Repository
public class MovieFinderImpl implements MovieFinder {
	// ...
}
@Scope("prototype")
@Repository
class MovieFinderImpl : MovieFinder {
	// ...
}
@Scope 注解仅在具体 bean 类（对于带注解的组件）或工厂方法（对于 @Bean 方法）上进行内省。与 XML bean 定义相反，没有 bean 定义继承的概念，类级别的继承层次结构与元数据目的无关。

有关 Spring 上下文中特定于 Web 的范围（例如“request”或“session”）的详细信息，请参阅 请求、会话、应用程序和 WebSocket 范围。与这些范围的预构建注解一样，您也可以使用 Spring 的元注解方法来组合自己的范围注解：例如，一个使用 @Scope("prototype") 作为元注解的自定义注解，可能还会声明一个自定义的范围代理模式。

为了提供自定义的范围解析策略，而不是依赖于基于注解的方法，您可以实现 ScopeMetadataResolver 接口。请确保包含一个默认的无参数构造函数。然后，您可以在配置扫描器时提供完全限定的类名，如下面的注解和 bean 定义示例所示

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "org.example", scopeResolver = MyScopeResolver.class)
public class AppConfig {
	// ...
}
@Configuration
@ComponentScan(basePackages = ["org.example"], scopeResolver = MyScopeResolver::class)
class AppConfig {
	// ...
}
<beans>
	<context:component-scan base-package="org.example" scope-resolver="org.example.MyScopeResolver"/>
</beans>

当使用某些非单例范围时，可能需要为范围对象生成代理。原因在 范围 Bean 作为依赖项 中进行了描述。为此，组件扫描元素上提供了一个 scoped-proxy 属性。三个可能的值是：no、interfaces 和 targetClass。例如，以下配置会导致生成标准的 JDK 动态代理

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "org.example", scopedProxy = ScopedProxyMode.INTERFACES)
public class AppConfig {
	// ...
}
@Configuration
@ComponentScan(basePackages = ["org.example"], scopedProxy = ScopedProxyMode.INTERFACES)
class AppConfig {
	// ...
}
<beans>
	<context:component-scan base-package="org.example" scoped-proxy="interfaces"/>
</beans>

使用注解提供限定符元数据

@Qualifier 注解在 使用限定符微调基于注解的自动装配 中进行了讨论。该部分中的示例演示了使用 @Qualifier 注解和自定义限定符注解来提供细粒度控制，以便在解析自动装配候选者时进行控制。由于这些示例基于 XML bean 定义，因此限定符元数据是通过使用 XML 中 bean 元素的 qualifier 或 meta 子元素在候选 bean 定义上提供的。当依赖于类路径扫描来自动检测组件时，您可以使用候选类上的类型级注解来提供限定符元数据。以下三个示例演示了此技术

  • Java

  • Kotlin

@Component
@Qualifier("Action")
public class ActionMovieCatalog implements MovieCatalog {
	// ...
}
@Component
@Qualifier("Action")
class ActionMovieCatalog : MovieCatalog

  • Java

  • Kotlin

@Component
@Genre("Action")
public class ActionMovieCatalog implements MovieCatalog {
	// ...
}
@Component
@Genre("Action")
class ActionMovieCatalog : MovieCatalog {
	// ...
}

  • Java

  • Kotlin

@Component
@Offline
public class CachingMovieCatalog implements MovieCatalog {
	// ...
}
@Component
@Offline
class CachingMovieCatalog : MovieCatalog {
	// ...
}
与大多数基于注解的替代方案一样，请记住注解元数据绑定到类定义本身，而使用 XML 允许相同类型的多个 bean 提供其限定符元数据的变体，因为该元数据是按实例而不是按类提供的。