跳到主要内容
版本：4.0.2

Testing Spring Boot Applications

QWen Max 中英对照 Testing Spring Boot Applications

Spring Boot 应用程序就是一个 Spring ApplicationContext，因此除了对普通的 Spring 上下文通常所做的测试之外，无需进行任何特别的操作来测试它。

备注

外部属性、日志记录以及 Spring Boot 的其他特性默认仅在你使用 SpringApplication 创建上下文时才会被安装到上下文中。

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

提示

如果你使用的是 JUnit 4，请不要忘记在测试类上添加 @RunWith(SpringRunner.class)，否则这些注解将被忽略。如果你使用的是 JUnit 6，则无需显式添加等效的 @ExtendWith(SpringExtension.class)，因为 @SpringBootTest 以及其他 @…​Test 注解已经默认包含了该注解。

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

  • MOCK（默认）：加载一个 Web ApplicationContext，并提供一个模拟的 Web 环境。使用此注解时，不会启动内嵌服务器。如果 classpath 中没有可用的 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 客户端和服务器运行在不同的线程中，因此也处于不同的事务中。在这种情况下，服务器端发起的任何事务都不会被回滚。

备注

如果您的应用程序为管理服务器（management server）使用了不同的端口，那么带有 webEnvironment = WebEnvironment.RANDOM_PORT 的 @SpringBootTest 也会在另一个随机端口上启动管理服务器。

检测 Web 应用程序类型​

如果 Spring MVC 可用，则会配置一个基于常规 MVC 的应用上下文。如果你仅使用 Spring WebFlux，我们会检测到这一点，并转而配置一个基于 WebFlux 的应用上下文。

如果两者都存在，Spring MVC 优先。如果要在此场景下测试响应式 Web 应用程序，必须设置 spring.main.web-application-type 属性：

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 底层的组件扫描配置定义了排除过滤器（exclude filters），用于确保切片（slicing）能按预期工作。如果你在带有 @SpringBootApplication 注解的类上显式使用了 @ComponentScan 指令，请注意这些过滤器将被禁用。如果你使用了切片，应重新定义这些过滤器。

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

备注

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

使用测试配置主方法​

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

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

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

}

在上面的示例中，main 方法除了委托给 SpringApplication.run(Class, String…​) 之外没有做任何其他事情。然而，也可以拥有一个更复杂的 main 方法，在调用 SpringApplication.run(Class, String…​) 之前应用自定义配置。

例如，以下是一个更改 banner 模式并设置额外配置文件的应用程序：

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

}

由于 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 方法设置了额外的 profiles，那么这些 profiles 将在 ApplicationContext 启动时处于激活状态。

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() {
		// ...
	}

}

排除测试配置​

如果你的应用程序使用了组件扫描（例如，使用了 @SpringBootApplication 或 @ComponentScan），你可能会发现那些仅为特定测试而创建的顶层配置类被意外地在所有地方加载。

正如我们之前所见，可以在测试类的内部类上使用 @TestConfiguration 来定制主配置。@TestConfiguration 也可以用在顶层类上。这样做表示该类不应被组件扫描自动发现。然后，你可以在需要的地方显式导入该类，如下例所示：

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() {
		// ...
	}

}
备注

如果你直接使用 @ComponentScan（即不通过 @SpringBootApplication），你需要将其与 TypeExcludeFilter 一起注册。详情请参见 TypeExcludeFilter 的 API 文档。

备注

被导入的 @TestConfiguration 会比内部类的 @TestConfiguration 更早被处理，而且被导入的 @TestConfiguration 也会在通过组件扫描发现的任何配置之前被处理。一般来说，这种顺序上的差异不会产生明显的影响，但如果你依赖于 Bean 的覆盖行为，则需要注意这一点。

使用 Application Arguments​

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

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

}

使用 Mock 环境进行测试​

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

使用 Spring MVC，我们可以通过 MockMvc 来查询我们的 Web 端点。以下是可用的集成：

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.assertj.MockMvcTester;
import org.springframework.test.web.servlet.client.RestTestClient;
import org.springframework.test.web.servlet.client.RestTestClient.ResponseSpec;
import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse;

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
@AutoConfigureRestTestClient
@AutoConfigureWebTestClient
class MyMockMvcTests {

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

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

	@Test
	void testWithRestTestClient(@Autowired RestTestClient restClient) {
		restClient
				.get().uri("/")
				.exchange()
				.expectStatus().isOk()
				.expectBody(String.class).isEqualTo("Hello World");
	}

	@Test // If you prefer AssertJ, dedicated assertions are available
	void testWithRestTestClientAssertJ(@Autowired RestTestClient restClient) {
		ResponseSpec spec = restClient.get().uri("/").exchange();
		RestTestClientResponse response = RestTestClientResponse.from(spec);
		assertThat(response).hasStatusOk()
				.bodyText().isEqualTo("Hello World");
	}

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

}
提示

如果你只想专注于 Web 层，而不启动完整的 ApplicationContext，请考虑改用 #testing.spring-boot-applications.spring-mvc-tests 中的 @WebMvcTest。

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient;
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");
	}

}
提示

在模拟环境中进行测试通常比使用完整的 Servlet 容器运行更快。然而，由于模拟发生在 Spring MVC 层，因此依赖于底层 Servlet 容器行为的代码无法直接通过 MockMvc 进行测试。

例如，Spring Boot 的错误处理基于 Servlet 容器提供的“错误页”支持。这意味着，虽然你可以测试你的 MVC 层是否按预期抛出和处理异常，但无法直接测试某个特定的自定义错误页是否被渲染。如果你需要测试这些底层相关的问题，可以按照下一节所述启动一个完全运行的服务器。

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

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

@LocalServerポート アノテーションを使用して、テストに実際に使用されたポートを注入できます。

需要向已启动的服务器发起 REST 调用的测试，可以通过在测试类上添加 @AutoConfigureRestTestClient 注解来自动装配一个 RestTestClient。

配置好的客户端会将相对链接解析为正在运行的服务器地址，并提供了一个专门用于验证响应的 API，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.web.servlet.client.RestTestClient;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureRestTestClient
class MyRandomPortRestTestClientTests {

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

}

如果你更倾向于使用 AssertJ，可以从 RestTestClientResponse 中获取专用的断言，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.web.servlet.client.RestTestClient;
import org.springframework.test.web.servlet.client.RestTestClient.ResponseSpec;
import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse;

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

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureRestTestClient
class MyRandomPortRestTestClientAssertJTests {

	@Test
	void exampleTest(@Autowired RestTestClient restClient) {
		ResponseSpec spec = restClient.get().uri("/").exchange();
		RestTestClientResponse response = RestTestClientResponse.from(spec);
		assertThat(response).hasStatusOk().bodyText().isEqualTo("Hello World");
	}

}

如果 classpath 中包含 spring-webflux，你也可以通过在测试类上添加 @AutoConfigureWebTestClient 注解来自动装配一个 WebTestClient。

WebTestClient 提供了类似的 API，如下例所示：

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.webtestclient.autoconfigure.AutoConfigureWebTestClient;
import org.springframework.test.web.reactive.server.WebTestClient;

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

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

}
提示

WebTestClient 也可以与 mock 环境 一起使用，通过在测试类上添加来自 spring-boot-webflux-test 的 @AutoConfigureWebTestClient 注解，从而无需运行服务器。

spring-boot-resttestclient 模块还提供了一个 TestRestTemplate 工具：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.resttestclient.TestRestTemplate;
import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;

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

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

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

}

要使用 TestRestTemplate，还需要依赖 spring-boot-restclient。在添加此依赖时请注意，它会启用 RestClient.Builder 的自动配置。如果你的主代码中使用了 RestClient.Builder，请声明 spring-boot-restclient 依赖，使其位于应用程序的主 classpath 中，而不仅仅是在测试 classpath 中。

自定义 RestTestClient​

要自定义 RestTestClient Bean，请配置一个 RestTestClientBuilderCustomizer Bean。所有此类 Bean 都会使用用于创建 RestTestClient 的 RestTestClient.Builder 进行调用。

自定义 WebTestClient​

要自定义 WebTestClient bean，请配置一个 WebTestClientBuilderCustomizer bean。任何此类 bean 都会使用用于创建 WebTestClient 的 WebTestClient.Builder 进行调用。

使用 JMX​

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

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");
		// ...
	}

}

使用 Observations​

如果你使用 spring-boot-micrometer-tracing-test 中的 @AutoConfigureTracing 或 spring-boot-micrometer-metrics-test 中的 @AutoConfigureMetrics 注解 一个切片测试，它会自动配置一个 ObservationRegistry。

使用 Metrics​

无论你的 classpath 如何，当使用 @SpringBootTest 时，除了基于内存的 meter registries 外，其他都不会被自动配置。

如果你需要在集成测试中将指标导出到不同的后端，请使用 @AutoConfigureMetrics 注解。

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

使用 Tracing​

无论你的 classpath 如何，当使用 @SpringBootTest 时，用于上报数据的 tracing 组件都不会被自动配置。

如果你需要在集成测试中使用这些组件，请使用 @AutoConfigureTracing 注解该测试。

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

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

Mocking 和 Spying Beans​

在运行测试时，有时需要模拟（mock）应用程序上下文中的某些组件。例如，你可能有一个封装了某些远程服务的外观（facade），而该远程服务在开发过程中不可用。当你想要模拟在真实环境中难以触发的故障时，模拟也非常有用。

Spring Framework 提供了 @MockitoBean 注解，可用于在你的 ApplicationContext 中定义一个 Mockito mock。此外，还可以使用 @MockitoSpyBean 来定义一个 Mockito spy。有关这些特性的更多信息，请参阅 Spring Framework 文档。

自动配置的测试​

Spring Boot 的自动配置系统对应用程序运行良好，但有时对于测试来说可能有点过于“重量级”。通常，只加载测试应用程序某个“切片”（slice）所需的配置部分会更有帮助。例如，你可能想测试 Spring MVC 控制器是否正确映射了 URL，而不想在这些测试中涉及数据库调用；或者你可能想测试 JPA 实体，而在运行这些测试时并不关心 Web 层。

与 spring-boot-test-autoconfigure 结合使用时，Spring Boot 的测试模块包含多个注解，可用于自动配置此类“切片”。它们的工作方式类似，均提供一个 @…​Test 注解来加载 ApplicationContext，以及一个或多个 @AutoConfigure…​ 注解，用于自定义自动配置设置。

备注

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

备注

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

提示

也可以将 @AutoConfigure…​ 注解与标准的 @SpringBootTest 注解一起使用。如果你不打算对应用程序进行“切片”测试，但仍希望使用某些自动配置的测试 Bean，可以使用这种组合。

自动配置的 JSON 测试​

为了测试对象的 JSON 序列化和反序列化是否按预期工作，你可以使用来自 spring-boot-test-autoconfigure 模块的 @JsonTest 注解。@JsonTest 会自动配置可用的支持的 JSON 映射器，该映射器可以是以下库之一：

提示

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

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

Spring Boot 提供了基于 AssertJ 的辅助工具，这些工具与 JSONAssert 和 JsonPath 库配合使用，用于验证 JSON 是否符合预期。可以分别使用 JacksonTester、GsonTester、JsonbTester 和 BasicJsonTester 类来处理 Jackson、Gson、Jsonb 和字符串。在使用 @JsonTest 时，测试类中的任何辅助字段都可以通过 @Autowired 进行注入。以下示例展示了一个用于 Jackson 的测试类：

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

}
备注

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

如果你使用基于 Spring Boot 的 AssertJ 辅助方法来断言某个 JSON 路径下的数值，根据该数值的类型，你可能无法使用 isEqualTo。此时，你可以使用 AssertJ 的 satisfies 来断言该值满足给定的条件。例如，以下示例断言实际数值是一个浮点数，其值在 0.15 附近，允许的偏差为 0.01。

@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)));
	}

自动配置的 Spring MVC 测试​

要测试 Spring MVC 控制器是否按预期工作，请使用 spring-boot-webmvc-test 模块中的 @WebMvcTest 注解。@WebMvcTest 会自动配置 Spring MVC 基础设施，并将扫描的 Bean 限制为 @Controller、@ControllerAdvice、@JacksonComponent、@JsonComponent（已弃用）、Converter、GenericConverter、Filter、HandlerInterceptor、WebMvcConfigurer、WebMvcRegistrations 和 HandlerMethodArgumentResolver。当使用 @WebMvcTest 注解时，常规的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

提示

如果你需要注册额外的组件，例如 JacksonModule，可以在你的测试类上使用 @Import 导入额外的配置类。

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

@WebMvcTest 还会自动配置 MockMvc。Mock MVC 提供了一种强大而快速的方式，用于测试 MVC 控制器，而无需启动完整的 HTTP 服务器。如果 AssertJ 可用，则由 MockMvcTester 提供的 AssertJ 支持也会被自动配置。如果你想在测试中使用 RestTestClient，请在你的测试类上添加 @AutoConfigureRestTestClient 注解。这样就会自动配置一个使用 Mock MVC 基础设施的 RestTestClient。

提示

你也可以通过使用 @AutoConfigureMockMvc 注解，在非 @WebMvcTest（例如 @SpringBootTest）测试中自动配置 MockMvc 和 MockMvcTester。以下示例使用了 MockMvcTester：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webmvc.test.autoconfigure.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");
	}

}
提示

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

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

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.webmvc.test.autoconfigure.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");
	}

}
备注

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

注意

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

如果你的 classpath 中包含 Spring Security，@WebMvcTest 还会扫描 WebSecurityConfigurer bean。对于这类测试，与其完全禁用安全性，不如使用 Spring Security 的测试支持。有关如何使用 Spring Security 的 MockMvc 支持的更多详细信息，请参阅 Testing With Spring Security “How-to Guides” 部分。

提示

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

自动配置的 Spring WebFlux 测试​

为了测试 Spring WebFlux 控制器是否按预期工作，你可以使用来自 spring-boot-webflux-test 模块的 @WebFluxTest 注解。@WebFluxTest 会自动配置 Spring WebFlux 基础设施，并将扫描的 Bean 限制为 @Controller、@ControllerAdvice、@JacksonComponent、@JsonComponent（已弃用）、Converter、GenericConverter 和 WebFluxConfigurer。当使用 @WebFluxTest 注解时，普通的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

提示

如果你需要注册额外的组件，例如 JacksonModule，可以在你的测试类上使用 @Import 导入额外的配置类。

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

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

提示

你也可以通过使用 @AutoConfigureWebTestClient 注解，在非 @WebFluxTest（例如 @SpringBootTest）的测试中自动配置 WebTestClient。

以下示例展示了一个同时使用 @WebFluxTest 和 WebTestClient 的类：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webflux.test.autoconfigure.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");
	}

}
提示

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

备注

@WebFluxTest 无法检测通过函数式 Web 框架注册的路由。若要在上下文中测试 RouterFunction bean，可考虑使用 @Import 自行导入你的 RouterFunction，或者使用 @SpringBootTest。

备注

@WebFluxTest 无法检测以 @Bean 形式注册的类型为 SecurityWebFilterChain 的自定义安全配置。若要在测试中包含该配置，你需要使用 @Import 导入注册该 Bean 的配置类，或者改用 @SpringBootTest。

提示

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

自动配置的 Spring GraphQL 测试​

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

<dependencies>
	<dependency>
		<groupId>org.springframework.graphql</groupId>
		<artifactId>spring-graphql-test</artifactId>
		<scope>test</scope>
	</dependency>
	<!-- Unless already present in the compile scope -->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-webflux</artifactId>
		<scope>test</scope>
	</dependency>
</dependencies>
dependencies {
	testImplementation("org.springframework.graphql:spring-graphql-test")
	// Unless already present in the implementation configuration
	testImplementation("org.springframework.boot:spring-boot-starter-webflux")
}

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

Spring Boot 通过 spring-boot-graphql-test 模块中的 @GraphQlTest 注解，帮助你测试你的 Spring GraphQL Controllers。@GraphQlTest 会自动配置 Spring GraphQL 基础设施，且不涉及任何传输层或服务器。这将扫描的 Bean 限制为 @Controller、RuntimeWiringConfigurer、JacksonComponent、@JsonComponent（已弃用）、Converter、GenericConverter、DataFetcherExceptionResolver、Instrumentation 和 GraphQlSourceBuilderCustomizer。使用 @GraphQlTest 注解时，普通的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

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

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.graphql.test.autoconfigure.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!");
	}

}

@SpringBootTest 测试是完整的集成测试，涉及整个应用程序。可以通过在测试类上使用 spring-boot-graphql-test 模块中的 @AutoConfigureHttpGraphQlTester 注解来添加一个 HttpGraphQlTester Bean：

import org.junit.jupiter.api.Test;

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

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureHttpGraphQlTester
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!");
	}

}

HttpGraphQlTester Bean 使用集成测试的相关传输方式。当使用随机端口或指定端口时，该测试器会针对真实服务器进行配置。若要将测试器绑定到 MockMvc，请确保在测试类上添加 @AutoConfigureMockMvc 注解。

自动配置的 Data Cassandra 测试​

你可以使用来自 spring-boot-data-cassandra-test 模块的 @DataCassandraTest 来测试 Data Cassandra 应用程序。默认情况下，它会配置一个 CassandraTemplate，扫描 @Table 类，并配置 Spring Data Cassandra 仓库。当使用 @DataCassandraTest 注解时，常规的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 Cassandra 的更多信息，请参阅 Cassandra。）

提示

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

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

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

@DataCassandraTest
class MyDataCassandraTests {

	@Autowired
	private SomeRepository repository;

}

自动配置的 Data Couchbase 测试​

你可以使用来自 spring-boot-data-couchbase-test 模块的 @DataCouchbaseTest 来测试 Data Couchbase 应用程序。默认情况下，它会配置一个 CouchbaseTemplate 或 ReactiveCouchbaseTemplate，扫描 @Document 类，并配置 Spring Data Couchbase 仓库。当使用 @DataCouchbaseTest 注解时，常规的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 Couchbase 的更多信息，请参见本章前面的 Couchbase 部分。）

提示

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

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

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

@DataCouchbaseTest
class MyDataCouchbaseTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

自动配置的 Data Elasticsearch 测试​

你可以使用来自 spring-boot-data-elasticsearch-test 模块的 @DataElasticsearchTest 来测试 Data Elasticsearch 应用程序。默认情况下，它会配置一个 ElasticsearchTemplate，扫描 @Document 类，并配置 Spring Data Elasticsearch 仓库。当使用 @DataElasticsearchTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 Elasticsearch 的更多信息，请参见本章前面的 Elasticsearch 部分。）

提示

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

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

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

@DataElasticsearchTest
class MyDataElasticsearchTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

自动配置的 Data JPA 测试​

你可以使用来自 spring-boot-data-jpa-test 模块的 @DataJpaTest 注解来测试 Data JPA 应用程序。默认情况下，它会扫描 @Entity 类并配置 Spring Data JPA 仓库。如果类路径中存在嵌入式数据库，它也会进行相应配置。默认情况下，通过将 spring.jpa.show-sql 属性设置为 true 来记录 SQL 查询。这可以通过注解的 showSql 属性禁用。

使用 @DataJpaTest 注解时，普通的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

默认情况下，Data JPA 测试是事务性的，并且在每个测试结束时回滚。更多详细信息，请参阅 Spring Framework 参考文档中的相关章节。如果你不希望如此，可以按如下方式为某个测试或整个类禁用事务管理：

import org.springframework.boot.data.jpa.test.autoconfigure.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 注解的用法：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest;
import org.springframework.boot.jpa.test.autoconfigure.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");
	}

}

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

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

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

	// ...

}

自动配置的 JDBC 测试​

来自 spring-boot-jdbc-test 模块的 @JdbcTest 与 @DataJdbcTest 类似，但适用于仅需要 DataSource 且不使用 Spring Data JDBC 的测试。默认情况下，它会配置一个内存嵌入式数据库和一个 JdbcTemplate。当使用 @JdbcTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

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

import org.springframework.boot.jdbc.test.autoconfigure.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 测试​

来自 spring-boot-data-jdbc-test 模块的 @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 测试​

spring-boot-data-r2dbc-test 模块中的 @DataR2dbcTest 与 @DataJdbcTest 类似，但用于测试使用 Spring Data R2DBC 仓库的场景。默认情况下，它会配置一个内存嵌入式数据库、一个 R2dbcEntityTemplate 以及 Spring Data R2DBC 仓库。当使用 @DataR2dbcTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

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

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

自动配置的 jOOQ 测试​

你可以使用来自 spring-boot-jooq-test 的 @JooqTest，其用法类似于 @JdbcTest，但用于 jOOQ 相关的测试。由于 jOOQ 严重依赖于与数据库模式对应的基于 Java 的模式，因此会使用现有的 DataSource。如果你想将其替换为内存数据库，可以使用 @AutoConfigureTestDatabase 来覆盖这些设置。（有关在 Spring Boot 中使用 jOOQ 的更多信息，请参阅 Using jOOQ。）当使用 @JooqTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

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

import org.jooq.DSLContext;

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

@JooqTest
class MyJooqTests {

	@Autowired
	private DSLContext dslContext;

	// ...

}

JOOQ 测试默认是事务性的，并且在每个测试结束时自动回滚。如果你不希望如此，可以为单个测试或整个测试类禁用事务管理，具体方法如 JDBC 示例中所示。

自动配置的 Data MongoDB 测试​

你可以使用来自 spring-boot-data-mongodb-test 模块的 @DataMongoTest 来测试 MongoDB 应用程序。默认情况下，它会配置一个 MongoTemplate，扫描 @Document 类，并配置 Spring Data MongoDB 仓库。当使用 @DataMongoTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 MongoDB 的更多信息，请参阅 MongoDB。）

提示

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

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

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

@DataMongoTest
class MyDataMongoDbTests {

	@Autowired
	private MongoTemplate mongoTemplate;

	// ...

}

自动配置的 Data Neo4j 测试​

你可以使用来自 spring-boot-data-neo4j-test 模块的 @DataNeo4jTest 来测试 Neo4j 应用程序。默认情况下，它会扫描 @Node 类，并配置 Spring Data Neo4j 仓库。当使用 @DataNeo4jTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 Neo4j 的更多信息，请参阅 Neo4j。）

提示

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

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

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

@DataNeo4jTest
class MyDataNeo4jTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

默认情况下，Data Neo4j 测试是事务性的，并在每个测试结束时回滚。更多详细信息，请参阅 Spring Framework 参考文档中的相关章节。如果这不是你想要的行为，你可以按如下方式为某个测试或整个测试类禁用事务管理：

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

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

}
备注

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

自动配置的 Data Redis 测试​

你可以使用来自 spring-boot-data-redis-test 模块的 @DataRedisTest 来测试 Data Redis 应用程序。默认情况下，它会扫描 @RedisHash 类并配置 Spring Data Redis 仓库。当使用 @DataRedisTest 注解时，常规的 @Component 和 @ConfigurationProperties Bean 不会被扫描。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。（有关在 Spring Boot 中使用 Redis 的更多信息，请参阅 Redis。）

提示

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

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

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

@DataRedisTest
class MyDataRedisTests {

	@Autowired
	private SomeRepository repository;

	// ...

}

自动配置的 Data LDAP 测试​

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

提示

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

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

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

@DataLdapTest
class MyDataLdapTests {

	@Autowired
	private LdapTemplate ldapTemplate;

	// ...

}

内存中的嵌入式 LDAP 通常适用于测试，因为它速度快且无需开发者进行任何安装。然而，如果你更倾向于针对真实的 LDAP 服务器运行测试，则应排除嵌入式 LDAP 的自动配置，如下例所示：

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

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

	// ...

}

自动配置的 REST 客户端​

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

提示

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

应使用 @RestClientTest 注解的 value 或 components 属性来指定你想要测试的具体 bean。

在测试中的 Bean 里使用 RestTemplateBuilder，并且在构建 RestTemplate 时调用了 RestTemplateBuilder.rootUri(String rootUri)，那么在 MockRestServiceServer 的期望中应省略根 URI，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.restclient.test.autoconfigure.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");
	}

}

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.restclient.test.autoconfigure.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");
	}

}

自动配置的 Web 客户端​

你可以使用来自 spring-boot-webclient-test 模块的 @WebClientTest 注解来测试使用 WebClient 的代码。默认情况下，它会自动配置 Jackson、GSON 和 Jsonb 支持，并配置一个 WebClient.Builder。当使用 @WebClientTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties Bean。可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。

提示

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

应使用 @WebClientTest 注解的 value 或 components 属性来指定你想要测试的具体 bean。

自动配置的 Spring REST Docs 测试​

你可以使用 spring-boot-restdocs 模块中的 @AutoConfigureRestDocs 注解，在你的测试中结合 Mock MVC 或 WebTestClient 使用 Spring REST Docs。它消除了在 Spring REST Docs 中使用 JUnit 扩展的必要性。

@AutoConfigureRestDocs 可用于覆盖默认的输出目录（如果使用 Maven，则为 target/generated-snippets；如果使用 Gradle，则为 build/generated-snippets）。它还可用于配置出现在任何已记录 URI 中的主机、协议（scheme）和端口。

使用 Mock MVC 的自动配置 Spring REST Docs 测试​

@AutoConfigureRestDocs 在测试基于 Servlet 的 Web 应用程序时，会自定义 MockMvc Bean 以使用 Spring REST Docs。你可以通过 @Autowired 注入它，并像平常使用 MockMvc 和 Spring REST Docs 一样在测试中使用它，如下例所示：

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs;
import org.springframework.boot.webmvc.test.autoconfigure.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.restdocs.test.autoconfigure.AutoConfigureRestDocs;
import org.springframework.boot.webmvc.test.autoconfigure.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 实例，因此对其所做的任何配置都会同时应用于两者。

如果你需要对 Spring REST Docs 的配置进行比 @AutoConfigureRestDocs 注解属性所提供的更精细的控制，可以使用 RestDocsMockMvcConfigurationCustomizer Bean，如下例所示：

import org.springframework.boot.restdocs.test.autoconfigure.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());
	}

}

如果你想使用 Spring REST Docs 对参数化输出目录的支持，可以创建一个 RestDocumentationResultHandler Bean。自动配置会使用该结果处理器调用 alwaysDo，从而使得每次 MockMvc 调用都会自动生成默认的代码片段。以下示例展示了如何定义一个 RestDocumentationResultHandler：

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

}

使用 WebTestClient 自动配置的 Spring REST Docs 测试​

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs;
import org.springframework.boot.webflux.test.autoconfigure.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"));
	}

}

如果你需要比 @AutoConfigureRestDocs 注解属性所提供的更精细的 Spring REST Docs 配置控制，可以使用 RestDocsWebTestClientConfigurationCustomizer Bean，如下例所示：

import org.springframework.boot.restdocs.test.autoconfigure.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");
	}

}

如果你想使用 Spring REST Docs 对参数化输出目录的支持，可以使用 WebTestClientBuilderCustomizer 为每个实体交换结果配置一个消费者。以下示例展示了如何定义这样一个 WebTestClientBuilderCustomizer：

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.webtestclient.autoconfigure.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}"));
	}

}

自动配置的 Spring Web Services 测试​

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

你可以使用来自 spring-boot-webservices-test 模块的 @WebServiceClientTest 来测试使用 Spring Web Services 项目调用 Web 服务的应用程序。默认情况下，它会配置一个 MockWebServiceServer Bean，并自动定制你的 WebServiceTemplateBuilder。（有关在 Spring Boot 中使用 Web 服务的更多信息，请参阅 Web Services。）

提示

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

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webservices.test.autoconfigure.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);
	}

}

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

你可以使用 spring-boot-webservices-test 模块中的 @WebServiceServerTest 来测试使用 Spring Web Services 项目实现 Web 服务的应用程序。默认情况下，它会配置一个 MockWebServiceClient bean，用于调用你的 Web 服务端点。（有关在 Spring Boot 中使用 Web 服务的更多信息，请参阅 Web Services。）

提示

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

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

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webservices.test.autoconfigure.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>")));
	}

}

附加的自动配置与切片​

每个切片提供一个或多个 @AutoConfigure…​ 注解，明确指定应作为切片一部分包含的自动配置。可以通过创建自定义的 @AutoConfigure…​ 注解，或在测试中添加 @ImportAutoConfiguration，按需为每个测试添加额外的自动配置，如下例所示：

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

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

}
备注

确保不要使用常规的 @Import 注解来导入自动配置类，因为 Spring Boot 会以特定的方式处理它们。

或者，可以通过在 META-INF/spring 中存储的文件里注册额外的自动配置，为任何使用切片注解（slice annotation）的场景添加额外的自动配置，如下例所示：

com.example.IntegrationAutoConfiguration

在此示例中，每个使用 @JdbcTest 注解的测试都会启用 com.example.IntegrationAutoConfiguration。

提示

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

提示

只要一个切片（slice）或 @AutoConfigure…​ 注解被使用 @ImportAutoConfiguration 进行元注解（meta-annotated），就可以通过这种方式进行自定义。

用户配置与切片​

如果你以合理的方式组织你的代码，你的 @SpringBootApplication 类会默认用作测试的配置。

此时，避免在应用程序的主类中混杂特定于其某项功能的配置设置就变得很重要了。

假设你正在使用 Spring Data MongoDB，依赖其自动配置，并且已启用审计功能。你可以将你的 @SpringBootApplication 定义如下：

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

@SpringBootApplication
@EnableMongoAuditing
public class MyApplication {

	// ...

}

由于该类是测试的源配置，任何切片测试实际上都会尝试启用 Mongo 审计，这显然不是你想要的行为。推荐的做法是将该特定领域的配置移到一个独立的 @Configuration 类中，并将其与你的应用程序放在同一层级，如下例所示：

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

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

	// ...

}
备注

根据应用程序的复杂性，你可以为自定义配置使用单个 @Configuration 类，也可以为每个领域区域分别使用一个类。后一种方法允许你在必要时通过 @Import 注解在某个测试中启用特定的配置类。有关何时需要为切片测试（slice tests）启用特定 @Configuration 类的更多详细信息，请参阅 此操作指南章节。

测试切片（Test slices）会从扫描中排除 @Configuration 类。例如，对于一个 @WebMvcTest，以下配置不会将给定的 WebMvcConfigurer Bean 包含在测试切片所加载的应用上下文中：

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() {
			// ...
		};
	}

}

然而，下面的配置将导致自定义的 WebMvcConfigurer 被测试切片加载。

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

@Component
public class MyWebMvcConfigurer implements WebMvcConfigurer {

	// ...

}

另一个容易引起混淆的地方是类路径扫描（classpath scanning）。假设你已经以合理的方式组织了代码，但仍需要扫描一个额外的包。你的应用程序可能类似于以下代码：

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

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

	// ...

}

这样做实际上会覆盖默认的组件扫描指令，并带来一个副作用：无论你选择了哪个切片（slice），都会扫描这两个包。例如，一个 @DataJpaTest 似乎会突然开始扫描你应用程序中的组件和用户配置。同样，将自定义的扫描指令移到一个单独的类中是解决此问题的好方法。

提示

如果这对你来说不可行，你可以在测试类的某个层级中创建一个 @SpringBootConfiguration，以替代默认行为。或者，你也可以为测试指定一个配置源，这样会禁用自动查找默认配置的行为。