测试 Spring Boot 应用程序

Spring Boot 应用程序是一个 Spring ApplicationContext，所以除了你通常对普通 Spring 上下文所做的操作外，不需要做任何特别的事情。

只有当你使用 SpringApplication 创建上下文时，Spring Boot 的外部属性、日志记录和其他功能才会默认安装到上下文中。

Spring Boot 提供了 @SpringBootTest 注解，当你需要 Spring Boot 功能时，它可以作为标准 spring-test @ContextConfiguration 注解的替代方案。该注解通过使用 SpringApplication 创建测试中使用的 ApplicationContext 来工作。除了 @SpringBootTest 之外，还提供了许多其他注解用于测试应用程序的特定部分。

如果你使用 JUnit 4，别忘了在测试中添加 @RunWith(SpringRunner.class)，否则注解将被忽略。如果你使用 JUnit 5，则不需要添加等效的 @ExtendWith(SpringExtension.class)，因为 @SpringBootTest 和其他 @…Test 注解已经标注了它。

默认情况下，@SpringBootTest 不会启动服务器。你可以使用 @SpringBootTest 的 webEnvironment 属性来进一步优化测试的运行方式：

MOCK(默认) : 加载 web ApplicationContext 并提供模拟的 web 环境。使用此注解时不会启动嵌入式服务器。如果你的类路径上没有可用的 web 环境，此模式会透明地回退到创建常规的非 web ApplicationContext。它可以与 @AutoConfigureMockMvc 或 @AutoConfigureWebTestClient 结合使用，用于基于模拟的 web 应用程序测试。
RANDOM_PORT: 加载 WebServerApplicationContext 并提供真实的 web 环境。嵌入式服务器启动并监听随机端口。
DEFINED_PORT: 加载 WebServerApplicationContext 并提供真实的 web 环境。嵌入式服务器启动并监听定义的端口（来自你的 application.properties）或默认端口 8080。
NONE: 通过使用 SpringApplication 加载 ApplicationContext，但不提供任何 web 环境（模拟或其他）。

如果你的测试是 @Transactional，它默认会在每个测试方法结束时回滚事务。但是，由于使用 RANDOM_PORT 或 DEFINED_PORT 隐式提供了真实的 servlet 环境，HTTP 客户端和服务器在单独的线程中运行，因此也在单独的事务中运行。在这种情况下，服务器上启动的任何事务都不会回滚。

如果你的应用程序为管理服务器使用不同的端口，使用 webEnvironment = WebEnvironment.RANDOM_PORT 的 @SpringBootTest 也会在单独的随机端口上启动管理服务器。

检测 Web 应用程序类型

如果 Spring MVC 可用，则配置基于 MVC 的常规应用程序上下文。如果你只有 Spring WebFlux，我们将检测到它并配置基于 WebFlux 的应用程序上下文。

如果两者都存在，Spring MVC 优先。如果你想在这种情况下测试响应式 web 应用程序，必须设置 spring.main.web-application-type 属性：

Java
Kotlin

import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest(properties = "spring.main.web-application-type=reactive")
class MyWebFluxTests {

	// ...

}

import org.springframework.boot.test.context.SpringBootTest

@SpringBootTest(properties = ["spring.main.web-application-type=reactive"])
class MyWebFluxTests {

	// ...

}

检测测试配置

如果你熟悉 Spring Test Framework，你可能习惯于使用 @ContextConfiguration(classes=…) 来指定要加载的 Spring @Configuration。或者，你可能经常在测试中使用嵌套的 @Configuration 类。

在测试 Spring Boot 应用程序时，这通常不是必需的。 Spring Boot 的 @*Test 注解会在你没有明确定义配置时自动搜索你的主配置。

搜索算法从包含测试的包开始向上搜索，直到找到带有 @SpringBootApplication 或 @SpringBootConfiguration 注解的类。只要你合理地组织你的代码，通常就能找到你的主配置。

如果你使用测试注解来测试应用程序的特定部分，你应该避免在主方法的应用程序类上添加特定于某个区域的配置设置。

@SpringBootApplication 的底层组件扫描配置定义了排除过滤器，用于确保切片按预期工作。如果你在带有 @SpringBootApplication 注解的类上使用显式的 @ComponentScan 指令，请注意这些过滤器将被禁用。如果你使用切片，你应该重新定义它们。

如果你想自定义主配置，可以使用嵌套的 @TestConfiguration 类。与嵌套的 @Configuration 类（它会替代应用程序的主配置）不同，嵌套的 @TestConfiguration 类会与应用程序的主配置一起使用。

Spring 的测试框架会在测试之间缓存应用程序上下文。因此，只要你的测试共享相同的配置（无论它是如何被发现的），加载上下文的潜在耗时过程只会发生一次。

使用测试配置主方法

通常，@SpringBootTest 发现的测试配置将是你的主 @SpringBootApplication。在大多数结构良好的应用程序中，这个配置类还将包含用于启动应用程序的 main 方法。

例如，以下是典型 Spring Boot 应用程序的常见代码模式：

Java
Kotlin

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

	public static void main(String[] args) {
		SpringApplication.run(MyApplication.class, args);
	}

}

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.docs.using.structuringyourcode.locatingthemainclass.MyApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}

在上面的例子中，main 方法除了委托给 SpringApplication.run(Class, String…) 之外没有做任何事情。但是，在调用 SpringApplication.run(Class, String…) 之前，可以有一个更复杂的 main 方法来应用自定义设置。

例如，这里是一个更改横幅模式并设置其他配置文件的应用程序：

Java
Kotlin

import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

	public static void main(String[] args) {
		SpringApplication application = new SpringApplication(MyApplication.class);
		application.setBannerMode(Banner.Mode.OFF);
		application.setAdditionalProfiles("myprofile");
		application.run(args);
	}

}

import org.springframework.boot.Banner
import org.springframework.boot.runApplication
import org.springframework.boot.autoconfigure.SpringBootApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args) {
		setBannerMode(Banner.Mode.OFF)
		setAdditionalProfiles("myprofile")
	}
}

由于 main 方法中的自定义设置可能会影响生成的 ApplicationContext，你可能还想使用 main 方法来创建测试中使用的 ApplicationContext。默认情况下，@SpringBootTest 不会调用你的 main 方法，而是直接使用类本身来创建 ApplicationContext。

如果你想更改此行为，可以将 @SpringBootTest 的 useMainMethod 属性更改为 SpringBootTest.UseMainMethod.ALWAYS 或 SpringBootTest.UseMainMethod.WHEN_AVAILABLE。当设置为 ALWAYS 时，如果找不到 main 方法，测试将失败。当设置为 WHEN_AVAILABLE 时，如果有可用的 main 方法将使用它，否则将使用标准加载机制。

例如，以下测试将调用 MyApplication 的 main 方法来创建 ApplicationContext。如果 main 方法设置了其他配置文件，那么这些配置文件将在 ApplicationContext 启动时生效。

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.UseMainMethod;

@SpringBootTest(useMainMethod = UseMainMethod.ALWAYS)
class MyApplicationTests {

	@Test
	void exampleTest() {
		// ...
	}

}

import org.junit.jupiter.api.Test
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.context.SpringBootTest.UseMainMethod

@SpringBootTest(useMainMethod = UseMainMethod.ALWAYS)
class MyApplicationTests {

	@Test
	fun exampleTest() {
		// ...
	}

}

排除测试配置

如果你的应用程序使用组件扫描（例如，如果你使用 @SpringBootApplication 或 @ComponentScan），你可能会发现仅为特定测试创建的顶级配置类意外地被到处拾取。

正如我们之前看到的，@TestConfiguration 可以用于测试的内部类来自定义主配置。 @TestConfiguration 也可以用于顶级类。这样做表明该类不应被扫描拾取。然后你可以在需要的地方显式导入该类，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;

@SpringBootTest
@Import(MyTestsConfiguration.class)
class MyTests {

	@Test
	void exampleTest() {
		// ...
	}

}

import org.junit.jupiter.api.Test
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.context.annotation.Import

@SpringBootTest
@Import(MyTestsConfiguration::class)
class MyTests {

	@Test
	fun exampleTest() {
		// ...
	}

}

如果你直接使用 @ComponentScan（即不是通过 @SpringBootApplication），你需要向其注册 TypeExcludeFilter。有关详细信息，请参阅 TypeExcludeFilter API 文档。

导入的 @TestConfiguration 比内部类 @TestConfiguration 更早处理，并且导入的 @TestConfiguration 将在通过组件扫描找到的任何配置之前处理。一般来说，这种顺序差异没有明显的影响，但如果你依赖 bean 覆盖，这是需要注意的。

使用应用程序参数

如果你的应用程序需要参数，你可以使用 @SpringBootTest 的 args 属性来注入它们。

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.test.context.SpringBootTest;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(args = "--app.test=one")
class MyApplicationArgumentTests {

	@Test
	void applicationArgumentsPopulated(@Autowired ApplicationArguments args) {
		assertThat(args.getOptionNames()).containsOnly("app.test");
		assertThat(args.getOptionValues("app.test")).containsOnly("one");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.ApplicationArguments
import org.springframework.boot.test.context.SpringBootTest

@SpringBootTest(args = ["--app.test=one"])
class MyApplicationArgumentTests {

	@Test
	fun applicationArgumentsPopulated(@Autowired args: ApplicationArguments) {
		assertThat(args.optionNames).containsOnly("app.test")
		assertThat(args.getOptionValues("app.test")).containsOnly("one")
	}

}

使用模拟环境进行测试

默认情况下，@SpringBootTest 不会启动服务器，而是设置一个模拟环境来测试 web 端点。

使用 Spring MVC，我们可以使用 MockMvc 来查询我们的 web 端点。提供了三种集成方式：

使用 Hamcrest 的常规 MockMvc。
包装 MockMvc 并使用 AssertJ 的 MockMvcTester。
将 MockMvc 作为服务器插入以处理请求的 WebTestClient。

以下示例展示了可用的集成：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.assertj.MockMvcTester;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {

	@Test
	void testWithMockMvc(@Autowired MockMvc mvc) throws Exception {
		mvc.perform(get("/")).andExpect(status().isOk()).andExpect(content().string("Hello World"));
	}

	// If AssertJ is on the classpath, you can use MockMvcTester
	@Test
	void testWithMockMvcTester(@Autowired MockMvcTester mvc) {
		assertThat(mvc.get().uri("/")).hasStatusOk().hasBodyTextEqualTo("Hello World");
	}

	// If Spring WebFlux is on the classpath, you can drive MVC tests with a WebTestClient
	@Test
	void testWithWebTestClient(@Autowired WebTestClient webClient) {
		webClient
				.get().uri("/")
				.exchange()
				.expectStatus().isOk()
				.expectBody(String.class).isEqualTo("Hello World");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.web.reactive.server.WebTestClient
import org.springframework.test.web.reactive.server.expectBody
import org.springframework.test.web.servlet.assertj.MockMvcTester

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {

	@Test
	fun testWithMockMvc(@Autowired mvc: MockMvcTester) {
		assertThat(mvc.get().uri("/")).hasStatusOk()
				.hasBodyTextEqualTo("Hello World")
	}

	// If Spring WebFlux is on the classpath, you can drive MVC tests with a WebTestClient

	@Test
	fun testWithWebTestClient(@Autowired webClient: WebTestClient) {
		webClient
				.get().uri("/")
				.exchange()
				.expectStatus().isOk
				.expectBody<String>().isEqualTo("Hello World")
	}

}

如果你只想关注 web 层而不启动完整的 ApplicationContext，可以考虑使用 @WebMvcTest 代替。

使用 Spring WebFlux 端点，你可以使用 WebTestClient，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.reactive.server.WebTestClient;

@SpringBootTest
@AutoConfigureWebTestClient
class MyMockWebTestClientTests {

	@Test
	void exampleTest(@Autowired WebTestClient webClient) {
		webClient
			.get().uri("/")
			.exchange()
			.expectStatus().isOk()
			.expectBody(String.class).isEqualTo("Hello World");
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.web.reactive.server.WebTestClient
import org.springframework.test.web.reactive.server.expectBody

@SpringBootTest
@AutoConfigureWebTestClient
class MyMockWebTestClientTests {

	@Test
	fun exampleTest(@Autowired webClient: WebTestClient) {
		webClient
			.get().uri("/")
			.exchange()
			.expectStatus().isOk
			.expectBody<String>().isEqualTo("Hello World")
	}

}

在模拟环境中测试通常比使用完整的 servlet 容器运行更快。但是，由于模拟发生在 Spring MVC 层，依赖较低级别 servlet 容器行为的代码无法直接用 MockMvc 测试。

例如，Spring Boot 的错误处理基于 servlet 容器提供的"错误页面"支持。这意味着，虽然你可以测试你的 MVC 层按预期抛出和处理异常，但你不能直接测试特定的自定义错误页面是否被渲染。如果你需要测试这些较低级别的关注点，你可以按照下一节所述启动一个完全运行的服务器。

使用运行中的服务器进行测试

如果你需要启动一个完全运行的服务器，我们建议你使用随机端口。如果你使用 @SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)，每次测试运行时都会随机选择一个可用端口。

@LocalServerPort 注解可用于将实际使用的端口注入到你的测试中。为了方便起见，需要对启动的服务器进行 REST 调用的测试还可以自动装配一个 WebTestClient，它会解析到运行服务器的相对链接，并带有用于验证响应的专用 API，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.web.reactive.server.WebTestClient;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortWebTestClientTests {

	@Test
	void exampleTest(@Autowired WebTestClient webClient) {
		webClient
			.get().uri("/")
			.exchange()
			.expectStatus().isOk()
			.expectBody(String.class).isEqualTo("Hello World");
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment
import org.springframework.test.web.reactive.server.WebTestClient
import org.springframework.test.web.reactive.server.expectBody

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortWebTestClientTests {

	@Test
	fun exampleTest(@Autowired webClient: WebTestClient) {
		webClient
			.get().uri("/")
			.exchange()
			.expectStatus().isOk
			.expectBody<String>().isEqualTo("Hello World")
	}

}

WebTestClient 也可以通过使用模拟环境来使用，通过用 @AutoConfigureWebTestClient 注解你的测试类，从而不需要运行服务器。

此设置需要类路径上有 spring-webflux。如果你不能或不想添加 webflux，Spring Boot 还提供了 TestRestTemplate 工具：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.client.TestRestTemplate;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortTestRestTemplateTests {

	@Test
	void exampleTest(@Autowired TestRestTemplate restTemplate) {
		String body = restTemplate.getForObject("/", String.class);
		assertThat(body).isEqualTo("Hello World");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment
import org.springframework.boot.test.web.client.TestRestTemplate

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortTestRestTemplateTests {

	@Test
	fun exampleTest(@Autowired restTemplate: TestRestTemplate) {
		val body = restTemplate.getForObject("/", String::class.java)
		assertThat(body).isEqualTo("Hello World")
	}

}

自定义 WebTestClient

要自定义 WebTestClient bean，配置一个 WebTestClientBuilderCustomizer bean。任何这样的 bean 都会被调用，并传入用于创建 WebTestClient 的 WebTestClient.Builder。

使用 JMX

由于测试上下文框架会缓存上下文，JMX 默认被禁用以防止相同组件注册到同一域。如果此类测试需要访问 MBeanServer，考虑也将其标记为脏：

Java
Kotlin

import javax.management.MBeanServer;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.DirtiesContext;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(properties = "spring.jmx.enabled=true")
@DirtiesContext
class MyJmxTests {

	@Autowired
	private MBeanServer mBeanServer;

	@Test
	void exampleTest() {
		assertThat(this.mBeanServer.getDomains()).contains("java.lang");
		// ...
	}

}

import javax.management.MBeanServer

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.annotation.DirtiesContext

@SpringBootTest(properties = ["spring.jmx.enabled=true"])
@DirtiesContext
class MyJmxTests(@Autowired val mBeanServer: MBeanServer) {

	@Test
	fun exampleTest() {
		assertThat(mBeanServer.domains).contains("java.lang")
		// ...
	}

}

使用观察

如果你用 @AutoConfigureObservability 注解切片测试，它会自动配置一个 ObservationRegistry。

使用指标

无论你的类路径如何，除了内存支持的注册表外，使用 @SpringBootTest 时不会自动配置指标注册表。

如果你需要作为集成测试的一部分将指标导出到不同的后端，用 @AutoConfigureObservability 注解它。

如果你用 @AutoConfigureObservability 注解切片测试，它会自动配置一个内存 MeterRegistry。使用 @AutoConfigureObservability 注解不支持在切片测试中导出数据。

使用追踪

无论你的类路径如何，使用 @SpringBootTest 时不会自动配置报告数据的追踪组件。

如果你需要这些组件作为集成测试的一部分，用 @AutoConfigureObservability 注解测试。

如果你创建了自己的报告组件（例如自定义 SpanExporter 或 brave.handler.SpanHandler）并且你不想让它们在测试中激活，你可以使用 @ConditionalOnEnabledTracing 注解来禁用它们。

如果你用 @AutoConfigureObservability 注解切片测试，它会自动配置一个无操作的 Tracer。使用 @AutoConfigureObservability 注解不支持在切片测试中导出数据。

模拟和监视 Bean

在运行测试时，有时需要模拟应用程序上下文中的某些组件。例如，你可能有一个在开发期间不可用的远程服务的门面。当你想要模拟在真实环境中可能难以触发的故障时，模拟也很有用。

Spring Framework 包含一个 @MockitoBean 注解，可用于在 ApplicationContext 中定义 Mockito 模拟。此外，@MockitoSpyBean 可用于定义 Mockito 监视。在 Spring Framework 文档中了解更多关于这些功能的信息。

自动配置的测试

Spring Boot 的自动配置系统对应用程序来说工作得很好，但有时对测试来说可能有点太多。通常只加载测试应用程序"切片"所需的配置部分会很有帮助。例如，你可能想要测试 Spring MVC 控制器是否正确映射 URL，并且你不想在这些测试中涉及数据库调用，或者你可能想要测试 JPA 实体，而在这些测试运行时你对 web 层不感兴趣。

spring-boot-test-autoconfigure 模块包含许多可用于自动配置此类"切片"的注解。它们都以类似的方式工作，提供一个加载 ApplicationContext 的 @…Test 注解和一个或多个可用于自定义自动配置设置的 @AutoConfigure… 注解。

每个切片都将组件扫描限制为适当的组件，并加载非常有限的自动配置类集。如果你需要排除其中一个，大多数 @…Test 注解都提供 excludeAutoConfiguration 属性。或者，你可以使用 @ImportAutoConfiguration#exclude。

不支持通过在一个测试中使用多个 @…Test 注解来包含多个"切片"。如果你需要多个"切片"，选择一个 @…Test 注解并手动包含其他"切片"的 @AutoConfigure… 注解。

也可以将 @AutoConfigure… 注解与标准的 @SpringBootTest 注解一起使用。如果你对"切片"应用程序不感兴趣，但想要一些自动配置的测试 bean，你可以使用这种组合。

自动配置的 JSON 测试

要测试对象 JSON 序列化和反序列化是否按预期工作，你可以使用 @JsonTest 注解。 @JsonTest 自动配置可用的受支持 JSON 映射器，它可以是以下库之一：

Jackson ObjectMapper、任何 @JsonComponent bean 和任何 Jackson Module
Gson
Jsonb

@JsonTest 启用的自动配置列表可以在附录中找到。

如果你需要配置自动配置的元素，可以使用 @AutoConfigureJsonTesters 注解。

Spring Boot 包含基于 AssertJ 的辅助工具，它们与 JSONAssert 和 JsonPath 库一起工作，用于检查 JSON 是否符合预期。 JacksonTester、GsonTester、JsonbTester 和 BasicJsonTester 类可以分别用于 Jackson、Gson、Jsonb 和字符串。使用 @JsonTest 时，测试类上的任何辅助字段都可以使用 @Autowired。以下示例显示了 Jackson 的测试类：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.json.JsonTest;
import org.springframework.boot.test.json.JacksonTester;

import static org.assertj.core.api.Assertions.assertThat;

@JsonTest
class MyJsonTests {

	@Autowired
	private JacksonTester<VehicleDetails> json;

	@Test
	void serialize() throws Exception {
		VehicleDetails details = new VehicleDetails("Honda", "Civic");
		// Assert against a `.json` file in the same package as the test
		assertThat(this.json.write(details)).isEqualToJson("expected.json");
		// Or use JSON path based assertions
		assertThat(this.json.write(details)).hasJsonPathStringValue("@.make");
		assertThat(this.json.write(details)).extractingJsonPathStringValue("@.make").isEqualTo("Honda");
	}

	@Test
	void deserialize() throws Exception {
		String content = "{\"make\":\"Ford\",\"model\":\"Focus\"}";
		assertThat(this.json.parse(content)).isEqualTo(new VehicleDetails("Ford", "Focus"));
		assertThat(this.json.parseObject(content).getMake()).isEqualTo("Ford");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.json.JsonTest
import org.springframework.boot.test.json.JacksonTester

@JsonTest
class MyJsonTests(@Autowired val json: JacksonTester<VehicleDetails>) {

	@Test
	fun serialize() {
		val details = VehicleDetails("Honda", "Civic")
		// Assert against a `.json` file in the same package as the test
		assertThat(json.write(details)).isEqualToJson("expected.json")
		// Or use JSON path based assertions
		assertThat(json.write(details)).hasJsonPathStringValue("@.make")
		assertThat(json.write(details)).extractingJsonPathStringValue("@.make").isEqualTo("Honda")
	}

	@Test
	fun deserialize() {
		val content = "{\"make\":\"Ford\",\"model\":\"Focus\"}"
		assertThat(json.parse(content)).isEqualTo(VehicleDetails("Ford", "Focus"))
		assertThat(json.parseObject(content).make).isEqualTo("Ford")
	}

}

JSON 辅助类也可以直接在标准单元测试中使用。如果你不使用 @JsonTest，请在 @BeforeEach 方法中调用辅助工具的 initFields 方法。

如果你使用 Spring Boot 的基于 AssertJ 的辅助工具来断言给定 JSON 路径的数字值，根据类型你可能无法使用 isEqualTo。相反，你可以使用 AssertJ 的 satisfies 来断言该值匹配给定条件。例如，以下示例断言实际数字是一个在 0.15 的 0.01 偏移范围内的浮点值。

Java
Kotlin

	@Test
	void someTest() throws Exception {
		SomeObject value = new SomeObject(0.152f);
		assertThat(this.json.write(value)).extractingJsonPathNumberValue("@.test.numberValue")
			.satisfies((number) -> assertThat(number.floatValue()).isCloseTo(0.15f, within(0.01f)));
	}

	@Test
	fun someTest() {
		val value = SomeObject(0.152f)
		assertThat(json.write(value)).extractingJsonPathNumberValue("@.test.numberValue")
			.satisfies(ThrowingConsumer { number ->
				assertThat(number.toFloat()).isCloseTo(0.15f, within(0.01f))
			})
	}

自动配置的 Spring MVC 测试

要测试 Spring MVC 控制器是否按预期工作，使用 @WebMvcTest 注解。 @WebMvcTest 自动配置 Spring MVC 基础设施，并将扫描的 bean 限制为 @Controller、@ControllerAdvice、@JsonComponent、Converter、GenericConverter、Filter、HandlerInterceptor、WebMvcConfigurer、WebMvcRegistrations 和 HandlerMethodArgumentResolver。使用 @WebMvcTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

@WebMvcTest 启用的自动配置设置列表可以在附录中找到。

如果你需要注册额外的组件，例如 Jackson Module，你可以通过在测试上使用 @Import 来导入其他配置类。

通常，@WebMvcTest 仅限于单个控制器，并与 @MockitoBean 结合使用，为所需的协作者提供模拟实现。

@WebMvcTest 还自动配置 MockMvc。 Mock MVC 提供了一种强大的方式来快速测试 MVC 控制器，而无需启动完整的 HTTP 服务器。如果 AssertJ 可用，还会自动配置 MockMvcTester 提供的 AssertJ 支持。

你也可以在非 @WebMvcTest（如 @SpringBootTest）中自动配置 MockMvc 和 MockMvcTester，方法是用 @AutoConfigureMockMvc 注解它。以下示例使用 MockMvcTester：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.bean.override.mockito.MockitoBean;
import org.springframework.test.web.servlet.assertj.MockMvcTester;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;

@WebMvcTest(UserVehicleController.class)
class MyControllerTests {

	@Autowired
	private MockMvcTester mvc;

	@MockitoBean
	private UserVehicleService userVehicleService;

	@Test
	void testExample() {
		given(this.userVehicleService.getVehicleDetails("sboot"))
			.willReturn(new VehicleDetails("Honda", "Civic"));
		assertThat(this.mvc.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN))
			.hasStatusOk()
			.hasBodyTextEqualTo("Honda Civic");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.mockito.BDDMockito.given
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.http.MediaType
import org.springframework.test.context.bean.override.mockito.MockitoBean
import org.springframework.test.web.servlet.assertj.MockMvcTester

@WebMvcTest(UserVehicleController::class)
class MyControllerTests(@Autowired val mvc: MockMvcTester) {

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

	@Test
	fun testExample() {
		given(userVehicleService.getVehicleDetails("sboot"))
				.willReturn(VehicleDetails("Honda", "Civic"))
		assertThat(mvc.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN))
				.hasStatusOk().hasBodyTextEqualTo("Honda Civic")
	}

}

如果你需要配置自动配置的元素（例如，何时应用 servlet 过滤器），你可以使用 @AutoConfigureMockMvc 注解中的属性。

如果你使用 HtmlUnit 和 Selenium，自动配置还提供 HtmlUnit WebClient bean 和/或 Selenium WebDriver bean。以下示例使用 HtmlUnit：

Java
Kotlin

import org.htmlunit.WebClient;
import org.htmlunit.html.HtmlPage;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.context.bean.override.mockito.MockitoBean;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;

@WebMvcTest(UserVehicleController.class)
class MyHtmlUnitTests {

	@Autowired
	private WebClient webClient;

	@MockitoBean
	private UserVehicleService userVehicleService;

	@Test
	void testExample() throws Exception {
		given(this.userVehicleService.getVehicleDetails("sboot")).willReturn(new VehicleDetails("Honda", "Civic"));
		HtmlPage page = this.webClient.getPage("/sboot/vehicle.html");
		assertThat(page.getBody().getTextContent()).isEqualTo("Honda Civic");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.htmlunit.WebClient
import org.htmlunit.html.HtmlPage
import org.junit.jupiter.api.Test
import org.mockito.BDDMockito.given
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.test.context.bean.override.mockito.MockitoBean

@WebMvcTest(UserVehicleController::class)
class MyHtmlUnitTests(@Autowired val webClient: WebClient) {

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

	@Test
	fun testExample() {
		given(userVehicleService.getVehicleDetails("sboot")).willReturn(VehicleDetails("Honda", "Civic"))
		val page = webClient.getPage<HtmlPage>("/sboot/vehicle.html")
		assertThat(page.body.textContent).isEqualTo("Honda Civic")
	}

}

默认情况下，Spring Boot 将 WebDriver bean 放在特殊的"作用域"中，以确保驱动程序在每个测试后退出并注入新实例。如果你不想要这种行为，可以在 WebDriver @Bean 定义中添加 @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON)。

Spring Boot 创建的 webDriver 作用域将替换任何用户定义的相同名称的作用域。如果你定义了自己的 webDriver 作用域，当你使用 @WebMvcTest 时，你可能会发现它停止工作。

如果你的类路径上有 Spring Security，@WebMvcTest 还将扫描 WebSecurityConfigurer bean。对于此类测试，你可以使用 Spring Security 的测试支持，而不是完全禁用安全性。有关如何使用 Spring Security 的 MockMvc 支持的更多详细信息，可以在使用 Spring Security 进行测试 "How-to Guides" 部分找到。

有时编写 Spring MVC 测试是不够的；Spring Boot 可以帮助你运行使用实际服务器的完整端到端测试。

自动配置的 Spring WebFlux 测试

要测试 Spring WebFlux 控制器是否按预期工作，你可以使用 @WebFluxTest 注解。 @WebFluxTest 自动配置 Spring WebFlux 基础设施，并将扫描的 bean 限制为 @Controller、@ControllerAdvice、@JsonComponent、Converter、GenericConverter 和 WebFluxConfigurer。使用 @WebFluxTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

@WebFluxTest 启用的自动配置列表可以在附录中找到。

如果你需要注册额外的组件，例如 Jackson Module，你可以通过在测试上使用 @Import 来导入其他配置类。

通常，@WebFluxTest 仅限于单个控制器，并与 @MockitoBean 注解结合使用，为所需的协作者提供模拟实现。

@WebFluxTest 还自动配置 WebTestClient，它提供了一种强大的方式来快速测试 WebFlux 控制器，而无需启动完整的 HTTP 服务器。

你也可以在非 @WebFluxTest（如 @SpringBootTest）中自动配置 WebTestClient，方法是用 @AutoConfigureWebTestClient 注解它。以下示例显示了一个同时使用 @WebFluxTest 和 WebTestClient 的类：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.bean.override.mockito.MockitoBean;
import org.springframework.test.web.reactive.server.WebTestClient;

import static org.mockito.BDDMockito.given;

@WebFluxTest(UserVehicleController.class)
class MyControllerTests {

	@Autowired
	private WebTestClient webClient;

	@MockitoBean
	private UserVehicleService userVehicleService;

	@Test
	void testExample() {
		given(this.userVehicleService.getVehicleDetails("sboot"))
			.willReturn(new VehicleDetails("Honda", "Civic"));
		this.webClient.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN).exchange()
			.expectStatus().isOk()
			.expectBody(String.class).isEqualTo("Honda Civic");
	}

}

import org.junit.jupiter.api.Test
import org.mockito.BDDMockito.given
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest
import org.springframework.http.MediaType
import org.springframework.test.context.bean.override.mockito.MockitoBean
import org.springframework.test.web.reactive.server.WebTestClient
import org.springframework.test.web.reactive.server.expectBody

@WebFluxTest(UserVehicleController::class)
class MyControllerTests(@Autowired val webClient: WebTestClient) {

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

	@Test
	fun testExample() {
		given(userVehicleService.getVehicleDetails("sboot"))
			.willReturn(VehicleDetails("Honda", "Civic"))
		webClient.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN).exchange()
			.expectStatus().isOk
			.expectBody<String>().isEqualTo("Honda Civic")
	}

}

此设置仅由 WebFlux 应用程序支持，因为目前在模拟的 web 应用程序中使用 WebTestClient 仅适用于 WebFlux。

@WebFluxTest 无法检测通过函数式 web 框架注册的路由。要测试上下文中的 RouterFunction bean，考虑通过使用 @Import 或使用 @SpringBootTest 来自己导入 RouterFunction。

@WebFluxTest 无法检测注册为 @Bean 类型的 SecurityWebFilterChain 的自定义安全配置。要在测试中包含它，你需要通过使用 @Import 或使用 @SpringBootTest 来导入注册该 bean 的配置。

有时编写 Spring WebFlux 测试是不够的；Spring Boot 可以帮助你运行使用实际服务器的完整端到端测试。

自动配置的 Spring GraphQL 测试

Spring GraphQL 提供了专门的测试支持模块；你需要将其添加到你的项目中：

Maven

<dependencies>
	<dependency>
		<groupId>org.springframework.graphql</groupId>
		<artifactId>spring-graphql-test</artifactId>
		<scope>test</scope>
	</dependency>
	<!-- 如果在 compile scope 已经存在则无需添加 -->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-webflux</artifactId>
		<scope>test</scope>
	</dependency>
</dependencies>

Gradle

dependencies {
	testImplementation("org.springframework.graphql:spring-graphql-test")
	// 如果在 implementation 配置中已存在则无需添加
	testImplementation("org.springframework.boot:spring-boot-starter-webflux")
}

该测试模块提供了 GraphQlTester。 GraphQlTester 在测试中被大量使用，因此请务必熟悉其用法。有多种 GraphQlTester 变体，Spring Boot 会根据测试类型自动配置它们：

ExecutionGraphQlServiceTester 用于在服务端进行测试，无需客户端或传输层
HttpGraphQlTester 用于通过客户端连接服务器进行测试，可以有或没有真实服务器

Spring Boot 通过 @GraphQlTest 注解帮助你测试 Spring GraphQL Controllers。 @GraphQlTest 会自动配置 Spring GraphQL 基础设施，无需涉及传输层或服务器。这会将扫描的 bean 限制为 @Controller、RuntimeWiringConfigurer、JsonComponent、Converter、GenericConverter、DataFetcherExceptionResolver、Instrumentation 和 GraphQlSourceBuilderCustomizer。当使用 @GraphQlTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @GraphQlTest 启用的自动配置列表可在附录中找到。

通常，@GraphQlTest 只针对一组 controller，并结合 @MockitoBean 注解，为所需的协作者提供 mock 实现。

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.docs.web.graphql.runtimewiring.GreetingController;
import org.springframework.boot.test.autoconfigure.graphql.GraphQlTest;
import org.springframework.graphql.test.tester.GraphQlTester;

@GraphQlTest(GreetingController.class)
class GreetingControllerTests {

	@Autowired
	private GraphQlTester graphQlTester;

	@Test
	void shouldGreetWithSpecificName() {
		this.graphQlTester.document("{ greeting(name: \"Alice\") } ")
			.execute()
			.path("greeting")
			.entity(String.class)
			.isEqualTo("Hello, Alice!");
	}

	@Test
	void shouldGreetWithDefaultName() {
		this.graphQlTester.document("{ greeting } ")
			.execute()
			.path("greeting")
			.entity(String.class)
			.isEqualTo("Hello, Spring!");
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.docs.web.graphql.runtimewiring.GreetingController
import org.springframework.boot.test.autoconfigure.graphql.GraphQlTest
import org.springframework.graphql.test.tester.GraphQlTester

@GraphQlTest(GreetingController::class)
internal class GreetingControllerTests {

	@Autowired
	lateinit var graphQlTester: GraphQlTester

	@Test
	fun shouldGreetWithSpecificName() {
		graphQlTester.document("{ greeting(name: \"Alice\") } ").execute().path("greeting").entity(String::class.java)
				.isEqualTo("Hello, Alice!")
	}

	@Test
	fun shouldGreetWithDefaultName() {
		graphQlTester.document("{ greeting } ").execute().path("greeting").entity(String::class.java)
				.isEqualTo("Hello, Spring!")
	}

}

@SpringBootTest 测试是完整的集成测试，涉及整个应用程序。当使用随机端口或指定端口时，会配置一个真实服务器，并自动注入 HttpGraphQlTester bean，你可以用它来测试你的服务器。当配置为 MOCK 环境时，也可以通过在测试类上添加 @AutoConfigureHttpGraphQlTester 注解来获取 HttpGraphQlTester bean：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.graphql.tester.AutoConfigureHttpGraphQlTester;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.graphql.test.tester.HttpGraphQlTester;

@AutoConfigureHttpGraphQlTester
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
class GraphQlIntegrationTests {

	@Test
	void shouldGreetWithSpecificName(@Autowired HttpGraphQlTester graphQlTester) {
		HttpGraphQlTester authenticatedTester = graphQlTester.mutate()
			.webTestClient((client) -> client.defaultHeaders((headers) -> headers.setBasicAuth("admin", "ilovespring")))
			.build();
		authenticatedTester.document("{ greeting(name: \"Alice\") } ")
			.execute()
			.path("greeting")
			.entity(String.class)
			.isEqualTo("Hello, Alice!");
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.graphql.tester.AutoConfigureHttpGraphQlTester
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.graphql.test.tester.HttpGraphQlTester
import org.springframework.http.HttpHeaders
import org.springframework.test.web.reactive.server.WebTestClient

@AutoConfigureHttpGraphQlTester
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
class GraphQlIntegrationTests {

	@Test
	fun shouldGreetWithSpecificName(@Autowired graphQlTester: HttpGraphQlTester) {
		val authenticatedTester = graphQlTester.mutate()
			.webTestClient { client: WebTestClient.Builder ->
				client.defaultHeaders { headers: HttpHeaders ->
					headers.setBasicAuth("admin", "ilovespring")
				}
			}.build()
		authenticatedTester.document("{ greeting(name: \"Alice\") } ").execute()
			.path("greeting").entity(String::class.java).isEqualTo("Hello, Alice!")
	}
}

自动配置的 Data Cassandra 测试

你可以使用 @DataCassandraTest 来测试 Cassandra 应用。默认情况下，它会配置一个 CassandraTemplate，扫描 @Table 类，并配置 Spring Data Cassandra 仓库。当使用 @DataCassandraTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 Cassandra 的更多信息，参见 Cassandra。）

通过 @DataCassandraTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了在 Spring Boot 中使用 Cassandra 测试的典型设置：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.cassandra.DataCassandraTest;

@DataCassandraTest
class MyDataCassandraTests {

	@Autowired
	private SomeRepository repository;

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.cassandra.DataCassandraTest

@DataCassandraTest
class MyDataCassandraTests(@Autowired val repository: SomeRepository)

自动配置的 Data Couchbase 测试

你可以使用 @DataCouchbaseTest 来测试 Couchbase 应用。默认情况下，它会配置 CouchbaseTemplate 或 ReactiveCouchbaseTemplate，扫描 @Document 类，并配置 Spring Data Couchbase 仓库。当使用 @DataCouchbaseTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 Couchbase 的更多信息，参见 Couchbase，本章前面内容。）

通过 @DataCouchbaseTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了在 Spring Boot 中使用 Couchbase 测试的典型设置：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.couchbase.DataCouchbaseTest;

@DataCouchbaseTest
class MyDataCouchbaseTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.couchbase.DataCouchbaseTest

@DataCouchbaseTest
class MyDataCouchbaseTests(@Autowired val repository: SomeRepository) {

	// ...

}

自动配置的 Data Elasticsearch 测试

你可以使用 @DataElasticsearchTest 来测试 Elasticsearch 应用。默认情况下，它会配置 ElasticsearchTemplate，扫描 @Document 类，并配置 Spring Data Elasticsearch 仓库。当使用 @DataElasticsearchTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 Elasticsearch 的更多信息，参见 Elasticsearch，本章前面内容。）

通过 @DataElasticsearchTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了在 Spring Boot 中使用 Elasticsearch 测试的典型设置：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.elasticsearch.DataElasticsearchTest;

@DataElasticsearchTest
class MyDataElasticsearchTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.elasticsearch.DataElasticsearchTest

@DataElasticsearchTest
class MyDataElasticsearchTests(@Autowired val repository: SomeRepository) {

	// ...

}

自动配置的 Data JPA 测试

你可以使用 @DataJpaTest 注解来测试 JPA 应用。默认情况下，它会扫描 @Entity 类并配置 Spring Data JPA 仓库。如果类路径上有嵌入式数据库，也会自动配置一个。 SQL 查询默认会通过设置 spring.jpa.show-sql 属性为 true 进行日志输出。可以通过注解的 showSql 属性禁用此功能。

当使用 @DataJpaTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @DataJpaTest 启用的自动配置设置列表可在附录中找到。

默认情况下，data JPA 测试是事务性的，并在每个测试结束时回滚。更多细节请参见 Spring Framework 参考文档中相关章节。如果你不希望这样，可以为某个测试或整个类禁用事务管理，如下所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@DataJpaTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyNonTransactionalTests {

	// ...

}

import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest
import org.springframework.transaction.annotation.Propagation
import org.springframework.transaction.annotation.Transactional

@DataJpaTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyNonTransactionalTests {

	// ...

}

Data JPA 测试还可以注入 TestEntityManager bean，它是专为测试设计的标准 JPA EntityManager 的替代方案。

你也可以通过添加 @AutoConfigureTestEntityManager，将 TestEntityManager 自动配置到任何 Spring 测试类中。这样做时，请确保你的测试运行在事务中，例如在测试类或方法上添加 @Transactional。

如果需要，还可以使用 JdbcTemplate。以下示例展示了 @DataJpaTest 注解的用法：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager;

import static org.assertj.core.api.Assertions.assertThat;

@DataJpaTest
class MyRepositoryTests {

	@Autowired
	private TestEntityManager entityManager;

	@Autowired
	private UserRepository repository;

	@Test
	void testExample() {
		this.entityManager.persist(new User("sboot", "1234"));
		User user = this.repository.findByUsername("sboot");
		assertThat(user.getUsername()).isEqualTo("sboot");
		assertThat(user.getEmployeeNumber()).isEqualTo("1234");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest
import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager

@DataJpaTest
class MyRepositoryTests(@Autowired val entityManager: TestEntityManager, @Autowired val repository: UserRepository) {

	@Test
	fun testExample() {
		entityManager.persist(User("sboot", "1234"))
		val user = repository.findByUsername("sboot")
		assertThat(user?.username).isEqualTo("sboot")
		assertThat(user?.employeeNumber).isEqualTo("1234")
	}

}

内存嵌入式数据库通常非常适合测试，因为它们速度快且无需安装。但如果你希望针对真实数据库运行测试，可以使用 @AutoConfigureTestDatabase 注解，如下例所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.Replace;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;

@DataJpaTest
@AutoConfigureTestDatabase(replace = Replace.NONE)
class MyRepositoryTests {

	// ...

}

import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class MyRepositoryTests {

	// ...

}

自动配置的 JDBC 测试

@JdbcTest 类似于 @DataJpaTest，但用于只需要 DataSource 且不使用 Spring Data JDBC 的测试。默认情况下，它会配置一个内存嵌入式数据库和 JdbcTemplate。当使用 @JdbcTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @JdbcTest 启用的自动配置设置列表可在附录中找到。

默认情况下，JDBC 测试是事务性的，并在每个测试结束时回滚。更多细节请参见 Spring Framework 参考文档中相关章节。如果你不希望这样，可以为某个测试或整个类禁用事务管理，如下所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@JdbcTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyTransactionalTests {

}

import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest
import org.springframework.transaction.annotation.Propagation
import org.springframework.transaction.annotation.Transactional

@JdbcTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyTransactionalTests

如果你希望测试针对真实数据库运行，可以像 @DataJpaTest 一样使用 @AutoConfigureTestDatabase 注解。（参见自动配置的 Data JPA 测试。）

自动配置的 Data JDBC 测试

@DataJdbcTest 类似于 @JdbcTest，但用于使用 Spring Data JDBC 仓库的测试。默认情况下，它会配置一个内存嵌入式数据库、JdbcTemplate 和 Spring Data JDBC 仓库。当使用 @DataJdbcTest 注解时，只会扫描 AbstractJdbcConfiguration 的子类，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @DataJdbcTest 启用的自动配置设置列表可在附录中找到。

默认情况下，Data JDBC 测试是事务性的，并在每个测试结束时回滚。更多细节请参见 Spring Framework 参考文档中相关章节。如果你不希望这样，可以为某个测试或整个测试类禁用事务管理，具体见在 JDBC 示例中。

如果你希望测试针对真实数据库运行，可以像 @DataJpaTest 一样使用 @AutoConfigureTestDatabase 注解。（参见自动配置的 Data JPA 测试。）

自动配置的 Data R2DBC 测试

@DataR2dbcTest 类似于 @DataJdbcTest，但用于使用 Spring Data R2DBC 仓库的测试。默认情况下，它会配置一个内存嵌入式数据库、R2dbcEntityTemplate 和 Spring Data R2DBC 仓库。当使用 @DataR2dbcTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @DataR2dbcTest 启用的自动配置设置列表可在附录中找到。

默认情况下，Data R2DBC 测试不是事务性的。

如果你希望测试针对真实数据库运行，可以像 @DataJpaTest 一样使用 @AutoConfigureTestDatabase 注解。（参见自动配置的 Data JPA 测试。）

自动配置的 jOOQ 测试

你可以像使用 @JdbcTest 一样使用 @JooqTest，但用于 jOOQ 相关测试。 jOOQ 严重依赖于与数据库 schema 对应的 Java schema，因此会使用现有的 DataSource。如果你想用内存数据库替换它，可以使用 @AutoConfigureTestDatabase 覆盖这些设置。（关于在 Spring Boot 中使用 jOOQ 的更多信息，参见使用 jOOQ。）当使用 @JooqTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @JooqTest 启用的自动配置设置列表可在附录中找到。

@JooqTest 会配置一个 DSLContext。以下示例展示了 @JooqTest 注解的用法：

Java
Kotlin

import org.jooq.DSLContext;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jooq.JooqTest;

@JooqTest
class MyJooqTests {

	@Autowired
	private DSLContext dslContext;

	// ...

}

import org.jooq.DSLContext
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.jooq.JooqTest

@JooqTest
class MyJooqTests(@Autowired val dslContext: DSLContext) {

	// ...

}

JOOQ 测试默认是事务性的，并在每个测试结束时回滚。如果你不希望这样，可以为某个测试或整个测试类禁用事务管理，具体见在 JDBC 示例中。

自动配置的 Data MongoDB 测试

你可以使用 @DataMongoTest 来测试 MongoDB 应用。默认情况下，它会配置 MongoTemplate，扫描 @Document 类，并配置 Spring Data MongoDB 仓库。当使用 @DataMongoTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 MongoDB 的更多信息，参见 MongoDB。）

通过 @DataMongoTest 启用的自动配置设置列表可在附录中找到。

以下类展示了 @DataMongoTest 注解的用法：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
import org.springframework.data.mongodb.core.MongoTemplate;

@DataMongoTest
class MyDataMongoDbTests {

	@Autowired
	private MongoTemplate mongoTemplate;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest
import org.springframework.data.mongodb.core.MongoTemplate

@DataMongoTest
class MyDataMongoDbTests(@Autowired val mongoTemplate: MongoTemplate) {

	// ...

}

自动配置的 Data Neo4j 测试

你可以使用 @DataNeo4jTest 来测试 Neo4j 应用。默认情况下，它会扫描 @Node 类，并配置 Spring Data Neo4j 仓库。当使用 @DataNeo4jTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 Neo4J 的更多信息，参见 Neo4j。）

通过 @DataNeo4jTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了在 Spring Boot 中使用 Neo4J 测试的典型设置：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;

@DataNeo4jTest
class MyDataNeo4jTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest

@DataNeo4jTest
class MyDataNeo4jTests(@Autowired val repository: SomeRepository) {

	// ...

}

默认情况下，Data Neo4j 测试是事务性的，并在每个测试结束时回滚。更多细节请参见 Spring Framework 参考文档中相关章节。如果你不希望这样，可以为某个测试或整个类禁用事务管理，如下所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@DataNeo4jTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyDataNeo4jTests {

}

import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest
import org.springframework.transaction.annotation.Propagation
import org.springframework.transaction.annotation.Transactional

@DataNeo4jTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyDataNeo4jTests

响应式访问方式下不支持事务性测试。如果你使用这种风格，必须如上所述配置 @DataNeo4jTest 测试。

自动配置的 Data Redis 测试

你可以使用 @DataRedisTest 来测试 Redis 应用。默认情况下，它会扫描 @RedisHash 类，并配置 Spring Data Redis 仓库。当使用 @DataRedisTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 Redis 的更多信息，参见 Redis。）

通过 @DataRedisTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了 @DataRedisTest 注解的用法：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.redis.DataRedisTest;

@DataRedisTest
class MyDataRedisTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.redis.DataRedisTest

@DataRedisTest
class MyDataRedisTests(@Autowired val repository: SomeRepository) {

	// ...

}

自动配置的 Data LDAP 测试

你可以使用 @DataLdapTest 来测试 LDAP 应用。默认情况下，它会配置一个内存嵌入式 LDAP（如果可用）、LdapTemplate，扫描 @Entry 类，并配置 Spring Data LDAP 仓库。当使用 @DataLdapTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。（关于在 Spring Boot 中使用 LDAP 的更多信息，参见 LDAP。）

通过 @DataLdapTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了 @DataLdapTest 注解的用法：

Java
Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest;
import org.springframework.ldap.core.LdapTemplate;

@DataLdapTest
class MyDataLdapTests {

	@Autowired
	private LdapTemplate ldapTemplate;

	// ...

}

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest
import org.springframework.ldap.core.LdapTemplate

@DataLdapTest
class MyDataLdapTests(@Autowired val ldapTemplate: LdapTemplate) {

	// ...

}

内存嵌入式 LDAP 通常非常适合测试，因为它速度快且无需开发者安装。但如果你希望针对真实 LDAP 服务器运行测试，应排除嵌入式 LDAP 自动配置，如下例所示：

Java
Kotlin

import org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration;
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest;

@DataLdapTest(excludeAutoConfiguration = EmbeddedLdapAutoConfiguration.class)
class MyDataLdapTests {

	// ...

}

import org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration
import org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest

@DataLdapTest(excludeAutoConfiguration = [EmbeddedLdapAutoConfiguration::class])
class MyDataLdapTests {

	// ...

}

自动配置的 REST 客户端测试

你可以使用 @RestClientTest 注解来测试 REST 客户端。默认情况下，它会自动配置 Jackson、GSON 和 Jsonb 支持，配置 RestTemplateBuilder 和 RestClient.Builder，并添加对 MockRestServiceServer 的支持。当使用 @RestClientTest 注解时，常规的 @Component 和 @ConfigurationProperties bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties bean。

通过 @RestClientTest 启用的自动配置设置列表可在附录中找到。

你要测试的具体 bean 应通过 @RestClientTest 的 value 或 components 属性指定。

当被测 bean 中使用 RestTemplateBuilder 并在构建 RestTemplate 时调用了 RestTemplateBuilder.rootUri(String rootUri)，则在 MockRestServiceServer 期望中应省略 root URI，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.client.RestClientTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.client.MockRestServiceServer;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

@RestClientTest(org.springframework.boot.docs.testing.springbootapplications.autoconfiguredrestclient.RemoteVehicleDetailsService.class)
class MyRestTemplateServiceTests {

	@Autowired
	private RemoteVehicleDetailsService service;

	@Autowired
	private MockRestServiceServer server;

	@Test
	void getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() {
		this.server.expect(requestTo("/greet/details")).andRespond(withSuccess("hello", MediaType.TEXT_PLAIN));
		String greeting = this.service.callRestService();
		assertThat(greeting).isEqualTo("hello");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.client.RestClientTest
import org.springframework.http.MediaType
import org.springframework.test.web.client.MockRestServiceServer
import org.springframework.test.web.client.match.MockRestRequestMatchers
import org.springframework.test.web.client.response.MockRestResponseCreators

@RestClientTest(RemoteVehicleDetailsService::class)
class MyRestTemplateServiceTests(
	@Autowired val service: RemoteVehicleDetailsService,
	@Autowired val server: MockRestServiceServer) {

	@Test
	fun getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() {
		server.expect(MockRestRequestMatchers.requestTo("/greet/details"))
			.andRespond(MockRestResponseCreators.withSuccess("hello", MediaType.TEXT_PLAIN))
		val greeting = service.callRestService()
		assertThat(greeting).isEqualTo("hello")
	}

}

当被测 bean 中使用 RestClient.Builder，或使用 RestTemplateBuilder 但未调用 rootUri(String rootURI) 时，在 MockRestServiceServer 期望中必须使用完整 URI，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.client.RestClientTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.client.MockRestServiceServer;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

@RestClientTest(RemoteVehicleDetailsService.class)
class MyRestClientServiceTests {

	@Autowired
	private RemoteVehicleDetailsService service;

	@Autowired
	private MockRestServiceServer server;

	@Test
	void getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() {
		this.server.expect(requestTo("https://example.com/greet/details"))
			.andRespond(withSuccess("hello", MediaType.TEXT_PLAIN));
		String greeting = this.service.callRestService();
		assertThat(greeting).isEqualTo("hello");
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.client.RestClientTest
import org.springframework.http.MediaType
import org.springframework.test.web.client.MockRestServiceServer
import org.springframework.test.web.client.match.MockRestRequestMatchers
import org.springframework.test.web.client.response.MockRestResponseCreators

@RestClientTest(RemoteVehicleDetailsService::class)
class MyRestClientServiceTests(
	@Autowired val service: RemoteVehicleDetailsService,
	@Autowired val server: MockRestServiceServer) {

	@Test
	fun getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() {
		server.expect(MockRestRequestMatchers.requestTo("https://example.com/greet/details"))
			.andRespond(MockRestResponseCreators.withSuccess("hello", MediaType.TEXT_PLAIN))
		val greeting = service.callRestService()
		assertThat(greeting).isEqualTo("hello")
	}

}

自动配置的 Spring REST Docs 测试

你可以使用 @AutoConfigureRestDocs 注解，在使用 Mock MVC、REST Assured 或 WebTestClient 进行测试时集成 Spring REST Docs。它免去了在 Spring REST Docs 中添加 JUnit 扩展的需求。

@AutoConfigureRestDocs 可用于覆盖默认输出目录（Maven 下为 target/generated-snippets，Gradle 下为 build/generated-snippets）。也可用于配置文档化 URI 中出现的 host、scheme 和 port。

基于 Mock MVC 的自动配置 Spring REST Docs 测试

@AutoConfigureRestDocs 会自定义 MockMvc bean，使其在测试 servlet web 应用时集成 Spring REST Docs。你可以通过 @Autowired 注入它，并像平时使用 Mock MVC 和 Spring REST Docs 一样在测试中使用，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.assertj.MockMvcTester;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;

@WebMvcTest(UserController.class)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

	@Autowired
	private MockMvcTester mvc;

	@Test
	void listUsers() {
		assertThat(this.mvc.get().uri("/users").accept(MediaType.TEXT_PLAIN)).hasStatusOk()
			.apply(document("list-users"));
	}

}

如果你更喜欢 AssertJ 集成，也可以使用 MockMvcTester，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.assertj.MockMvcTester;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;

@WebMvcTest(UserController.class)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

	@Autowired
	private MockMvcTester mvc;

	@Test
	void listUsers() {
		assertThat(this.mvc.get().uri("/users").accept(MediaType.TEXT_PLAIN)).hasStatusOk()
			.apply(document("list-users"));
	}

}

两者在底层复用同一个 MockMvc 实例，因此任何配置都会同时生效。

如果你需要比 @AutoConfigureRestDocs 属性更细致的 Spring REST Docs 配置，可以使用 RestDocsMockMvcConfigurationCustomizer bean，如下例所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsMockMvcConfigurationCustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
import org.springframework.restdocs.templates.TemplateFormats;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements RestDocsMockMvcConfigurationCustomizer {

	@Override
	public void customize(MockMvcRestDocumentationConfigurer configurer) {
		configurer.snippets().withTemplateFormat(TemplateFormats.markdown());
	}

}

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsMockMvcConfigurationCustomizer
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer
import org.springframework.restdocs.templates.TemplateFormats

@TestConfiguration(proxyBeanMethods = false)
class MyRestDocsConfiguration : RestDocsMockMvcConfigurationCustomizer {

	override fun customize(configurer: MockMvcRestDocumentationConfigurer) {
		configurer.snippets().withTemplateFormat(TemplateFormats.markdown())
	}

}

如果你想利用 Spring REST Docs 对参数化输出目录的支持，可以创建 RestDocumentationResultHandler bean。自动配置会对该结果处理器调用 alwaysDo，从而使每次 MockMvc 调用都自动生成默认片段。如下例所示：

Java
Kotlin

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;

@TestConfiguration(proxyBeanMethods = false)
public class MyResultHandlerConfiguration {

	@Bean
	public RestDocumentationResultHandler restDocumentation() {
		return MockMvcRestDocumentation.document("{method-name}");
	}

}

import org.springframework.boot.test.context.TestConfiguration
import org.springframework.context.annotation.Bean
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation
import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

@TestConfiguration(proxyBeanMethods = false)
class MyResultHandlerConfiguration {

	@Bean
	fun restDocumentation(): RestDocumentationResultHandler {
		return MockMvcRestDocumentation.document("{method-name}")
	}

}

基于 WebTestClient 的自动配置 Spring REST Docs 测试

@AutoConfigureRestDocs 也可与 WebTestClient 配合使用，用于测试响应式 web 应用。你可以通过 @Autowired 注入它，并像平时使用 @WebFluxTest 和 Spring REST Docs 一样在测试中使用，如下例所示：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
import org.springframework.test.web.reactive.server.WebTestClient;

import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;

@WebFluxTest
@AutoConfigureRestDocs
class MyUsersDocumentationTests {

	@Autowired
	private WebTestClient webTestClient;

	@Test
	void listUsers() {
		this.webTestClient
			.get().uri("/")
		.exchange()
		.expectStatus()
			.isOk()
		.expectBody()
			.consumeWith(document("list-users"));
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest
import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation
import org.springframework.test.web.reactive.server.WebTestClient

@WebFluxTest
@AutoConfigureRestDocs
class MyUsersDocumentationTests(@Autowired val webTestClient: WebTestClient) {

	@Test
	fun listUsers() {
		webTestClient
			.get().uri("/")
			.exchange()
			.expectStatus()
			.isOk
			.expectBody()
			.consumeWith(WebTestClientRestDocumentation.document("list-users"))
	}

}

如果你需要比 @AutoConfigureRestDocs 属性更细致的 Spring REST Docs 配置，可以使用 RestDocsWebTestClientConfigurationCustomizer bean，如下例所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements RestDocsWebTestClientConfigurationCustomizer {

	@Override
	public void customize(WebTestClientRestDocumentationConfigurer configurer) {
		configurer.snippets().withEncoding("UTF-8");
	}

}

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer

@TestConfiguration(proxyBeanMethods = false)
class MyRestDocsConfiguration : RestDocsWebTestClientConfigurationCustomizer {

	override fun customize(configurer: WebTestClientRestDocumentationConfigurer) {
		configurer.snippets().withEncoding("UTF-8")
	}

}

如果你想利用 Spring REST Docs 对参数化输出目录的支持，可以使用 WebTestClientBuilderCustomizer 为每个 entity exchange result 配置一个 consumer。如下例所示：

Java
Kotlin

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.test.web.reactive.server.WebTestClientBuilderCustomizer;
import org.springframework.context.annotation.Bean;

import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;

@TestConfiguration(proxyBeanMethods = false)
public class MyWebTestClientBuilderCustomizerConfiguration {

	@Bean
	public WebTestClientBuilderCustomizer restDocumentation() {
		return (builder) -> builder.entityExchangeResultConsumer(document("{method-name}"));
	}

}

import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.test.web.reactive.server.WebTestClientBuilderCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation
import org.springframework.test.web.reactive.server.WebTestClient

@TestConfiguration(proxyBeanMethods = false)
class MyWebTestClientBuilderCustomizerConfiguration {

	@Bean
	fun restDocumentation(): WebTestClientBuilderCustomizer {
		return WebTestClientBuilderCustomizer { builder: WebTestClient.Builder ->
			builder.entityExchangeResultConsumer(
				WebTestClientRestDocumentation.document("{method-name}")
			)
		}
	}

}

基于 REST Assured 的自动配置 Spring REST Docs 测试

@AutoConfigureRestDocs 会提供一个预配置好用于 Spring REST Docs 的 RequestSpecification bean，可在测试中通过 @Autowired 注入并像平时一样配合 REST Assured 和 Spring REST Docs 使用，如下例所示：

Java
Kotlin

import io.restassured.specification.RequestSpecification;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.server.LocalServerPort;

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.is;
import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

	@Test
	void listUsers(@Autowired RequestSpecification documentationSpec, @LocalServerPort int port) {
		given(documentationSpec)
			.filter(document("list-users"))
		.when()
			.port(port)
			.get("/")
		.then().assertThat()
			.statusCode(is(200));
	}

}

import io.restassured.RestAssured
import io.restassured.specification.RequestSpecification
import org.hamcrest.Matchers
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment
import org.springframework.boot.test.web.server.LocalServerPort
import org.springframework.restdocs.restassured.RestAssuredRestDocumentation

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureRestDocs
class MyUserDocumentationTests {

	@Test
	fun listUsers(@Autowired documentationSpec: RequestSpecification?, @LocalServerPort port: Int) {
		RestAssured.given(documentationSpec)
			.filter(RestAssuredRestDocumentation.document("list-users"))
			.`when`()
			.port(port)["/"]
			.then().assertThat()
			.statusCode(Matchers.`is`(200))
	}

}

如果你需要比 @AutoConfigureRestDocs 属性更细致的 Spring REST Docs 配置，可以使用 RestDocsRestAssuredConfigurationCustomizer bean，如下例所示：

Java
Kotlin

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationCustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer;
import org.springframework.restdocs.templates.TemplateFormats;

@TestConfiguration(proxyBeanMethods = false)
public class MyRestDocsConfiguration implements RestDocsRestAssuredConfigurationCustomizer {

	@Override
	public void customize(RestAssuredRestDocumentationConfigurer configurer) {
		configurer.snippets().withTemplateFormat(TemplateFormats.markdown());
	}

}

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationCustomizer
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer
import org.springframework.restdocs.templates.TemplateFormats

@TestConfiguration(proxyBeanMethods = false)
class MyRestDocsConfiguration : RestDocsRestAssuredConfigurationCustomizer {

	override fun customize(configurer: RestAssuredRestDocumentationConfigurer) {
		configurer.snippets().withTemplateFormat(TemplateFormats.markdown())
	}

}

自动配置的 Spring Web Services 测试

自动配置的 Spring Web Services 客户端测试

你可以使用 @WebServiceClientTest 来测试使用 Spring Web Services 项目调用 web 服务的应用。默认情况下，它会配置 MockWebServiceServer bean，并自动自定义你的 WebServiceTemplateBuilder。（关于在 Spring Boot 中使用 Web Services 的更多信息，参见 Web 服务。）

通过 @WebServiceClientTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了 @WebServiceClientTest 注解的用法：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.webservices.client.WebServiceClientTest;
import org.springframework.ws.test.client.MockWebServiceServer;
import org.springframework.xml.transform.StringSource;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.ws.test.client.RequestMatchers.payload;
import static org.springframework.ws.test.client.ResponseCreators.withPayload;

@WebServiceClientTest(SomeWebService.class)
class MyWebServiceClientTests {

	@Autowired
	private MockWebServiceServer server;

	@Autowired
	private SomeWebService someWebService;

	@Test
	void mockServerCall() {
		this.server
			.expect(payload(new StringSource("<request/>")))
			.andRespond(withPayload(new StringSource("<response><status>200</status></response>")));
		assertThat(this.someWebService.test())
			.extracting(Response::getStatus)
			.isEqualTo(200);
	}

}

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.webservices.client.WebServiceClientTest
import org.springframework.ws.test.client.MockWebServiceServer
import org.springframework.ws.test.client.RequestMatchers
import org.springframework.ws.test.client.ResponseCreators
import org.springframework.xml.transform.StringSource

@WebServiceClientTest(SomeWebService::class)
class MyWebServiceClientTests(@Autowired val server: MockWebServiceServer, @Autowired val someWebService: SomeWebService) {

	@Test
	fun mockServerCall() {
		server
			.expect(RequestMatchers.payload(StringSource("<request/>")))
			.andRespond(ResponseCreators.withPayload(StringSource("<response><status>200</status></response>")))
		assertThat(this.someWebService.test()).extracting(Response::status).isEqualTo(200)
	}

}

自动配置的 Spring Web Services 服务端测试

你可以使用 @WebServiceServerTest 来测试使用 Spring Web Services 项目实现 web 服务的应用。默认情况下，它会配置 MockWebServiceClient bean，可用于调用你的 web 服务端点。（关于在 Spring Boot 中使用 Web Services 的更多信息，参见 Web 服务。）

通过 @WebServiceServerTest 启用的自动配置设置列表可在附录中找到。

以下示例展示了 @WebServiceServerTest 注解的用法：

Java
Kotlin

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.webservices.server.WebServiceServerTest;
import org.springframework.ws.test.server.MockWebServiceClient;
import org.springframework.ws.test.server.RequestCreators;
import org.springframework.ws.test.server.ResponseMatchers;
import org.springframework.xml.transform.StringSource;

@WebServiceServerTest(ExampleEndpoint.class)
class MyWebServiceServerTests {

	@Autowired
	private MockWebServiceClient client;

	@Test
	void mockServerCall() {
		this.client
			.sendRequest(RequestCreators.withPayload(new StringSource("<ExampleRequest/>")))
			.andExpect(ResponseMatchers.payload(new StringSource("<ExampleResponse>42</ExampleResponse>")));
	}

}

import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.webservices.server.WebServiceServerTest
import org.springframework.ws.test.server.MockWebServiceClient
import org.springframework.ws.test.server.RequestCreators
import org.springframework.ws.test.server.ResponseMatchers
import org.springframework.xml.transform.StringSource

@WebServiceServerTest(ExampleEndpoint::class)
class MyWebServiceServerTests(@Autowired val client: MockWebServiceClient) {

	@Test
	fun mockServerCall() {
		client
			.sendRequest(RequestCreators.withPayload(StringSource("<ExampleRequest/>")))
			.andExpect(ResponseMatchers.payload(StringSource("<ExampleResponse>42</ExampleResponse>")))
	}

}

额外自动配置与切片

每个切片都提供一个或多个 @AutoConfigure… 注解，用于定义该切片应包含的自动配置。可以通过创建自定义 @AutoConfigure… 注解，或在测试中添加 @ImportAutoConfiguration，为每个测试单独添加额外的自动配置，如下例所示：

Java
Kotlin

import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration;
import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest;

@JdbcTest
@ImportAutoConfiguration(IntegrationAutoConfiguration.class)
class MyJdbcTests {

}

import org.springframework.boot.autoconfigure.ImportAutoConfiguration
import org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration
import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest

@JdbcTest
@ImportAutoConfiguration(IntegrationAutoConfiguration::class)
class MyJdbcTests

请勿使用常规的 @Import 注解导入自动配置，因为 Spring Boot 会以特定方式处理自动配置。

另外，也可以通过在 META-INF/spring 目录下注册文件，为任何切片注解的使用添加额外自动配置，如下例所示：

META-INF/spring/org.springframework.boot.test.autoconfigure.jdbc.JdbcTest.imports

com.example.IntegrationAutoConfiguration

在本例中，com.example.IntegrationAutoConfiguration 会在每个带有 @JdbcTest 注解的测试中启用。

你可以在该文件中使用 # 注释。

只要切片或 @AutoConfigure… 注解带有 @ImportAutoConfiguration 元注解，就可以用这种方式自定义。

用户配置与切片

如果你合理地组织你的代码，你的 @SpringBootApplication 类会被默认用作测试的配置（参见检测测试配置）。

这时就很重要，不要在应用主类中堆砌特定于某一功能区域的配置。

假设你使用 Spring Data MongoDB，依赖其自动配置，并启用了审计。你可能会这样定义你的 @SpringBootApplication：

Java
Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.mongodb.config.EnableMongoAuditing;

@SpringBootApplication
@EnableMongoAuditing
public class MyApplication {

	// ...

}

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.data.mongodb.config.EnableMongoAuditing

@SpringBootApplication
@EnableMongoAuditing
class MyApplication {

	// ...

}

由于该类是测试的配置源，任何切片测试实际上都会尝试启用 Mongo 审计，这显然不是你想要的。推荐的做法是将该区域的配置移到与应用同级的单独 @Configuration 类中，如下例所示：

Java
Kotlin

import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.config.EnableMongoAuditing;

@Configuration(proxyBeanMethods = false)
@EnableMongoAuditing
public class MyMongoConfiguration {

	// ...

}

import org.springframework.context.annotation.Configuration
import org.springframework.data.mongodb.config.EnableMongoAuditing

@Configuration(proxyBeanMethods = false)
@EnableMongoAuditing
class MyMongoConfiguration {

	// ...

}

具体做法可根据应用复杂度选择，可以为所有自定义配置用一个 @Configuration 类，也可以每个领域一个。后一种方式可以让你在需要时通过 @Import 注解在某个测试中启用。更多关于何时为切片测试启用特定 @Configuration 类的细节，参见本 how-to 小节。

切片测试会排除 @Configuration 类的扫描。例如，对于 @WebMvcTest，如下配置不会将给定的 WebMvcConfigurer bean 加载到测试切片的上下文中：

Java
Kotlin

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration(proxyBeanMethods = false)
public class MyWebConfiguration {

	@Bean
	public WebMvcConfigurer testConfigurer() {
		return new WebMvcConfigurer() {
			// ...
		};
	}

}

import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@Configuration(proxyBeanMethods = false)
class MyWebConfiguration {

	@Bean
	fun testConfigurer(): WebMvcConfigurer {
		return object : WebMvcConfigurer {
			// ...
		}
	}

}

但下面的配置会让自定义的 WebMvcConfigurer 被测试切片加载。

Java
Kotlin

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Component
public class MyWebMvcConfigurer implements WebMvcConfigurer {

	// ...

}

import org.springframework.stereotype.Component
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@Component
class MyWebMvcConfigurer : WebMvcConfigurer {

	// ...

}

另一个常见困惑是类路径扫描。假设你虽然合理组织了代码，但需要扫描额外的包。你的应用可能类似如下代码：

Java
Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan({ "com.example.app", "com.example.another" })
public class MyApplication {

	// ...

}

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.context.annotation.ComponentScan

@SpringBootApplication
@ComponentScan("com.example.app", "com.example.another")
class MyApplication {

	// ...

}

这样做实际上会覆盖默认的组件扫描指令，导致无论你选择哪个切片，这两个包都会被扫描。例如，@DataJpaTest 似乎突然扫描了应用的组件和用户配置。同样，推荐将自定义指令移到单独的类中以解决此问题。

如果无法这样做，你可以在测试层级中某处创建一个 @SpringBootConfiguration，这样它就会被用作配置。或者，你也可以为测试指定 source，从而禁用默认查找。

使用 Spock 测试 Spring Boot 应用

Spock 2.2 或更高版本可用于测试 Spring Boot 应用。为此，请在应用的构建中添加 -groovy-4.0 版本的 Spock 的 spock-spring 模块依赖。 spock-spring 将 Spring 的测试框架集成到 Spock。更多细节请参见 Spock Spring 模块文档。