测试 Spring Boot 应用程序

Spring Boot 应用程序是一个 Spring ApplicationContext，因此除了您通常使用普通 Spring 上下文所做的事情之外，无需做任何特殊的事情来测试它。

外部属性、日志记录和 Spring Boot 的其他功能默认情况下仅在使用 SpringApplication 创建上下文时才安装到上下文中。

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

如果您正在使用 JUnit 4，请不要忘记在测试中添加 @RunWith(SpringRunner.class)，否则注解将被忽略。如果您正在使用 JUnit 6，则无需添加等效的 @ExtendWith(SpringExtension.class)，因为 @SpringBootTest 和其他 @…​Test 注解已经用它进行了注解。

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

如果您的测试是 @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 测试框架，您可能习惯于使用 @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…​) 之外，什么都不做。然而，可以有一个更复杂的 main 方法，在调用 SpringApplication.run(Class, String…​) 之前应用自定义。

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

  • 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。如果主方法设置了额外的配置文件，那么在 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 端点。以下集成可用

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

  • Java

  • Kotlin

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 webClient) {
		webClient
				.get().uri("/")
				.exchange()
				.expectStatus().isOk()
				.expectBody(String.class).isEqualTo("Hello World");
	}

	@Test // If you prefer AssertJ, dedicated assertions are available
	void testWithRestTestClientAssertJ(@Autowired RestTestClient webClient) {
		ResponseSpec spec = webClient.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");
	}

}
import org.assertj.core.api.Assertions.assertThat
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.reactive.server.expectBody
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.assertj.RestTestClientResponse
import org.springframework.test.web.servlet.client.expectBody
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status

@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestTestClient
@AutoConfigureWebTestClient
class MyMockMvcTests {

	@Test
	fun testWithMockMvc(@Autowired mvc: MockMvc) {
		mvc.perform(get("/"))
			.andExpect(status().isOk())
			.andExpect(content().string("Hello World"))
	}

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

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

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


	@Test // If Spring WebFlux is on the classpath
	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.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");
	}

}
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
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 调用的测试可以通过使用 @AutoConfigureRestTestClient 注解测试类来自动装配 RestTestClient。

配置的客户端将相对链接解析到正在运行的服务器，并附带一个专用 API 用于验证响应，如以下示例所示

  • Java

  • Kotlin

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 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.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.expectBody

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

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

}

如果您更喜欢使用 AssertJ，则可以从 RestTestClientResponse 获得专用断言，如以下示例所示

  • Java

  • Kotlin

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 webClient) {
		ResponseSpec spec = webClient.get().uri("/").exchange();
		RestTestClientResponse response = RestTestClientResponse.from(spec);
		assertThat(response).hasStatusOk().bodyText().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.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.assertj.RestTestClientResponse

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

	@Test
	fun exampleTest(@Autowired webClient: RestTestClient) {
		val exchange = webClient.get().uri("/").exchange()
		val response = RestTestClientResponse.from(exchange)
		assertThat(response).hasStatusOk()
			.bodyText().isEqualTo("Hello World")
	}

}

如果您的类路径上有 spring-webflux，您还可以通过使用 @AutoConfigureWebTestClient 注解测试类来自动装配 WebTestClient。

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

}
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
import org.springframework.test.web.reactive.server.expectBody

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

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

}
WebTestClient 也可以与 模拟环境 一起使用，通过使用 spring-boot-webflux-test 中的 @AutoConfigureWebTestClient 注解您的测试类，从而无需运行服务器。

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

  • Java

  • Kotlin

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

}
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.resttestclient.TestRestTemplate
import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate

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

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

}

自定义 RestTestClient

要自定义 RestTestClient bean，请配置一个 RestTestClientBuilderCustomizer bean。任何此类 bean 都将使用用于创建 RestTestClient 的 RestTestClient.Builder 调用。

自定义 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")
		// ...
	}

}

使用观察

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

使用指标

无论您的类路径如何，使用 @SpringBootTest 时，除了内存支持的计量器注册表外，其他计量器注册表都不会自动配置。

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

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

使用追踪

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

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

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

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

模拟和侦察 Bean

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

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

自动配置的测试

Spring Boot 的自动配置系统非常适用于应用程序，但有时对于测试来说可能有点太多了。通常，只加载测试应用程序“切片”所需的配置部分会很有帮助。例如，您可能希望测试 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 和 String。在使用 @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 控制器是否按预期工作，请使用 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 支持也会自动配置。

您还可以在非 @WebMvcTest（例如 @SpringBootTest）中通过使用 @AutoConfigureMockMvc 注解来自动配置 MockMvc 和 MockMvcTester。以下示例使用 MockMvcTester

  • Java

  • Kotlin

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

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

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

}
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.webmvc.test.autoconfigure.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 放入特殊的“作用域”中，以确保驱动程序在每个测试后退出并注入新实例。如果您不希望这种行为，您可以将 @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON) 添加到您的 WebDriver @Bean 定义中。
Spring Boot 创建的 webDriver 作用域将替换任何用户定义的同名作用域。如果您定义了自己的 webDriver 作用域，您可能会发现在使用 @WebMvcTest 时它会停止工作。

如果您的类路径上有 Spring Security，@WebMvcTest 也会扫描 WebSecurityConfigurer bean。与其完全禁用此类测试的安全性，不如使用 Spring Security 的测试支持。有关如何使用 Spring Security 的 MockMvc 支持的更多详细信息，请参阅本 使用 Spring Security 进行测试“操作指南”部分。

有时编写 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，它提供了一种强大的方式来快速测试 WebFlux 控制器，而无需启动完整的 HTTP 服务器。

您还可以在非 @WebFluxTest（例如 @SpringBootTest）中通过使用 @AutoConfigureWebTestClient 注解来自动配置 WebTestClient。

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

  • Java

  • Kotlin

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

}
import org.junit.jupiter.api.Test
import org.mockito.BDDMockito.given
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 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>
	<!-- Unless already present in the 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")
	// 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 控制器。@GraphQlTest 自动配置 Spring GraphQL 基础设施，不涉及任何传输或服务器。这会将扫描的 bean 限制为 @Controller、RuntimeWiringConfigurer、JacksonComponent、@JsonComponent（已弃用）、Converter、GenericConverter、DataFetcherExceptionResolver、Instrumentation 和 GraphQlSourceBuilderCustomizer。当使用 @GraphQlTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties bean。@EnableConfigurationProperties 可用于包含 @ConfigurationProperties bean。

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

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

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

}
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)
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 测试是完整的集成测试，涉及整个应用程序。可以通过使用 spring-boot-graphql-test 模块中的 @AutoConfigureHttpGraphQlTester 注解您的测试类来添加 HttpGraphQlTester bean

  • Java

  • Kotlin

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

}
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
import org.springframework.http.HttpHeaders
import org.springframework.test.web.reactive.server.WebTestClient

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

HttpGraphQlTester bean 使用集成测试的相关传输。当使用随机或定义端口时，测试器会针对实时服务器进行配置。要将测试器绑定到 MockMvc，请确保使用 @AutoConfigureMockMvc 注解您的测试类。

自动配置的数据 Cassandra 测试

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

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

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

  • Java

  • Kotlin

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

@DataCassandraTest
class MyDataCassandraTests {

	@Autowired
	private SomeRepository repository;

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

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

自动配置的数据 Couchbase 测试

您可以使用 spring-boot-data-couchbase-test 模块中的 @DataCouchbaseTest 来测试 Data Couchbase 应用程序。默认情况下，它配置一个 CouchbaseTemplate 或 ReactiveCouchbaseTemplate，扫描 @Document 类，并配置 Spring Data Couchbase 存储库。当使用 @DataCouchbaseTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties bean。@EnableConfigurationProperties 可用于包含 @ConfigurationProperties bean。（有关将 Couchbase 与 Spring Boot 一起使用的更多信息，请参阅本章前面提到的 Couchbase。）

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

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

  • Java

  • Kotlin

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

@DataCouchbaseTest
class MyDataCouchbaseTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的数据 Elasticsearch 测试

您可以使用 spring-boot-data-elasticsearch-test 模块中的 @DataElasticsearchTest 来测试数据 Elasticsearch 应用程序。默认情况下，它配置一个 ElasticsearchTemplate，扫描 @Document 类，并配置 Spring Data Elasticsearch 存储库。当使用 @DataElasticsearchTest 注解时，不会扫描常规的 @Component 和 @ConfigurationProperties bean。@EnableConfigurationProperties 可用于包含 @ConfigurationProperties bean。（有关将 Elasticsearch 与 Spring Boot 一起使用的更多信息，请参阅本章前面提到的 Elasticsearch。）

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

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

  • Java

  • Kotlin

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

@DataElasticsearchTest
class MyDataElasticsearchTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的数据 JPA 测试

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

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

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

默认情况下，数据 JPA 测试是事务性的，并在每个测试结束时回滚。有关更多详细信息，请参阅 Spring Framework 参考文档中的 相关部分。如果您不希望这样，可以按如下方式禁用测试或整个类的事务管理

  • Java

  • Kotlin

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 {

	// ...

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

	// ...

}

数据 JPA 测试还可以注入一个 TestEntityManager bean，它提供了标准 JPA EntityManager 的替代方案，专门用于测试。

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

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

  • Java

  • Kotlin

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

}
import org.assertj.core.api.Assertions.assertThat
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

@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.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 {

	// ...

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

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.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 参考文档中的 相关部分。如果您不希望这样，可以按如下方式禁用测试或整个类的事务管理

  • Java

  • Kotlin

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 {

}
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

如果您更喜欢针对真实数据库运行测试，可以使用 @AutoConfigureTestDatabase 注解，其方式与 @DataJpaTest 相同。（请参阅 自动配置的数据 JPA 测试。）

自动配置的数据 JDBC 测试

spring-boot-data-jdbc-test 模块中的 @DataJdbcTest 类似于 @JdbcTest，但适用于使用 Spring Data JDBC 存储库的测试。默认情况下，它配置一个内存嵌入式数据库、一个 JdbcTemplate 和 Spring Data JDBC 存储库。当使用 @DataJdbcTest 注解时，仅扫描 AbstractJdbcConfiguration 子类，不扫描常规的 @Component 和 @ConfigurationProperties bean。@EnableConfigurationProperties 可用于包含 @ConfigurationProperties bean。

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

默认情况下，数据 JDBC 测试是事务性的，并在每个测试结束时回滚。有关更多详细信息，请参阅 Spring Framework 参考文档中的 相关部分。如果您不希望这样，可以像 JDBC 示例中所示 禁用测试或整个测试类的事务管理。

如果您更喜欢针对真实数据库运行测试，可以使用 @AutoConfigureTestDatabase 注解，其方式与 @DataJpaTest 相同。（请参阅 自动配置的数据 JPA 测试。）

自动配置的数据 R2DBC 测试

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

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

默认情况下，数据 R2DBC 测试不具有事务性。

如果您更喜欢针对真实数据库运行测试，可以使用 @AutoConfigureTestDatabase 注解，其方式与 @DataJpaTest 相同。（请参阅 自动配置的数据 JPA 测试。）

自动配置的 jOOQ 测试

您可以以类似于 @JdbcTest 的方式使用 spring-boot-jooq-test 中的 @JooqTest，但适用于 jOOQ 相关测试。由于 jOOQ 严重依赖于与数据库模式对应的基于 Java 的模式，因此使用了现有的 DataSource。如果您想用内存数据库替换它，可以使用 @AutoConfigureTestDatabase 覆盖这些设置。（有关将 jOOQ 与 Spring Boot 一起使用的更多信息，请参阅 使用 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.jooq.test.autoconfigure.JooqTest;

@JooqTest
class MyJooqTests {

	@Autowired
	private DSLContext dslContext;

	// ...

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

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

	// ...

}

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

自动配置的数据 MongoDB 测试

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

有关 @DataMongoTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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;

	// ...

}
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 val mongoTemplate: MongoTemplate) {

	// ...

}

自动配置的 Data Neo4j 测试

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

有关 @DataNeo4jTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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

@DataNeo4jTest
class MyDataNeo4jTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

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

  • Java

  • Kotlin

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 {

}
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。（有关将 Redis 与 Spring Boot 结合使用的更多信息，请参阅Redis。）

有关 @DataRedisTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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

@DataRedisTest
class MyDataRedisTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的 Data LDAP 测试

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

有关 @DataLdapTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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;

	// ...

}
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 val ldapTemplate: LdapTemplate) {

	// ...

}

内存中的嵌入式 LDAP 通常非常适合测试，因为它速度快且不需要任何开发人员安装。但是，如果你更喜欢针对真实的 LDAP 服务器运行测试，则应排除嵌入式 LDAP 自动配置，如以下示例所示

  • Java

  • Kotlin

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

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

	// ...

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

@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 启用的自动配置设置列表，请参见附录。

要测试的特定 bean 应通过使用 @RestClientTest 的 value 或 components 属性来指定。

当在被测试的 bean 中使用 RestTemplateBuilder 并且在构建 RestTemplate 时调用了 RestTemplateBuilder.rootUri(String rootUri) 时，根 URI 应从 MockRestServiceServer 预期中省略，如以下示例所示

  • Java

  • Kotlin

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

}
import org.assertj.core.api.Assertions.assertThat
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 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.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");
	}

}
import org.assertj.core.api.Assertions.assertThat
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 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")
	}

}

自动配置的 Web 客户端

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

有关 @WebClientTest 启用的自动配置设置列表，请参见附录。

要测试的特定 bean 应通过使用 @WebClientTest 的 value 或 components 属性来指定。

自动配置的 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 中出现的主机、方案和端口。

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

在测试基于 Servlet 的 Web 应用程序时，@AutoConfigureRestDocs 会定制 MockMvc bean 以使用 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.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 实例，因此对其进行的任何配置都适用于两者。

如果你需要比 @AutoConfigureRestDocs 的属性提供的更多控制来配置 Spring REST Docs，你可以使用 RestDocsMockMvcConfigurationCustomizer bean，如以下示例所示

  • Java

  • Kotlin

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

}
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)
class MyRestDocsConfiguration : RestDocsMockMvcConfigurationCustomizer {

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

}

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

  • 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 测试

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

  • Java

  • Kotlin

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

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

}
import org.springframework.boot.restdocs.test.autoconfigure.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 为每个实体交换结果配置一个消费者。以下示例展示了这样定义的 WebTestClientBuilderCustomizer

  • Java

  • Kotlin

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

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

}

自动配置的 Spring Web Services 测试

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

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

有关 @WebServiceClientTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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

}
import org.assertj.core.api.Assertions.assertThat
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.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 服务器测试

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

有关 @WebServiceServerTest 启用的自动配置设置列表，请参见附录。

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

  • Java

  • Kotlin

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

}
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 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.integration.autoconfigure.IntegrationAutoConfiguration;
import org.springframework.boot.jdbc.test.autoconfigure.JdbcTest;

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

}
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 中存储的文件中注册它们，为任何切片注解的使用添加附加自动配置，如以下示例所示

META-INF/spring/org.springframework.boot.jdbc.test.autoconfigure.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 类的更多详细信息，请参阅此操作方法部分。

测试切片将 @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，以便它被使用。或者，你可以为你的测试指定一个源，这会禁用查找默认源的行为。
© . This site is unofficial and not affiliated with VMware.