此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
类路径扫描和托管组件
本章中的大多数示例都使用 XML 来指定配置元数据,这些元数据
产生每个BeanDefinition
在 Spring 容器中。上一节
(基于注释的容器配置)
演示如何通过源级别提供大量配置元数据
附注。然而,即使在这些示例中,“基本”bean 定义也是显式的
在 XML 文件中定义,而注释仅驱动依赖注入。
本节介绍通过以下方式隐式检测候选组件的选项
扫描类路径。候选组件是与筛选器匹配的类
条件,并在容器中注册了相应的 Bean 定义。
这样就无需使用 XML 来执行 bean 注册。相反,您可以使用
注释(例如,@Component
)、AspectJ 类型表达式或您自己的表达式
自定义过滤器条件,以选择哪些类注册了 Bean 定义
容器。
您可以使用 Java 而不是使用 XML 文件来定义 Bean。看看 |
@Component
和进一步的刻板印象注释
这@Repository
注释是满足存储库(也称为数据访问对象或 DAO)角色或构造型的任何类的标记。用途中
此标记是异常的自动翻译,如异常翻译中所述。
Spring 提供了进一步的构造型注释:@Component
,@Service
和@Controller
.@Component
是任何 Spring 管理组件的通用构造型。@Repository
,@Service
和@Controller
是@Component
为
更具体的用例(在持久性、服务和演示中
层)。因此,您可以使用@Component
,但是,通过用@Repository
,@Service
或@Controller
相反,您的类更适合通过工具进行处理或关联
与方面。例如,这些构造型注释是理想的目标
切入点。@Repository
,@Service
和@Controller
也可能
在 Spring Framework 的未来版本中携带额外的语义。因此,如果你是
在使用@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 . |
您还可以组合元注释以创建“组合注释”。例如
这@RestController
来自 Spring MVC 的注释由@Controller
和@ResponseBody
.
此外,组合的注释可以选择从
meta 注释以允许自定义。当您
只想公开元注释属性的子集。例如,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 Annotation 编程模型 wiki 页面。
自动检测类和注册 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,您需要将@ComponentScan
给你的@Configuration
类,其中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:annotation-config> 元素时使用<context:component-scan> . |
扫描类路径包需要存在相应的目录 类路径中的条目。使用 Ant 构建 JAR 时,请确保不要 激活 JAR 任务的仅文件开关。此外,类路径目录可能不是 根据某些环境中的安全策略公开,例如,在 JDK 1.7.0_45 及更高版本(需要在清单中设置“Trusted-Library”——参见 stackoverflow.com/questions/19394570/java-jre-7u45-breaks-classloader-getresources)。 在模块路径(Java Module System)上,Spring 的类路径扫描通常作为
预期。但是,请确保您的组件类导出在 |
此外,AutowiredAnnotationBeanPostProcessor
和CommonAnnotationBeanPostProcessor
当您使用
component-scan 元素。这意味着这两个组件是自动检测的,并且
连接在一起——所有这些都没有以 XML 形式提供任何 bean 配置元数据。
您可以禁用AutowiredAnnotationBeanPostProcessor 和CommonAnnotationBeanPostProcessor 通过包含annotation-config 属性
值为false . |
使用过滤器自定义扫描
默认情况下,用@Component
,@Repository
,@Service
,@Controller
,@Configuration
,或本身使用@Component
是 唯一检测到的候选组件。但是,您可以修改和扩展此行为通过应用自定义过滤器。将它们添加为includeFilters
或excludeFilters
属性 这@ComponentScan
注释(或作为<context:include-filter />
或<context:exclude-filter />
子元素的<context:component-scan>
元素中的XML 配置)。每个过滤器元素都需要type
和expression
属性。 下表描述了筛选选项:
过滤器类型 | 示例表达式 | 描述 |
---|---|---|
注释(默认) |
|
在目标组件的类型级别存在或元存在的注释。 |
可分配的 |
|
目标组件可分配给(扩展或实现)的类(或接口)。 |
方面J |
|
要由目标组件匹配的 AspectJ 类型表达式。 |
正则表达式 |
|
要与目标组件的类名匹配的正则表达式。 |
习惯 |
|
的自定义实现 |
以下示例显示了忽略所有@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 在
注释或通过提供use-default-filters="false" 作为<component-scan/> 元素。这有效地禁用了对类的自动检测
注释或元注释@Component ,@Repository ,@Service ,@Controller ,@RestController 或@Configuration . |
在组件中定义 Bean 元数据
Spring 组件还可以向容器提供 bean 定义元数据。你可以做
这与相同的@Bean
用于定义 Bean 元数据的注释@Configuration
带注释的类。以下示例显示了如何执行此作:
-
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
注释标识
factory 方法和其他 bean 定义属性,例如通过
这@Qualifier
注解。可以指定的其他方法级注释包括@Scope
,@Lazy
和自定义限定符注释。
除了用于组件初始化的作用外,您还可以将 |
如前所述,支持自动连线字段和方法,并支持额外的支持自动连线@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
设置为age
另一个名为privateInstance
. Spring Expression Language 元素通过符号定义属性的值#{ <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}")
}
这@Bean
常规 Spring 组件中的方法的处理方式与其
弹簧内部的对应物@Configuration
类。不同的是@Component
类不会使用 CGLIB 增强来拦截方法和字段的调用。
CGLIB 代理是调用@Bean
方法
在@Configuration
classes 创建对协作对象的 Bean 元数据引用。
此类方法不是使用正常的 Java 语义调用的,而是通过
container 的生命周期管理与代理,以提供 Spring 的常规生命周期管理和代理
bean,即使通过编程调用@Bean
方法。
相反,在@Bean
plain 中的方法@Component
class 具有标准的 Java 语义,没有特殊的 CGLIB 处理或其他
约束适用。
您可以声明 对静态的调用 Java 语言的可见性
最后,单个类可以容纳多个 |
命名自动检测的组件
当组件在扫描过程中自动检测时,其 bean 名称为
由BeanNameGenerator
该扫描仪已知的策略。
默认情况下,AnnotationBeanNameGenerator
被使用。对于 Spring 构造型注释,
如果您通过注释的value
属性,该名称将用作
相应 bean 定义中的名称。当@jakarta.inject.Named
使用注释代替 Spring 构造型注释。
从 Spring Framework 6.1 开始,用于指定
Bean 名称不再需要value
.自定义构造型注释可以
声明具有不同名称的属性(例如name
) 并注释该属性
跟@AliasFor(annotation = Component.class, attribute = "value")
.查看源代码
声明ControllerAdvice#name()
举个具体例子。
从 Spring Framework 6.1 开始,对基于约定的构造型名称的支持已被弃用
并将在框架的未来版本中删除。因此,自定义刻板印象
注释必须使用 |
如果显式 Bean 名称不能从此类注释派生,也无法从任何其他注释中派生
检测到的组件(例如自定义过滤器发现的组件),默认 Bean 名称
generator 返回不大写的非限定类名。例如,如果
检测到以下组件类,则名称为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-naming 策略。首先,实现BeanNameGenerator
接口,并确保包含默认的无参数构造函数。然后,提供完整的
配置扫描程序时限定的类名,如以下示例注释
和豆子定义显示。
如果您由于多个自动检测到的组件具有相同的非限定类名(即具有相同名称但驻留在不同包中的类)而遇到命名冲突,您可能需要配置一个BeanNameGenerator 默认为生成的 bean 名称的完全限定类名称。 这FullyQualifiedAnnotationBeanNameGenerator 位于包中org.springframework.context.annotation 可用于此类目的。 |
-
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 托管组件一样,默认和最常见的范围autodetected 组件是singleton
. 但是,有时您需要一个不同的范围这可以通过@Scope
注解。 您可以在注释中提供范围的名称,如以下示例所示:
-
Java
-
Kotlin
@Scope("prototype")
@Repository
public class MovieFinderImpl implements MovieFinder {
// ...
}
@Scope("prototype")
@Repository
class MovieFinderImpl : MovieFinder {
// ...
}
@Scope 注释仅在具体 bean 类(对于带注释的组件)或工厂方法(对于@Bean 方法)。与 XML bean定义相比,没有 bean 定义继承的概念,并且继承类级别的层次结构与元数据目的无关。 |
有关特定于 Web 的作用域(例如 Spring 上下文中的“请求”或“会话”)的详细信息,请参阅请求、会话、应用程序和 WebSocket 作用域。与这些作用域的预构建注释一样,您也可以编写自己的作用域注释:例如,自定义注释meta-annotated@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 作为依赖项中进行了描述。为此,组件扫描上提供了作用域代理属性 元素。 三个可能的值是: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
annotation 和
自定义限定符注释,用于在解析自动连线时提供细粒度控制
候选人。因为这些示例是基于 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 提供其限定符元数据的变体,因为 元数据是按实例而不是按类提供的。 |