|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Boot 3.4.0！ |
创建您自己的自动配置
如果您在开发共享库的公司工作，或者如果您从事开源或商业库的工作，则可能需要开发自己的自动配置。 自动配置类可以捆绑在外部 jar 中，并且仍然由 Spring Boot 拾取。
Auto-configuration 可以与 “starter” 相关联，该 “starter” 提供 auto-configuration 代码以及您将与之一起使用的典型 libraries。 我们首先介绍构建自己的自动配置所需了解的内容，然后我们继续介绍创建自定义Starters所需的典型步骤。
了解自动配置的 Bean
实现自动配置的类用@AutoConfiguration.
此注解本身使用@Configuration，使自动配置成为标准@Configuration类。
附加@Conditional注释用于限制何时应应用自动配置。
通常，自动配置类使用@ConditionalOnClass和@ConditionalOnMissingBean附注。
这可确保仅在找到相关类且您尚未声明自己的类时应用自动配置@Configuration.
查找 Auto-configuration Candidate
Spring Boot 检查是否存在META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件。
该文件应列出您的配置类，每行一个类名，如以下示例所示：
com.mycorp.libx.autoconfigure.LibXAutoConfiguration
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration您可以使用该字符向 imports 文件添加注释。# |
自动配置只能通过在 imports 文件中命名来加载。
确保它们在特定的包空间中定义，并且它们永远不会成为组件扫描的目标。
此外，自动配置类不应启用组件扫描来查找其他组件。
特定@Import应改用 annotations。 |
如果您的配置需要按特定顺序应用，您可以使用before,beforeName,after和afterNameattributes 上的@AutoConfiguration注解或专用的@AutoConfigureBefore和@AutoConfigureAfter附注。
例如，如果您提供特定于 Web 的配置，则可能需要在WebMvcAutoConfiguration.
如果您想订购某些不应直接了解彼此的自动配置，您还可以使用@AutoConfigureOrder.
该注解与常规@Order注解，但为自动配置类提供专用顺序。
与标准一样@Configuration类，则应用自动配置类的顺序仅影响其 bean 的定义顺序。
随后创建这些 bean 的顺序不受影响，并且由每个 bean 的依赖项和任何@DependsOn关系。
条件注释
您几乎总是希望包含一个或多个@Conditionalannotations 的 auto-configuration 类。
这@ConditionalOnMissingBeanannotation 是一个常见的示例，用于允许开发人员在对您的默认值不满意时覆盖自动配置。
Spring Boot 包括许多@Conditional注解，您可以通过注解@Configuration类或个人@Bean方法。
这些注释包括：
类条件
这@ConditionalOnClass和@ConditionalOnMissingClassannotations 让@Configuration根据特定类的存在与否来包含类。
由于注释元数据是使用 ASM 解析的，因此您可以使用value属性来引用实际类，即使该类实际上可能没有出现在正在运行的应用程序类路径上。
您还可以使用name属性（如果您希望使用String价值。
此机制不会以相同的方式应用于@Bean方法，其中返回类型通常是条件的目标：在方法的条件应用之前，JVM 将加载类和可能处理的方法引用，如果类不存在，则这些引用将失败。
为了处理这种情况，单独的@Configurationclass 可用于隔离条件，如以下示例所示：
-
Java
-
Kotlin
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@AutoConfiguration
// Some conditions ...
public class MyAutoConfiguration {
// Auto-configured beans ...
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(SomeService.class)
public static class SomeServiceConfiguration {
@Bean
@ConditionalOnMissingBean
public SomeService someService() {
return new SomeService();
}
}
}import org.springframework.boot.autoconfigure.condition.ConditionalOnClass
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
// Some conditions ...
class MyAutoConfiguration {
// Auto-configured beans ...
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(SomeService::class)
class SomeServiceConfiguration {
@Bean
@ConditionalOnMissingBean
fun someService(): SomeService {
return SomeService()
}
}
}如果您使用@ConditionalOnClass或@ConditionalOnMissingClass作为元注释的一部分来编写您自己的组合注释，您必须使用name，因为在这种情况下引用类不会被处理。 |
Bean 条件
这@ConditionalOnBean和@ConditionalOnMissingBean注释允许根据特定 bean 的存在与否来包含 bean。
您可以使用value属性按类型指定 bean，或者name按 name 指定 bean。
这search属性允许您限制ApplicationContext搜索 bean 时应考虑的层次结构。
当放置在@Beanmethod，则 target 类型默认为方法的返回类型，如以下示例所示：
-
Java
-
Kotlin
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
@AutoConfiguration
public class MyAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public SomeService someService() {
return new SomeService();
}
}import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyAutoConfiguration {
@Bean
@ConditionalOnMissingBean
fun someService(): SomeService {
return SomeService()
}
}在前面的示例中，someService如果没有SomeService已包含在ApplicationContext.
您需要非常小心 bean 定义的添加顺序，因为这些条件是根据到目前为止已处理的内容进行评估的。
因此，我们建议仅使用@ConditionalOnBean和@ConditionalOnMissingBean自动配置类上的注释（因为这些保证在添加任何用户定义的 bean 定义后加载）。 |
@ConditionalOnBean和@ConditionalOnMissingBean不要阻止@Configuration类。
在类级别使用这些条件与将每个条件标记为包含@Bean方法的 Intent 是，前者会阻止注册@Configurationclass 作为 Bean 进行设置。 |
物业条件
这@ConditionalOnPropertyannotation 允许根据 Spring Environment 属性包含配置。
使用prefix和nameattributes 来指定应检查的属性。
默认情况下，任何存在且不等于false匹配。
您还可以使用havingValue和matchIfMissing属性。
如果在name属性，则所有属性都必须通过测试才能匹配条件。
资源条件
这@ConditionalOnResourceannotation 允许仅在存在特定资源时包含 configuration。
可以使用通常的 Spring 约定来指定资源，如以下示例所示：file:/home/user/test.dat.
Web 应用程序条件
这@ConditionalOnWebApplication和@ConditionalOnNotWebApplication注释允许根据应用程序是否为 Web 应用程序来包含配置。
基于 servlet 的 Web 应用程序是使用 Spring 的任何应用程序WebApplicationContext，定义session范围，或者具有ConfigurableWebEnvironment.
反应式 Web 应用程序是使用ReactiveWebApplicationContext或具有ConfigurableReactiveWebEnvironment.
这@ConditionalOnWarDeployment和@ConditionalOnNotWarDeployment注释允许根据应用程序是否是部署到 servlet 容器的传统 WAR 应用程序来包含配置。
对于使用嵌入式 Web 服务器运行的应用程序，此条件将不匹配。
SPEL 表达式条件
这@ConditionalOnExpressionannotation 允许根据 SPEL 表达式的结果包含配置。
| 在表达式中引用 bean 将导致该 bean 在上下文刷新处理中非常早地初始化。 因此，bean 将不符合后处理条件（例如配置属性绑定），并且其状态可能不完整。 |
测试您的自动配置
自动配置可能受多种因素影响：用户配置 （@Bean定义和Environment自定义）、条件评估（存在特定库）等。
具体来说，每个测试都应该创建一个定义明确的ApplicationContext，这表示这些自定义项的组合。ApplicationContextRunner提供了实现此目的的好方法。
ApplicationContextRunner在本机映像中运行测试时不起作用。 |
ApplicationContextRunner通常定义为 Test 类的字段，用于收集基本、通用的配置。
以下示例确保MyServiceAutoConfiguration始终调用：
-
Java
-
Kotlin
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration.class)); val contextRunner = ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration::class.java))| 如果必须定义多个 auto-configurations，则无需对它们的声明进行排序，因为它们的调用顺序与运行应用程序时的顺序完全相同。 |
每个测试都可以使用运行程序来表示特定的使用案例。
例如，下面的示例调用用户配置 （UserConfiguration） 并检查自动配置是否正确退出。
调用run提供可与 AssertJ 一起使用的回调上下文。
-
Java
-
Kotlin
@Test
void defaultServiceBacksOff() {
this.contextRunner.withUserConfiguration(UserConfiguration.class).run((context) -> {
assertThat(context).hasSingleBean(MyService.class);
assertThat(context).getBean("myCustomService").isSameAs(context.getBean(MyService.class));
});
}
@Configuration(proxyBeanMethods = false)
static class UserConfiguration {
@Bean
MyService myCustomService() {
return new MyService("mine");
}
} @Test
fun defaultServiceBacksOff() {
contextRunner.withUserConfiguration(UserConfiguration::class.java)
.run { context: AssertableApplicationContext ->
assertThat(context).hasSingleBean(MyService::class.java)
assertThat(context).getBean("myCustomService")
.isSameAs(context.getBean(MyService::class.java))
}
}
@Configuration(proxyBeanMethods = false)
internal class UserConfiguration {
@Bean
fun myCustomService(): MyService {
return MyService("mine")
}
}还可以轻松自定义Environment，如以下示例所示：
-
Java
-
Kotlin
@Test
void serviceNameCanBeConfigured() {
this.contextRunner.withPropertyValues("user.name=test123").run((context) -> {
assertThat(context).hasSingleBean(MyService.class);
assertThat(context.getBean(MyService.class).getName()).isEqualTo("test123");
});
} @Test
fun serviceNameCanBeConfigured() {
contextRunner.withPropertyValues("user.name=test123").run { context: AssertableApplicationContext ->
assertThat(context).hasSingleBean(MyService::class.java)
assertThat(context.getBean(MyService::class.java).name).isEqualTo("test123")
}
}运行器还可用于显示ConditionEvaluationReport.
该报告可以在INFO或DEBUG水平。
以下示例演示如何使用ConditionEvaluationReportLoggingListener以在 Auto-Configuration Tests 中打印报告。
-
Java
-
Kotlin
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener;
import org.springframework.boot.logging.LogLevel;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
class MyConditionEvaluationReportingTests {
@Test
void autoConfigTest() {
new ApplicationContextRunner()
.withInitializer(ConditionEvaluationReportLoggingListener.forLogLevel(LogLevel.INFO))
.run((context) -> {
// Test something...
});
}
}import org.junit.jupiter.api.Test
import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
import org.springframework.boot.logging.LogLevel
import org.springframework.boot.test.context.assertj.AssertableApplicationContext
import org.springframework.boot.test.context.runner.ApplicationContextRunner
class MyConditionEvaluationReportingTests {
@Test
fun autoConfigTest() {
ApplicationContextRunner()
.withInitializer(ConditionEvaluationReportLoggingListener.forLogLevel(LogLevel.INFO))
.run { context: AssertableApplicationContext? -> }
}
}模拟 Web 上下文
如果需要测试仅在 servlet 或反应式 Web 应用程序上下文中运行的自动配置，请使用WebApplicationContextRunner或ReactiveWebApplicationContextRunner分别。
覆盖 Classpath
还可以测试当特定类和/或包在运行时不存在时会发生什么。
Spring Boot 附带一个FilteredClassLoader这很容易被 runner 使用。
在下面的示例中，我们断言如果MyService不存在，则会自动配置已正确禁用：
-
Java
-
Kotlin
@Test
void serviceIsIgnoredIfLibraryIsNotPresent() {
this.contextRunner.withClassLoader(new FilteredClassLoader(MyService.class))
.run((context) -> assertThat(context).doesNotHaveBean("myService"));
} @Test
fun serviceIsIgnoredIfLibraryIsNotPresent() {
contextRunner.withClassLoader(FilteredClassLoader(MyService::class.java))
.run { context: AssertableApplicationContext? ->
assertThat(context).doesNotHaveBean("myService")
}
}创建您自己的 Starter
典型的 Spring Boot Starters包含用于自动配置和自定义给定技术基础设施的代码，我们称之为 “acme”。 为了使其易于扩展，可以将专用命名空间中的许多 Configuration Key 公开给环境。 最后，提供了一个 “starter” 依赖项，以帮助用户尽可能轻松地入门。
具体来说，自定义Starters可以包含以下内容：
-
这
autoconfigure模块，其中包含 “acme” 的自动配置代码。 -
这
starter模块，该模块为autoconfiguremodule 以及 “acme” 和任何其他通常有用的依赖项。 简而言之，添加 starter 应该提供开始使用该库所需的一切。
这种分为两个模块的做法是完全没有必要的。
如果 “acme” 有多种风格、选项或可选功能，那么最好将自动配置分开，因为您可以清楚地表达某些功能是可选的。
此外，您还可以制作一个 starter 来提供有关这些可选依赖项的意见。
同时，其他人只能依靠autoconfigure模块并制作他们自己的具有不同观点的Starters。
如果自动配置相对简单且没有可选功能，那么在 starter 中合并两个模块绝对是一种选择。
命名
您应该确保为 starter 提供适当的命名空间。
不要以模块名称开头spring-boot，即使您使用不同的 MavengroupId.
将来，我们可能会为您自动配置的事物提供官方支持。
根据经验，您应该在 starter 之后命名组合模块。
例如，假设您正在为 “acme” 创建一个Starters，并将 auto-configure 模块命名为acme-spring-boot和Startersacme-spring-boot-starter.
如果您只有一个模块将两者组合在一起，请为其命名acme-spring-boot-starter.
配置键
如果您的 starter 提供 Configuration Key，请为它们使用唯一的命名空间。
特别是，不要在 Spring Boot 使用的名称空间中包含你的键（例如server,management,spring等）。
如果你使用相同的命名空间，我们将来可能会以破坏你的模块的方式修改这些命名空间。
根据经验，请在所有键前面加上您拥有的命名空间（例如acme).
通过为每个属性添加字段 Javadoc 来确保记录配置键，如以下示例所示：
-
Java
-
Kotlin
import java.time.Duration;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("acme")
public class AcmeProperties {
/**
* Whether to check the location of acme resources.
*/
private boolean checkLocation = true;
/**
* Timeout for establishing a connection to the acme server.
*/
private Duration loginTimeout = Duration.ofSeconds(3);
// getters/setters ...
public boolean isCheckLocation() {
return this.checkLocation;
}
public void setCheckLocation(boolean checkLocation) {
this.checkLocation = checkLocation;
}
public Duration getLoginTimeout() {
return this.loginTimeout;
}
public void setLoginTimeout(Duration loginTimeout) {
this.loginTimeout = loginTimeout;
}
}import org.springframework.boot.context.properties.ConfigurationProperties
import java.time.Duration
@ConfigurationProperties("acme")
class AcmeProperties(
/**
* Whether to check the location of acme resources.
*/
var isCheckLocation: Boolean = true,
/**
* Timeout for establishing a connection to the acme server.
*/
var loginTimeout:Duration = Duration.ofSeconds(3))您应该只使用@ConfigurationProperties字段 Javadoc 中，因为它们在添加到 JSON 之前不会进行处理。 |
如果您使用@ConfigurationProperties替换为 record 类，则记录组件的描述应通过类级 Javadoc 标签提供@param（记录类中没有显式的实例字段来放置常规字段级 Javadocs）。
以下是我们在内部遵循的一些规则，以确保描述一致：
-
请勿以 “The” 或 “A” 开头描述。
-
为
boolean类型，则以 “Whether” 或 “Enable” 开始描述。 -
对于基于集合的类型，以 “Comma-separated list” 开始描述
-
用
Duration而不是long并描述默认单位（如果它与毫秒不同），例如“如果未指定持续时间后缀，则将使用秒”。 -
除非必须在运行时确定，否则不要在描述中提供默认值。
确保触发元数据生成，以便 IDE 帮助也可用于您的密钥。
您可能需要查看生成的元数据 （META-INF/spring-configuration-metadata.json） 以确保您的密钥已正确记录。
在兼容的 IDE 中使用您自己的 starter 也是验证元数据质量的好主意。
“autoconfigure” 模块
这autoconfiguremodule 包含开始使用该库所需的一切。
它还可能包含配置键定义（例如@ConfigurationProperties） 以及可用于进一步自定义组件初始化方式的任何回调接口。
您应该将库的依赖项标记为可选，以便您可以包含autoconfigure模块。
如果这样做，则不会提供库，并且默认情况下， Spring Boot 会退缩。 |
Spring Boot 使用注释处理器在元数据文件（META-INF/spring-autoconfigure-metadata.properties).
如果存在该文件，则使用它来紧急过滤不匹配的自动配置，这将缩短启动时间。
使用 Maven 构建时，建议在包含 auto-configurations 的模块中添加以下依赖项：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure-processor</artifactId>
<optional>true</optional>
</dependency>如果您直接在应用程序中定义了自动配置，请确保配置spring-boot-maven-plugin以防止repackage将依赖项添加到 Uber Jar 中 Goal 的 Target：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>使用 Gradle 时，应在annotationProcessor配置，如以下示例所示：
dependencies {
annotationProcessor "org.springframework.boot:spring-boot-autoconfigure-processor"
}入门模块
Starters真的是一个空罐子。 它的唯一目的是提供使用库所需的依赖项。 您可以将其视为对开始所需内容的固执己见的看法。
不要对添加起始项的项目做出假设。 如果要自动配置的库通常需要其他启动程序，请同时提及它们。 如果可选依赖项的数量很高，则可能很难提供一组适当的默认依赖项，因为您应该避免包含对于库的典型使用不必要的依赖项。 换句话说，您不应包含可选依赖项。
无论哪种方式，您的Starters都必须引用核心 Spring Boot Starters（spring-boot-starter） （如果您的 starter 依赖于另一个 starter，则无需添加它）。
如果项目是仅使用您的自定义Starters创建的，则 Spring Boot 的核心功能将因核心Starters的存在而得到尊重。 |