跳到主要内容
版本：7.0.3

RestTestClient

Hunyuan 7b 中英对照 RestTestClient

RestTestClient 是一个专为测试服务器应用程序而设计的 HTTP 客户端。它封装了 Spring 的 RestClient，并利用其执行请求，但提供了用于验证响应的测试接口。RestTestClient 可用于执行端到端的 HTTP 测试。此外，也可以通过 MockMvc 在没有运行中的服务器的情况下测试 Spring MVC 应用程序。

设置​

要设置一个RestTestClient，你需要选择一个要绑定的服务器配置。这可以是几种MockMvc配置选项之一，也可以是与真实服务器的连接。

绑定到控制器​

这种设置允许你通过模拟请求和响应对象来测试特定的控制器，而无需运行服务器。

RestTestClient client =
		RestTestClient.bindToController(new TestController()).build();

绑定到 ApplicationContext​

这种设置允许你加载带有Spring MVC基础设施和控制器声明的Spring配置，并使用它通过模拟请求和响应对象来处理请求，而无需运行服务器。

import org.junit.jupiter.api.BeforeEach;

import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import org.springframework.test.web.servlet.client.RestTestClient;
import org.springframework.web.context.WebApplicationContext;

@SpringJUnitConfig(WebConfig.class) // Specify the configuration to load
public class RestClientContextTests {

	RestTestClient client;

	@BeforeEach
	void setUp(WebApplicationContext context) {  // Inject the configuration
		// Create the `RestTestClient`
		client = RestTestClient.bindToApplicationContext(context).build();
	}

}

绑定到路由器函数​

这种设置允许你通过模拟请求和响应对象来测试功能端点，而无需运行服务器。

RouterFunction<?> route = ...
client = RestTestClient.bindToRouterFunction(route).build();

绑定到服务器​

此设置连接到正在运行的服务器以执行完整的端到端HTTP测试：

client = RestTestClient.bindToServer().baseUrl("http://localhost:8080").build();

客户端配置​

除了前面描述的服务器设置选项外，您还可以配置客户端选项，包括基础URL、默认头部信息、客户端过滤器等。这些选项在最初的bindTo调用之后就可以轻松获取了，具体如下：

client = RestTestClient.bindToController(new TestController())
		.baseUrl("/test")
		.build();

编写测试​

RestClient 和 RestTestClient 在调用 exchange() 之前拥有相同的 API。之后，RestTestClient 提供了两种验证响应的替代方法：

  1. 内置断言 通过一系列预期来扩展请求工作流程。

  2. AssertJ集成 通过 assertThat() 语句来验证响应。

内置断言​

要使用内置的断言功能，在调用 exchange() 之后仍保留在工作流中，并使用其中一个期望（expectation）方法。例如：

client.get().uri("/persons/1")
		.accept(MediaType.APPLICATION_JSON)
		.exchange()
		.expectStatus().isOk()
		.expectHeader().contentType(MediaType.APPLICATION_JSON)
		.expectBody();

如果你希望所有的预期都能得到验证，即使其中有一个失败了，你可以使用expectAll(..)而不是多个连续的expect*(..)调用。这个特性类似于AssertJ中的软断言支持以及JUnit Jupiter中的assertAll()支持。

client.get().uri("/persons/1")
		.accept(MediaType.APPLICATION_JSON)
		.exchange()
		.expectAll(
				spec -> spec.expectStatus().isOk(),
				spec -> spec.expectHeader().contentType(MediaType.APPLICATION_JSON)
		);

然后，您可以选择通过以下方法之一来解码响应体：

  • expectBody(Class<T>): 解码为单个对象。

  • expectBody(): 解码为 byte[]（适用于JSON内容）或空体。

如果内置的断言不足以满足需求，你可以直接使用该对象，并执行任何其他的断言操作：

client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody(Person.class)
		.consumeWith(result -> {
			// custom assertions (for example, AssertJ)...
		});

或者你可以退出工作流程并获得一个 EntityExchangeResult：

EntityExchangeResult<Person> result = client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody(Person.class)
		.returnResult();

Person person = result.getResponseBody();
HttpHeaders requestHeaders = result.getRequestHeaders();
提示

当您需要使用泛型解码到目标类型时，请寻找那些接受 ParameterizedTypeReference 而不是 Class<T> 的重载方法。

无内容​

如果预期响应中不会有内容，可以如下进行断言：

client.post().uri("/persons")
		.body(person)
		.exchange()
		.expectStatus().isCreated()
		.expectBody().isEmpty();

如果你想忽略响应内容，以下代码将不加任何断言地释放该内容：

client.post().uri("/persons")
		.body(person)
		.exchange()
		.expectStatus().isCreated()
		.expectBody(Void.class);
备注

如果您的测试启用了缓冲池泄漏检测功能（例如，使用expectBody），则必须消耗响应体。否则，该工具会报告存在缓冲区泄漏的情况。

JSON内容​

你可以使用expectBody()而不指定目标类型，从而对原始内容进行断言，而无需通过更高层的对象（Object(s)）来进行。

要使用JSONAssert验证完整的JSON内容：

client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody()
		.json("{\"name\":\"Jane\"}");

要使用JSONPath验证JSON内容：

client.get().uri("/persons")
		.exchange()
		.expectStatus().isOk()
		.expectBody()
		.jsonPath("$[0].name").isEqualTo("Jane")
		.jsonPath("$[1].name").isEqualTo("Jason");

AssertJ集成​

RestTestClientResponse 是 AssertJ 集成的主要入口点。它是一个 AssertProvider，用于包装交换（exchange）的 ResponseSpec，以便能够使用 assertThat() 语句。例如：

RestTestClient.ResponseSpec spec = client.get().uri("/persons").exchange();

RestTestClientResponse response = RestTestClientResponse.from(spec);
assertThat(response).hasStatusOk();
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN);

你也可以首先使用内置的工作流，然后获取一个ExchangeResult来包装它，并继续使用AssertJ。例如：

ExchangeResult result = client.get().uri("/persons").exchange().returnResult();

RestTestClientResponse response = RestTestClientResponse.from(result);
assertThat(response).hasStatusOk();
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN);