创建您自己的自动配置

如果您在开发共享库的公司工作，或者您在开源或商业库上工作，您可能希望开发自己的自动配置。自动配置类可以捆绑在外部 jar 中，并且仍然可以被 Spring Boot 拾取。

自动配置可以与“启动器”相关联，该启动器提供自动配置代码以及您将与之一起使用的典型库。我们首先介绍构建自己的自动配置所需了解的内容，然后我们将继续介绍创建自定义启动器所需的典型步骤.

了解自动配置的 Bean

实现自动配置的类用 @AutoConfiguration 注解。此注解本身用 @Configuration 元注解，使自动配置成为标准的 @Configuration 类。其他 @Conditional 注解用于约束自动配置何时应应用。通常，自动配置类使用 @ConditionalOnClass 和 @ConditionalOnMissingBean 注解。这确保自动配置仅在找到相关类并且您没有声明自己的 @Configuration 时才应用。

您可以浏览 spring-boot-autoconfigure 的源代码，以查看 Spring 提供的 @AutoConfiguration 类（请参阅 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件）。

定位自动配置候选者

Spring Boot 会检查已发布的 jar 文件中是否存在一个名为 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 的文件。该文件应列出您的配置类，每行一个类名，如下例所示：

com.mycorp.libx.autoconfigure.LibXAutoConfiguration
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

您可以使用 # 字符在 imports 文件中添加注释。

自动配置必须仅通过在 imports 文件中命名来加载。确保它们定义在特定的包空间中，并且永远不会成为组件扫描的目标。此外，自动配置类不应启用组件扫描来查找其他组件。应使用特定的 @Import 注释。

如果您的配置需要按特定顺序应用，您可以使用 before、beforeName、after 和 afterName 属性在 @AutoConfiguration 注释或专用的 @AutoConfigureBefore 和 @AutoConfigureAfter 注释中使用。例如，如果您提供特定于 Web 的配置，您的类可能需要在 WebMvcAutoConfiguration 之后应用。

如果您想对某些不应相互了解的自动配置进行排序，也可以使用 @AutoConfigureOrder。该注释与常规 @Order 注释具有相同的语义，但为自动配置类提供了一个专门的顺序。

与标准 @Configuration 类一样，应用自动配置类的顺序只影响其 bean 定义的顺序。这些 bean 随后创建的顺序不受影响，并由每个 bean 的依赖项和任何 @DependsOn 关系决定。

条件注释

您几乎总是希望在您的自动配置类上包含一个或多个 @Conditional 注释。@ConditionalOnMissingBean 注释是一个常见的示例，用于允许开发人员在对您的默认值不满意时覆盖自动配置。

Spring Boot 包含许多 @Conditional 注解，您可以通过注解 @Configuration 类或单个 @Bean 方法在自己的代码中重用它们。这些注解包括

类条件
Bean 条件
属性条件
资源条件
Web 应用程序条件
SpEL 表达式条件

类条件

@ConditionalOnClass 和 @ConditionalOnMissingClass 注解允许根据特定类的存在或不存在来包含 @Configuration 类。由于注解元数据是使用 ASM 解析的，因此您可以使用 value 属性引用实际类，即使该类可能实际上没有出现在运行的应用程序类路径上。如果您希望使用 String 值指定类名，也可以使用 name 属性。

此机制不适用于 @Bean 方法，在 @Bean 方法中，通常返回类型是条件的目标：在方法上的条件应用之前，JVM 将加载类并可能处理方法引用，如果类不存在，则会失败。

为了处理这种情况，可以使用单独的 @Configuration 类来隔离条件，如以下示例所示

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 按名称指定 Bean。search 属性允许您限制在搜索 Bean 时应考虑的 ApplicationContext 层次结构。

当放置在 @Bean 方法上时，目标类型默认为方法的返回类型，如以下示例所示

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()
	}

}

在前面的示例中，如果 ApplicationContext 中不包含类型为 SomeService 的 Bean，则将创建 someService Bean。

您需要非常小心 Bean 定义的添加顺序，因为这些条件是根据到目前为止已处理的内容进行评估的。因此，我们建议仅在自动配置类上使用 @ConditionalOnBean 和 @ConditionalOnMissingBean 注解（因为这些注解保证在添加任何用户定义的 Bean 定义之后加载）。

@ConditionalOnBean 和 @ConditionalOnMissingBean 不会阻止创建 @Configuration 类。在类级别使用这些条件与用注解标记每个包含的 @Bean 方法之间的唯一区别是，前者会阻止在条件不匹配的情况下将 @Configuration 类注册为 Bean。

在声明 @Bean 方法时，尽可能在方法的返回类型中提供类型信息。例如，如果您的 bean 的具体类实现了接口，则 bean 方法的返回类型应为具体类，而不是接口。在 @Bean 方法中提供尽可能多的类型信息在使用 bean 条件时尤其重要，因为它们的评估只能依赖于方法签名中可用的类型信息。

属性条件

@ConditionalOnProperty 注解允许根据 Spring 环境属性包含配置。使用 prefix 和 name 属性指定要检查的属性。默认情况下，任何存在的且不等于 false 的属性都将匹配。您还可以使用 havingValue 和 matchIfMissing 属性创建更高级的检查。

如果在 name 属性中给出多个名称，则所有属性都必须通过测试才能使条件匹配。

资源条件

@ConditionalOnResource 注解允许仅在存在特定资源时包含配置。可以使用通常的 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 表达式条件

@ConditionalOnExpression 注解允许根据 SpEL 表达式的结果包含配置。

在表达式中引用 bean 将导致该 bean 在上下文刷新处理的早期阶段被初始化。因此，该 bean 将不符合后处理（如配置属性绑定）的资格，并且其状态可能不完整。

测试您的自动配置

自动配置可能会受到许多因素的影响：用户配置（@Bean 定义和 Environment 自定义）、条件评估（特定库的存在）等等。具体来说，每个测试都应该创建一个定义明确的 ApplicationContext，它代表这些自定义的组合。ApplicationContextRunner 提供了一种很好的方法来实现这一点。

ApplicationContextRunner 在原生镜像中运行测试时不起作用。

ApplicationContextRunner 通常被定义为测试类的字段，以收集基本、通用的配置。以下示例确保 MyServiceAutoConfiguration 始终被调用

Java
Kotlin

	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
		.withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration.class));

	val contextRunner = ApplicationContextRunner()
		.withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration::class.java))

如果需要定义多个自动配置，则无需对其声明进行排序，因为它们将在运行应用程序时以完全相同的顺序被调用。

每个测试都可以使用运行器来代表一个特定的用例。例如，下面的示例调用用户配置（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 打印报告。

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。

覆盖类路径

还可以测试在运行时特定类和/或包不存在时会发生什么。Spring Boot 附带一个 FilteredClassLoader，运行器可以轻松使用它。在以下示例中，我们断言如果 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")
			}
	}

创建您自己的启动器

一个典型的 Spring Boot 启动器包含用于自动配置和自定义给定技术基础设施的代码，我们称之为“acme”。为了使其易于扩展，可以在专用命名空间中公开许多配置键到环境。最后，提供一个单一的“启动器”依赖项，以帮助用户尽可能轻松地入门。

具体来说，自定义启动器可以包含以下内容

包含“acme”自动配置代码的autoconfigure模块。
starter模块，它提供对autoconfigure模块以及“acme”和通常有用的任何其他依赖项的依赖关系。简而言之，添加启动器应该提供开始使用该库所需的一切。

这种分成两个模块的方式并非必要。如果“acme”有几种风格、选项或可选功能，那么最好将自动配置分开，因为你可以清楚地表达某些功能是可选的。此外，你可以创建提供对这些可选依赖项的意见的启动器。同时，其他人可以只依赖autoconfigure模块，并使用不同的意见创建自己的启动器。

如果自动配置比较简单，并且没有可选功能，那么将这两个模块合并到启动器中绝对是一个选择。

命名

你应该确保为你的启动器提供一个合适的命名空间。不要以spring-boot开头你的模块名称，即使你使用不同的 Maven groupId。我们将来可能会为你要自动配置的内容提供官方支持。

根据经验，你应该根据启动器命名组合模块。例如，假设你正在为“acme”创建一个启动器，并且你将自动配置模块命名为acme-spring-boot，将启动器命名为acme-spring-boot-starter。如果你只有一个模块组合了这两个模块，则将其命名为acme-spring-boot-starter。

配置键

如果你的启动器提供配置键，请为它们使用唯一的命名空间。特别是，不要将你的键包含在 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与记录类，那么记录组件的描述应该通过类级别的 Javadoc 标签@param提供（记录类中没有显式的实例字段来放置常规的字段级 Javadoc）。

以下是我们内部遵循的一些规则，以确保描述的一致性

不要以“The”或“A”开头描述。
对于boolean类型，描述以“Whether”或“Enable”开头。
对于基于集合的类型，描述以“Comma-separated list”开头。
使用java.time.Duration而不是long，如果默认单位与毫秒不同，则描述默认单位，例如“如果未指定持续时间后缀，则使用秒”。
不要在描述中提供默认值，除非它必须在运行时确定。

确保触发元数据生成，以便您的键也能获得 IDE 辅助。您可能需要查看生成的元数据（META-INF/spring-configuration-metadata.json），以确保您的键已正确记录。在兼容的 IDE 中使用您自己的启动器也是验证元数据质量的好方法。

“autoconfigure”模块

autoconfigure模块包含开始使用该库所需的一切。它可能还包含配置键定义（例如@ConfigurationProperties）以及任何可用于进一步自定义组件初始化方式的回调接口。

您应该将对该库的依赖项标记为可选，以便您可以更轻松地在项目中包含autoconfigure模块。如果您这样做，该库将不会提供，默认情况下，Spring Boot 会退回。

Spring Boot 使用注释处理器在元数据文件（META-INF/spring-autoconfigure-metadata.properties）中收集自动配置的条件。如果该文件存在，它将用于提前过滤不匹配的自动配置，这将提高启动时间。

使用 Maven 构建时，建议在包含自动配置的模块中添加以下依赖项

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-autoconfigure-processor</artifactId>
	<optional>true</optional>
</dependency>

如果您已在应用程序中直接定义了自动配置，请确保配置spring-boot-maven-plugin以防止repackage目标将依赖项添加到 uber jar 中

<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"
}

启动器模块

启动器实际上是一个空 jar。它的唯一目的是提供与该库一起使用所需的依赖项。您可以将其视为开始所需内容的意见性观点。

不要对添加启动器的项目做出假设。如果您正在自动配置的库通常需要其他启动器，请也提及它们。如果可选依赖项的数量很多，提供一组适当的默认依赖项可能很困难，因为您应该避免包含对库的典型使用不必要的依赖项。换句话说，您不应该包含可选依赖项。

无论哪种方式，您的启动器都必须直接或间接引用核心 Spring Boot 启动器（spring-boot-starter）（如果您的启动器依赖于另一个启动器，则无需添加它）。如果一个项目只使用您的自定义启动器创建，Spring Boot 的核心功能将通过核心启动器的存在得到尊重。