如需获取最新稳定版本,请使用 Spring Boot 4.0.4spring-doc.cadn.net.cn

测试 Spring Boot 应用程序

Spring Boot 应用程序是一个 Spring ApplicationContext,因此除了对普通 Spring 上下文通常所做的操作之外,无需执行任何特别的操作来对其进行测试。spring-doc.cadn.net.cn

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

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

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

默认情况下,@SpringBootTest 不会启动服务器。 您可以使用 @SpringBootTestwebEnvironment 属性来进一步细化测试的运行方式:spring-doc.cadn.net.cn

如果您的测试是 @Transactional,默认情况下,它会在每个测试方法结束时回滚事务。 然而,由于使用这种安排与 RANDOM_PORTDEFINED_PORT 隐式提供了真实的 Servlet 环境,HTTP 客户端和服务器运行在单独的线程中,因此也运行在单独的事务中。 在这种情况下,服务器上发起的任何事务都不会回滚。
@SpringBootTestwebEnvironment = WebEnvironment.RANDOM_PORT 结合使用,如果您的应用程序为管理服务器使用不同的端口,还将在一个单独的随机端口上启动管理服务器。

检测 Web 应用程序类型

如果Spring MVC可用,将配置一个基于常规MVC的应用程序上下文。 如果仅使用Spring WebFlux,我们将检测到这一点并改为配置基于WebFlux的应用程序上下文。spring-doc.cadn.net.cn

如果两者都存在,Spring MVC 优先。 如果您想在此场景中测试响应式 Web 应用程序,则必须设置 spring.main.web-application-type 属性:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

在测试 Spring Boot 应用程序时,通常不需要这样做。 Spring Boot 的 @*Test 注解会在您未显式定义主配置时自动搜索它。spring-doc.cadn.net.cn

搜索算法从包含测试的包开始向上查找,直到找到带有 @SpringBootApplication@SpringBootConfiguration 注解的类。 只要您以合理的方式组织代码结构,通常就能找到主配置。spring-doc.cadn.net.cn

如果您使用一个 测试注解来测试应用程序的更具体部分,您应该避免在 主方法的应用程序类 上添加特定于某个区域的配置设置。spring-doc.cadn.net.cn

@SpringBootApplication 的底层组件扫描配置定义了排除过滤器,这些过滤器用于确保切片按预期工作。 如果在使用 @ComponentScan 指令的 @SpringBootApplication 注解类上显式使用,需要注意这些过滤器将被禁用。 如果您正在使用切片,请重新定义它们。spring-doc.cadn.net.cn

如果您想自定义主配置,可以使用嵌套的 @TestConfiguration 类。 与嵌套的 @Configuration 类(它将替代应用程序的主配置)不同,嵌套的 @TestConfiguration 类会与应用程序的主配置一起使用。spring-doc.cadn.net.cn

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

使用测试配置主方法

通常,由 @SpringBootTest 发现的测试配置将是您的主 @SpringBootApplication。 在大多数结构良好的应用程序中,此配置类还将包含用于启动应用程序的 main 方法。spring-doc.cadn.net.cn

例如,以下是一个典型的 Spring Boot 应用程序中非常常见的代码模式:spring-doc.cadn.net.cn

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...) 之前应用自定义配置。spring-doc.cadn.net.cn

例如,以下是一个更改横幅模式并设置额外配置文件的应用程序:spring-doc.cadn.net.cn

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 方法,而是直接使用该类本身来创建 ApplicationContextspring-doc.cadn.net.cn

如果您想更改此行为,可以将 useMainMethod 属性改为 @SpringBootTestSpringBootTest.UseMainMethod.ALWAYSSpringBootTest.UseMainMethod.WHEN_AVAILABLE。 当设置为 ALWAYS 时,如果没有找到 main 方法,测试将会失败。 当设置为 WHEN_AVAILABLE 时,如果可用,将使用 main 方法,否则将使用标准的加载机制。spring-doc.cadn.net.cn

例如,以下测试将调用 mainMyApplication 方法以创建 ApplicationContext。 如果主方法设置了其他配置文件,则当 ApplicationContext 启动时这些配置文件将处于活动状态。spring-doc.cadn.net.cn

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),您可能会发现仅为特定测试创建的顶级配置类被意外地到处加载。spring-doc.cadn.net.cn

正如我们之前看到的@TestConfiguration可以用于测试的内部类中,以自定义主配置。 @TestConfiguration也可以用于顶层类。这样做表示该类不应被扫描选中。 然后你可以在需要的地方显式导入该类,如下例所示:spring-doc.cadn.net.cn

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 注入它们。spring-doc.cadn.net.cn

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-doc.cadn.net.cn

使用 Spring MVC,我们可以使用 MockMvc 查询我们的 Web 端点。 提供三种集成方式:spring-doc.cadn.net.cn

以下示例展示了可用的集成:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {

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

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

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

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

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {

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

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

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

}
如果您只想专注于 Web 层,而不想启动一个完整的 ApplicationContext,请考虑改用 使用 @WebMvcTest

使用 Spring WebFlux 端点,您可以使用 WebTestClient,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

@SpringBootTest
@AutoConfigureWebTestClient
class MyMockWebTestClientTests {

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

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

@SpringBootTest
@AutoConfigureWebTestClient
class MyMockWebTestClientTests {

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

}

在模拟环境中进行测试通常比使用完整的servlet容器运行要快。 然而,由于模拟是在Spring MVC层进行的,因此无法直接使用MockMvc测试依赖于底层servlet容器行为的代码。spring-doc.cadn.net.cn

例如,Spring Boot 的错误处理基于 servlet 容器提供的“错误页面”支持。 这意味着,虽然你可以测试你的 MVC 层是否按预期抛出和处理异常,但你无法直接测试特定的 自定义错误页面 是否被渲染。 如果你需要测试这些底层问题,可以按照下一节中的描述启动一个完整的服务器。spring-doc.cadn.net.cn

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

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

@LocalServerPort 注解可用于将实际使用的端口注入到你的测试中。 为了方便起见,需要向已启动的服务器发出 REST 调用的测试还可以自动装配一个 WebTestClient,它会将相对链接解析为正在运行的服务器,并提供专用的 API 来验证响应,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

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

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

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

}
WebTestClient 也可以与模拟环境一起使用,从而无需运行服务器,方法是在测试类上添加@AutoConfigureWebTestClient注解。

此设置需要在类路径上包含 spring-webflux。 如果您不能或不愿添加 webflux,Spring Boot 还提供了一个 TestRestTemplate 功能:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

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

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

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

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

}

自定义 WebTestClient

要自定义 WebTestClient Bean,请配置一个 WebTestClientBuilderCustomizer Bean。 任何此类 Bean 都会使用用于创建 WebTestClientWebTestClient.Builder 调用。spring-doc.cadn.net.cn

使用 JMX

由于测试上下文框架会缓存上下文,因此默认情况下禁用 JMX,以防止相同的组件在同一个域上注册。 如果此类测试需要访问 MBeanServer,请考虑也将其标记为脏数据:spring-doc.cadn.net.cn

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

}

使用 Observations

使用指标

无论您的类路径如何,在使用 @SpringBootTest 时,除了基于内存的注册表外,其他指标注册表都不会自动配置。spring-doc.cadn.net.cn

如果您需要作为集成测试的一部分将指标导出到不同的后端,请使用 @AutoConfigureObservability 对其进行注解。spring-doc.cadn.net.cn

如果你使用 切片测试 注解 @AutoConfigureObservability,它会自动配置一个内存中的 MeterRegistry。 在切片测试中,不支持使用 @AutoConfigureObservability 注解进行数据导出。spring-doc.cadn.net.cn

使用追踪

无论您的类路径如何,在使用 @SpringBootTest 时,报告数据的跟踪组件都不会自动配置。spring-doc.cadn.net.cn

如果您需要将这些组件作为集成测试的一部分,请使用 @AutoConfigureObservability 对测试进行注解。spring-doc.cadn.net.cn

如果您创建了自己的报告组件(例如自定义 SpanExporterbrave.handler.SpanHandler),并且不希望它们在测试中处于活动状态,则可以使用 @ConditionalOnEnabledTracing 注解来禁用它们。spring-doc.cadn.net.cn

如果你用 一个切片测试 加上 @AutoConfigureObservability,它会自动配置一个无操作的 Tracer。 在切片测试中,使用 @AutoConfigureObservability 注解不支持数据导出。spring-doc.cadn.net.cn

模拟和监视 Bean

在运行测试时,有时需要模拟应用程序上下文中的某些组件。 例如,你可能有一个对某些远程服务的外观(facade),在开发期间该服务不可用。 当您想模拟那些在真实环境中难以触发的故障时,模拟 also 可能会很有用。spring-doc.cadn.net.cn

Spring Framework 包含一个 @MockitoBean 注解,可用于在您的 ApplicationContext 中为 Bean 定义 Mockito 模拟对象。 此外,@MockitoSpyBean 可用于定义 Mockito 间谍对象。 在 Spring Framework 文档 中了解更多关于这些功能的信息。spring-doc.cadn.net.cn

自动配置的测试

Spring Boot 的自动配置系统对于应用程序来说工作得很好,但有时在测试中可能会显得过于全面。 通常情况下,只加载用于测试应用程序“片段”的必要配置部分会有所帮助。 例如,您可能希望测试 Spring MVC 控制器是否正确地映射了 URL,并且在这些测试中不希望涉及数据库调用,或者您可能希望测试 JPA 实体,在这些测试运行时并不关心 Web 层。spring-doc.cadn.net.cn

spring-boot-test-autoconfigure 模块包含许多注解,可用于自动配置此类“切片”。 它们的工作方式类似,都提供一个 @…​Test 注解来加载 ApplicationContext,并提供一个或多个 @AutoConfigure…​ 注解,用于自定义自动配置设置。spring-doc.cadn.net.cn

每个切片将组件扫描限制为适当的组件,并加载非常有限的自动配置类集合。 如果你需要排除其中一个,大多数 @…​Test 注解都提供了一个 excludeAutoConfiguration 属性。 或者,你可以使用 @ImportAutoConfiguration#exclude
不支持在一个测试中使用多个 @…​Test 注解来包含多个“切片”。 如果需要多个“切片”,请选择其中一个 @…​Test 注解,并手动包含其他“切片”的 @AutoConfigure…​ 注解。
也可以将 @AutoConfigure…​ 注解与标准的 @SpringBootTest 注解结合使用。 如果您不希望对应用程序进行“切片”,但希望使用某些自动配置的测试 Bean,则可以使用这种组合。

自动配置的 JSON 测试

要测试对象 JSON 序列化和反序列化是否按预期工作,您可以使用 @JsonTest 注解。 @JsonTest 会自动配置可用的受支持 JSON 映射器,它可以是以下库之一:spring-doc.cadn.net.cn

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

如果您需要配置自动配置的元素,可以使用 @AutoConfigureJsonTesters 注解。spring-doc.cadn.net.cn

Spring Boot 包含了基于 AssertJ 的帮助程序,这些程序与 JSONAssert 和 JsonPath 库一起使用,以检查 JSON 是否按预期显示。 JacksonTesterGsonTesterJsonbTesterBasicJsonTester 类分别可用于 Jackson、Gson、Jsonb 和字符串。 在使用 @JsonTest 时,测试类上的任何帮助程序字段都可以 @Autowired。 以下示例显示了一个 Jackson 的测试类:spring-doc.cadn.net.cn

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帮助类也可以直接在标准单元测试中使用。 要做到这一点,在您的 @BeforeEach 方法中调用帮助器的 initFields 方法,如果您不使用 @JsonTest

如果您使用 Spring Boot 的基于 AssertJ 的帮助程序来断言给定 JSON 路径上的数字值,可能无法根据类型使用 isEqualTo。 相反,您可以使用 AssertJ 的 satisfies 来断言该值与给定条件匹配。 例如,以下示例断言实际数字是在 0.15 的偏移量为 0.01 的范围内接近的浮点数值。spring-doc.cadn.net.cn

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

自动配置的 Spring MVC 测试

要测试 Spring MVC 控制器是否按预期工作,请使用 @WebMvcTest 注解。 @WebMvcTest 会自动配置 Spring MVC 基础设施,并将扫描的 Bean 限制为 @Controller@ControllerAdvice@JsonComponentConverterGenericConverterFilterHandlerInterceptorWebMvcConfigurerWebMvcRegistrationsHandlerMethodArgumentResolver。 使用 @WebMvcTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

@WebMvcTest 启用的自动配置设置列表可在附录中找到
如果您需要注册额外的组件,例如 Jackson Module,您可以通过在测试中使用 @Import 来导入其他配置类。

通常,@WebMvcTest 仅限于单个控制器,并与 @MockitoBean 结合使用,为所需的协作者提供模拟实现。spring-doc.cadn.net.cn

@WebMvcTest 还会自动配置 MockMvc。 Mock MVC 提供了一种强大的方式,无需启动完整的 HTTP 服务器即可快速测试 MVC 控制器。 如果 AssertJ 可用,MockMvcTester 提供的 AssertJ 支持也会被自动配置。spring-doc.cadn.net.cn

您也可以通过使用 MockMvcMockMvcTester 在非 @WebMvcTest(例如 @SpringBootTest)中进行自动配置。 下面的示例使用了 MockMvcTester
import org.junit.jupiter.api.Test;

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

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

@WebMvcTest(UserVehicleController.class)
class MyControllerTests {

	@Autowired
	private MockMvcTester mvc;

	@MockitoBean
	private UserVehicleService userVehicleService;

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

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

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

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

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

}
如果您需要配置自动配置的元素(例如,当应应用 Servlet 过滤器时),您可以在 @AutoConfigureMockMvc 注解中使用属性。

如果您使用 HtmlUnit 和 Selenium,自动配置还会提供一个 HtmlUnit WebClient Bean 和/或一个 Selenium WebDriver Bean。 以下示例使用 HtmlUnit:spring-doc.cadn.net.cn

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

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

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

@WebMvcTest(UserVehicleController.class)
class MyHtmlUnitTests {

	@Autowired
	private WebClient webClient;

	@MockitoBean
	private UserVehicleService userVehicleService;

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

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

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

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

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

}
默认情况下,Spring Boot 将 WebDriver 个 bean 放入一个特殊的“作用域”中,以确保每次测试后驱动程序退出,并且注入一个新的实例。 如果您不希望此行为,可以将 @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON) 添加到您的 WebDriver @Bean 定义中。
Spring Boot 创建的 webDriver 作用域将替换任何同名的用户自定义作用域。 如果您定义了自己的 webDriver 作用域,可能会发现当使用 @WebMvcTest 时,它将停止工作。

如果您的类路径上有 Spring Security,@WebMvcTest 还将扫描 WebSecurityConfigurer Bean。 您无需为此类测试完全禁用安全性,而是可以使用 Spring Security 的测试支持。 有关如何使用 Spring Security 的 MockMvc 支持的更多详细信息,请参见本使用 Spring Security 进行测试“操作指南”部分。spring-doc.cadn.net.cn

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

自动配置的 Spring WebFlux 测试

要测试 Spring WebFlux 控制器是否按预期工作,您可以使用 @WebFluxTest 注解。 @WebFluxTest 会自动配置 Spring WebFlux 基础架构,并将扫描的 Bean 限制为 @Controller@ControllerAdvice@JsonComponentConverterGenericConverterWebFluxConfigurer。 当使用 @WebFluxTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

@WebFluxTest 启用的自动配置列表可在附录中找到
如果您需要注册额外的组件,例如 Jackson Module,您可以在测试中使用 @Import 导入其他配置类。

通常,@WebFluxTest 仅限于单个控制器,并与 @MockitoBean 注解结合使用,为所需的协作者提供模拟实现。spring-doc.cadn.net.cn

@WebFluxTest 还会自动配置 WebTestClient,它提供了一种强大的方法,无需启动完整的 HTTP 服务器即可快速测试 WebFlux 控制器。spring-doc.cadn.net.cn

您也可以通过用 @AutoConfigureWebTestClient 进行注释,在非 @WebFluxTest(例如 @SpringBootTest)中自动配置 WebTestClient。 以下示例显示了一个同时使用 @WebFluxTestWebTestClient 的类:
import org.junit.jupiter.api.Test;

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

import static org.mockito.BDDMockito.given;

@WebFluxTest(UserVehicleController.class)
class MyControllerTests {

	@Autowired
	private WebTestClient webClient;

	@MockitoBean
	private UserVehicleService userVehicleService;

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

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

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

	@MockitoBean
	lateinit var userVehicleService: UserVehicleService

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

}
此设置仅受 WebFlux 应用程序支持,因为在模拟的 Web 应用程序中使用 WebTestClient 目前仅适用于 WebFlux。
@WebFluxTest 无法检测通过函数式 Web 框架注册的路由。 对于测试上下文中的 RouterFunction bean,请考虑通过使用 RouterFunction 自行导入你的 @Import 或者使用 @SpringBootTest
@WebFluxTest 无法检测注册为 @Bean 类型且类型为 SecurityWebFilterChain 的自定义安全配置。 要在测试中包含该配置,您需要使用 @Import 或使用 @SpringBootTest 导入注册该 bean 的配置。
有时编写 Spring WebFlux 测试是不够的;Spring Boot 可以帮助你使用实际服务器运行 完整的端到端测试

自动配置的 Spring GraphQL 测试

Spring GraphQL 提供了一个专用的测试支持模块;您需要将其添加到您的项目中:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

Spring Boot 可帮助您使用 Spring GraphQL 控制器@GraphQlTest 注解来测试。 @GraphQlTest 会自动配置 Spring GraphQL 基础设施,无需任何传输层或服务器参与。 这将扫描的 Bean 限制为 @ControllerRuntimeWiringConfigurerJsonComponentConverterGenericConverterDataFetcherExceptionResolverInstrumentationGraphQlSourceBuilderCustomizer。 当使用 @GraphQlTest 注解时,不会扫描普通的 @Component@ConfigurationProperties Bean。 @EnableConfigurationProperties 可用于包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

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

通常,@GraphQlTest 仅限于一组控制器,并与 @MockitoBean 注解结合使用,为所需的协作者提供模拟实现。spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

@GraphQlTest(GreetingController.class)
class GreetingControllerTests {

	@Autowired
	private GraphQlTester graphQlTester;

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

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

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

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

	@Autowired
	lateinit var graphQlTester: GraphQlTester

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

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

}

@SpringBootTest 个测试是完整的集成测试,涉及整个应用程序。 使用随机端口或指定端口时,会配置一个实时服务器,并自动提供一个 HttpGraphQlTester Bean,以便您可以使用它来测试您的服务器。 当配置了 MOCK 环境时,您还可以通过在测试类上添加 HttpGraphQlTester 注解来请求一个 @AutoConfigureHttpGraphQlTester Bean:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

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

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

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

自动配置的 Data Cassandra 测试

您可以使用 @DataCassandraTest 来测试 Cassandra 应用程序。 默认情况下,它会配置一个 CassandraTemplate,扫描 @Table 类,并配置 Spring Data Cassandra 存储库。 当使用 @DataCassandraTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 Cassandra 的更多信息,请参阅 Cassandra。)spring-doc.cadn.net.cn

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

以下示例展示了在 Spring Boot 中使用 Cassandra 测试的典型配置:spring-doc.cadn.net.cn

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

@DataCassandraTest
class MyDataCassandraTests {

	@Autowired
	private SomeRepository repository;

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

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

自动配置的 Data Couchbase 测试

您可以使用 @DataCouchbaseTest 来测试 Couchbase 应用程序。 默认情况下,它会配置一个 CouchbaseTemplateReactiveCouchbaseTemplate,扫描 @Document 类,并配置 Spring Data Couchbase 存储库。 当使用 @DataCouchbaseTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 Couchbase 的更多信息,请参阅本章前面的 Couchbase 部分。)spring-doc.cadn.net.cn

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

以下示例展示了在 Spring Boot 中使用 Couchbase 测试的典型配置:spring-doc.cadn.net.cn

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

@DataCouchbaseTest
class MyDataCouchbaseTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的数据 Elasticsearch 测试

您可以使用 @DataElasticsearchTest 来测试 Elasticsearch 应用程序。 默认情况下,它会配置一个 ElasticsearchTemplate,扫描 @Document 类,并配置 Spring Data Elasticsearch 存储库。 当使用 @DataElasticsearchTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 Elasticsearch 的更多信息,请参阅本章前面的 Elasticsearch。)spring-doc.cadn.net.cn

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

以下示例展示了在 Spring Boot 中使用 Elasticsearch 测试的典型配置:spring-doc.cadn.net.cn

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

@DataElasticsearchTest
class MyDataElasticsearchTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的 Data JPA 测试

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

常规 @Component@ConfigurationProperties 作用域的 Bean 在使用 @DataJpaTest 注解时不会被扫描。 @EnableConfigurationProperties 可以用来包含 @ConfigurationProperties 作用域的 Bean。spring-doc.cadn.net.cn

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

默认情况下,数据 JPA 测试是事务性的,并在每个测试结束时回滚。 有关更多详细信息,请参阅 相关部分 中的 Spring Framework 参考文档。 如果这不是您想要的,可以按以下方式为测试或整个类禁用事务管理:spring-doc.cadn.net.cn

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

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

	// ...

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

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

	// ...

}

Data JPA 测试还可以注入一个 TestEntityManager Bean,它提供了一种替代标准 JPA EntityManager 的方案,专为测试而设计。spring-doc.cadn.net.cn

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

如果您需要,也可以使用 JdbcTemplate。 以下示例展示了 @DataJpaTest 注解的使用:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

@DataJpaTest
class MyRepositoryTests {

	@Autowired
	private TestEntityManager entityManager;

	@Autowired
	private UserRepository repository;

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

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

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

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

}

内存嵌入式数据库通常非常适合测试,因为它们速度快且无需任何安装。 但是,如果您更喜欢针对真实数据库运行测试,则可以使用 @AutoConfigureTestDatabase 注解,如下例所示:spring-doc.cadn.net.cn

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

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

	// ...

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

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

	// ...

}

自动配置的 JDBC 测试

@JdbcTest 类似于 @DataJpaTest,但适用于仅需要 DataSource 且不使用 Spring Data JDBC 的测试。 默认情况下,它会配置一个内存中的嵌入式数据库和一个 JdbcTemplate。 当使用 @JdbcTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

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

默认情况下,JDBC 测试是事务性的,并在每个测试结束时回滚。 有关更多详细信息,请参阅 相关部分 中的 Spring Framework 参考文档。 如果这不是您想要的,可以禁用测试或整个类的事务管理,如下所示:spring-doc.cadn.net.cn

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

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

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

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

如果您希望测试针对真实数据库运行,可以像使用 @AutoConfigureTestDatabase 注解一样使用它来对 @DataJpaTest 进行操作。 (参见 自动配置的数据 JPA 测试。)spring-doc.cadn.net.cn

自动配置的数据 JDBC 测试

@DataJdbcTest 类似于 @JdbcTest,但适用于使用 Spring Data JDBC 存储库的测试。 默认情况下,它会配置一个内存嵌入式数据库、一个 JdbcTemplate 以及 Spring Data JDBC 存储库。 当使用 @DataJdbcTest 注解时,仅扫描 AbstractJdbcConfiguration 子类,不扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

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

默认情况下,Data JDBC 测试是事务性的,并在每个测试结束时回滚。 有关更多详细信息,请参阅 Spring Framework 参考文档中的 相关部分。 如果这不是您想要的,您可以为一个测试或整个测试类禁用事务管理,如 JDBC 示例中所示spring-doc.cadn.net.cn

如果您希望测试针对真实数据库运行,可以像使用 @AutoConfigureTestDatabase 注解一样使用它来对 @DataJpaTest 进行操作。 (参见 自动配置的数据 JPA 测试。)spring-doc.cadn.net.cn

自动配置的 Data R2DBC 测试

@DataR2dbcTest 类似于 @DataJdbcTest,但适用于使用 Spring Data R2DBC 存储库的测试。 默认情况下,它会配置一个内存嵌入式数据库、一个 R2dbcEntityTemplate 以及 Spring Data R2DBC 存储库。 当使用 @DataR2dbcTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。spring-doc.cadn.net.cn

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

默认情况下,Data R2DBC 测试不是事务性的。spring-doc.cadn.net.cn

如果您希望测试针对真实数据库运行,可以像使用 @AutoConfigureTestDatabase 注解一样使用它来对 @DataJpaTest 进行操作。 (参见 自动配置的数据 JPA 测试。)spring-doc.cadn.net.cn

自动配置的 jOOQ 测试

您可以像使用 @JooqTest 一样使用它,但用于 jOOQ 相关的测试。 由于 jOOQ 高度依赖于与数据库模式相对应的 Java 模式,因此使用现有的 DataSource。 如果您想用内存数据库替换它,可以使用 @AutoConfigureTestDatabase 来覆盖这些设置。 (有关使用 jOOQ 与 Spring Boot 的更多信息,请参见 使用 jOOQ。) 当使用 @JooqTest 注解时,常规的 @Component@ConfigurationProperties bean 不会被扫描。 @EnableConfigurationProperties 可用于包含 @ConfigurationProperties bean。spring-doc.cadn.net.cn

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

@JooqTest 配置一个 DSLContext。 以下示例展示了 @JooqTest 注解的使用:spring-doc.cadn.net.cn

import org.jooq.DSLContext;

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

@JooqTest
class MyJooqTests {

	@Autowired
	private DSLContext dslContext;

	// ...

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

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

	// ...

}

JOOQ 测试默认在每个测试结束时进行事务回滚。 如果这不是您所希望的,您可以为某个测试或整个测试类禁用事务管理,如JDBC 示例中所示spring-doc.cadn.net.cn

自动配置的数据 MongoDB 测试

您可以使用 @DataMongoTest 来测试 MongoDB 应用程序。 默认情况下,它会配置一个 MongoTemplate,扫描 @Document 类,并配置 Spring Data MongoDB 存储库。 当使用 @DataMongoTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 MongoDB 的更多信息,请参阅 MongoDB。)spring-doc.cadn.net.cn

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

以下类展示了 @DataMongoTest 注解的使用:spring-doc.cadn.net.cn

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

@DataMongoTest
class MyDataMongoDbTests {

	@Autowired
	private MongoTemplate mongoTemplate;

	// ...

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

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

	// ...

}

自动配置的 Data Neo4j 测试

您可以使用 @DataNeo4jTest 来测试 Neo4j 应用程序。 默认情况下,它会扫描 @Node 类,并配置 Spring Data Neo4j 存储库。 当使用 @DataNeo4jTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 Neo4J 的更多信息,请参阅 Neo4j。)spring-doc.cadn.net.cn

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

以下示例展示了在 Spring Boot 中使用 Neo4J 测试的典型配置:spring-doc.cadn.net.cn

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

@DataNeo4jTest
class MyDataNeo4jTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

默认情况下,Data Neo4j 测试是事务性的,并在每个测试结束时回滚。 有关更多详细信息,请参阅 Spring Framework 参考文档中的 相关部分。 如果这不是您想要的,可以禁用测试或整个类的事务管理,如下所示:spring-doc.cadn.net.cn

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

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

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

@DataNeo4jTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class MyDataNeo4jTests
事务性测试不支持响应式访问。 如果您使用这种风格,则必须按照上述描述配置 @DataNeo4jTest 测试。

自动配置的 Data Redis 测试

您可以使用 @DataRedisTest 来测试 Redis 应用程序。 默认情况下,它会扫描 @RedisHash 类并配置 Spring Data Redis 存储库。 当使用 @DataRedisTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 Redis 的更多信息,请参阅 Redis。)spring-doc.cadn.net.cn

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

以下示例展示了 @DataRedisTest 注解的使用:spring-doc.cadn.net.cn

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

@DataRedisTest
class MyDataRedisTests {

	@Autowired
	private SomeRepository repository;

	// ...

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

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

	// ...

}

自动配置的数据 LDAP 测试

您可以使用 @DataLdapTest 来测试 LDAP 应用程序。 默认情况下,它会配置一个内存中的嵌入式 LDAP(如果可用),配置一个 LdapTemplate,扫描 @Entry 类,并配置 Spring Data LDAP 存储库。 当使用 @DataLdapTest 注解时,不会扫描常规的 @Component@ConfigurationProperties Bean。 可以使用 @EnableConfigurationProperties 来包含 @ConfigurationProperties Bean。 (有关在 Spring Boot 中使用 LDAP 的更多信息,请参阅 LDAP。)spring-doc.cadn.net.cn

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

以下示例展示了 @DataLdapTest 注解的使用:spring-doc.cadn.net.cn

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

@DataLdapTest
class MyDataLdapTests {

	@Autowired
	private LdapTemplate ldapTemplate;

	// ...

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

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

	// ...

}

内存中的嵌入式 LDAP 通常在测试中表现良好,因为它速度快且不需要任何开发人员安装。 然而,如果您希望针对真实的 LDAP 服务器运行测试,则应排除嵌入式 LDAP 自动配置,如下例所示:spring-doc.cadn.net.cn

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

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

	// ...

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

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

	// ...

}

自动配置的 REST 客户端

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

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

您要测试的特定 beans 应该通过使用 valuecomponents 属性的 @RestClientTest 来指定。spring-doc.cadn.net.cn

当在被测试的 bean 中使用 RestTemplateBuilder,并且在构建 RestTemplate 时已调用 RestTemplateBuilder.rootUri(String rootUri),则应从 MockRestServiceServer 期望中省略根 URI,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

	@Autowired
	private RemoteVehicleDetailsService service;

	@Autowired
	private MockRestServiceServer server;

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

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

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

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

}

当在被测试的 bean 中使用 RestClient.Builder,或者在使用 RestTemplateBuilder 时未调用 rootUri(String rootURI),则必须在 MockRestServiceServer 期望中使用完整的 URI,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

@RestClientTest(RemoteVehicleDetailsService.class)
class MyRestClientServiceTests {

	@Autowired
	private RemoteVehicleDetailsService service;

	@Autowired
	private MockRestServiceServer server;

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

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

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

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

}

自动配置的 Spring REST Docs 测试

您可以使用 @AutoConfigureRestDocs 注解在您的测试中通过 Mock MVC、REST Assured 或 WebTestClient 来使用 Spring REST Docs。 它消除了对 Spring REST Docs 中 JUnit 扩展的需求。spring-doc.cadn.net.cn

@AutoConfigureRestDocs 可用于覆盖默认输出目录(如果您使用 Maven,则为 target/generated-snippets;如果您使用 Gradle,则为 build/generated-snippets)。 它还可用于配置在任何记录的 URI 中出现的主机、方案和端口。spring-doc.cadn.net.cn

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

@AutoConfigureRestDocs 自定义 MockMvc bean,以便在测试基于 Servlet 的 Web 应用程序时使用 Spring REST Docs。 你可以使用 @Autowired 注入它,并在测试中像通常使用 Mock MVC 和 Spring REST Docs 那样使用它,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

	@Autowired
	private MockMvcTester mvc;

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

}

如果您更喜欢使用 AssertJ 集成,MockMvcTester 也可用,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

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

	@Autowired
	private MockMvcTester mvc;

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

}

两者在幕后复用同一个 MockMvc 实例,因此对其进行的任何配置都同时适用于两者。spring-doc.cadn.net.cn

如果您需要比 @AutoConfigureRestDocs 的属性所提供的更精细的 Spring REST Docs 配置控制,您可以使用 RestDocsMockMvcConfigurationCustomizer Bean,如下例所示:spring-doc.cadn.net.cn

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

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

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

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

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

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

}

如果您想利用 Spring REST Docs 对参数化输出目录的支持,可以创建一个 RestDocumentationResultHandler bean。 自动配置会使用此结果处理器调用 alwaysDo,从而使每次 MockMvc 调用自动生成默认代码片段。 以下示例展示了如何定义一个 RestDocumentationResultHandlerspring-doc.cadn.net.cn

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

@TestConfiguration(proxyBeanMethods = false)
public class MyResultHandlerConfiguration {

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

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

@TestConfiguration(proxyBeanMethods = false)
class MyResultHandlerConfiguration {

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

}

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

@AutoConfigureRestDocs 在测试响应式 Web 应用程序时,也可以与 WebTestClient 一起使用。 你可以通过使用 @Autowired 注入它,并像通常使用 @WebFluxTest 和 Spring REST Docs 时那样在测试中使用它,如下例所示:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

@WebFluxTest
@AutoConfigureRestDocs
class MyUsersDocumentationTests {

	@Autowired
	private WebTestClient webTestClient;

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

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

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

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

}

如果您需要比 @AutoConfigureRestDocs 的属性所提供的更精细的 Spring REST Docs 配置控制,您可以使用 RestDocsWebTestClientConfigurationCustomizer Bean,如下例所示:spring-doc.cadn.net.cn

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

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

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

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

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

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

}

如果您想利用 Spring REST Docs 对参数化输出目录的支持,可以使用 WebTestClientBuilderCustomizer 为每个实体交换结果配置一个消费者。 以下示例展示了如何定义这样一个 WebTestClientBuilderCustomizerspring-doc.cadn.net.cn

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

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

@TestConfiguration(proxyBeanMethods = false)
public class MyWebTestClientBuilderCustomizerConfiguration {

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

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

@TestConfiguration(proxyBeanMethods = false)
class MyWebTestClientBuilderCustomizerConfiguration {

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

}

使用 REST Assured 自动配置 Spring REST Docs 测试

@AutoConfigureRestDocs 会创建一个 RequestSpecification Bean,该 Bean 已预配置为使用 Spring REST Docs,并可供你的测试使用。 你可以通过使用 @Autowired 注入它,并在测试中像通常使用 REST Assured 和 Spring REST Docs 那样使用它,如下例所示:spring-doc.cadn.net.cn

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

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

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

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

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

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

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

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

}

如果您需要比 @AutoConfigureRestDocs 的属性所提供的更精细的 Spring REST Docs 配置控制,可以使用 RestDocsRestAssuredConfigurationCustomizer Bean,如下例所示:spring-doc.cadn.net.cn

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

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

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

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

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

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

}

自动配置的 Spring Web Services 测试

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

您可以使用 @WebServiceClientTest 来测试通过 Spring Web Services 项目调用 Web 服务的应用程序。 默认情况下,它会配置一个 MockWebServiceServer Bean,并自动自定义您的 WebServiceTemplateBuilder。 (有关在 Spring Boot 中使用 Web 服务的更多信息,请参阅 Web 服务。)spring-doc.cadn.net.cn

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

以下示例展示了 @WebServiceClientTest 注解的使用:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

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

@WebServiceClientTest(SomeWebService.class)
class MyWebServiceClientTests {

	@Autowired
	private MockWebServiceServer server;

	@Autowired
	private SomeWebService someWebService;

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

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

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

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

}

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

您可以使用 @WebServiceServerTest 来测试使用 Spring Web Services 项目实现 Web 服务的应用程序。 默认情况下,它会配置一个 MockWebServiceClient Bean,可用于调用您的 Web 服务端点。 (有关在 Spring Boot 中使用 Web 服务的更多信息,请参阅 Web Services。)spring-doc.cadn.net.cn

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

以下示例展示了 @WebServiceServerTest 注解的使用:spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;

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

@WebServiceServerTest(ExampleEndpoint.class)
class MyWebServiceServerTests {

	@Autowired
	private MockWebServiceClient client;

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

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

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

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

}

额外的自动配置和切片

每个切片提供一个或多个 @AutoConfigure…​ 注解,这些注解明确定义了应作为切片一部分包含的自动配置。 可以通过创建自定义 @AutoConfigure…​ 注解或向测试中添加 @ImportAutoConfiguration 来按测试逐个添加额外的自动配置,如下例所示:spring-doc.cadn.net.cn

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

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

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

@JdbcTest
@ImportAutoConfiguration(IntegrationAutoConfiguration::class)
class MyJdbcTests
请确保不要使用常规的 @Import 注解来导入自动配置,因为 Spring Boot 会以特定的方式处理它们。

或者,可以通过在存储在 META-INF/spring 的文件中注册它们,为任何切片注解的使用添加额外的自动配置,如下例所示:spring-doc.cadn.net.cn

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

在此示例中,com.example.IntegrationAutoConfiguration 在每个使用 @JdbcTest 注解的测试上都被启用。spring-doc.cadn.net.cn

您可以在此文件中使用带有 # 的注释。
一个切片或 @AutoConfigure…​ 注解可以通过这种方式进行自定义,只要它用 @ImportAutoConfiguration 进行了元注解。

用户配置与切片

因此,避免在应用程序的主类中混杂特定于其功能某一区域的配置设置变得尤为重要。spring-doc.cadn.net.cn

假设您正在使用 Spring Data MongoDB,依赖其自动配置,并已启用审计功能。 您可以按如下方式定义您的 @SpringBootApplicationspring-doc.cadn.net.cn

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 类中,如下例所示:spring-doc.cadn.net.cn

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 包含在由测试切片加载的应用程序上下文中:spring-doc.cadn.net.cn

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 被测试切片加载。spring-doc.cadn.net.cn

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 {

	// ...

}

另一个容易引起混淆的地方是类路径扫描。 假设你虽然以合理的方式组织了代码,但仍需要扫描一个额外的包。 你的应用程序可能如下所示:spring-doc.cadn.net.cn

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 似乎突然开始扫描应用程序的组件和用户配置。 同样,将自定义指令移至单独的类是解决此问题的好方法。spring-doc.cadn.net.cn

如果这对您来说不可行,您可以在测试层次结构中的某个位置创建一个 @SpringBootConfiguration,以便使用它。 或者,您可以为测试指定一个源,这将禁用查找默认源的行为。

使用 Spock 测试 Spring Boot 应用程序

Spock 2.2 或更高版本可用于测试 Spring Boot 应用程序。 为此,将 Spock 的 -groovy-4.0 版本的 spock-spring 模块依赖项添加到应用程序的构建中。 spock-spring 将 Spring 的测试框架集成到 Spock 中。 有关详细信息,请参阅 Spock 的 Spring 模块文档spring-doc.cadn.net.cn