Java手把手教学！TestRestTemplate超详细使用案例

IT行业相对于一般传统行业，发展更新速度更快，一旦停止了学习，很快就会被行业所淘汰。所以我们需要踏踏实实的不断学习，精进自己的技术，尤其是初学者。今天golang学习网给大家整理了《Java手把手教你玩转TestRestTemplate（附详细案例）》，聊聊，我们一起来看看吧！

TestRestTemplate在Spring Boot测试中的使用方法如下：首先，确保测试类使用@SpringBootTest注解并注入TestRestTemplate实例；其次，可利用其提供的getForEntity、postForEntity、put、delete及exchange等方法发起各种HTTP请求；第三，针对需认证的API，可通过withBasicAuth方法设置Basic Authentication；第四，通过RestTemplateBuilder自定义TestRestTemplate行为，如设置超时时间和添加拦截器；第五，在处理错误时，默认抛出HttpClientErrorException或HttpServerErrorException，也可自定义ResponseErrorHandler实现精细控制；第六，使用MockRestServiceServer模拟外部服务调用；第七，TestRestTemplate自动处理Cookie，也可手动通过HttpHeaders设置；第八，上传文件时使用MultiValueMap封装文件并设置multipart/form-data类型。

TestRestTemplate是Spring Boot提供的一个便捷的RestTemplate客户端，特别适合在集成测试中用来测试RESTful接口。它简化了HTTP请求的发送和响应的处理，让你专注于业务逻辑的验证。

使用TestRestTemplate可以轻松地发起GET、POST、PUT、DELETE等各种HTTP请求，并方便地验证响应的状态码、Header以及Body内容。它内置了对JSON和XML等常见数据格式的支持，省去了手动序列化和反序列化的麻烦。

如何在Spring Boot测试中使用TestRestTemplate？

首先，确保你的测试类使用了@SpringBootTest注解，这将启动一个完整的Spring Boot应用上下文。然后，你可以通过@Autowired注解将TestRestTemplate注入到你的测试类中。

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class MyIntegrationTest {

    @Autowired
    private TestRestTemplate restTemplate;

    @Test
    public void testGetEndpoint() {
        ResponseEntity response = restTemplate.getForEntity("/my-endpoint", String.class);
        assertEquals(HttpStatus.OK, response.getStatusCode());
        assertTrue(response.getBody().contains("Expected Content"));
    }
}

这里，webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT确保应用运行在一个随机端口上，避免端口冲突。restTemplate.getForEntity方法发起一个GET请求到/my-endpoint，并将响应体映射为String类型。

TestRestTemplate的几种常见用法

TestRestTemplate提供了多种方法来发起不同类型的HTTP请求。例如，postForEntity用于POST请求，put用于PUT请求，delete用于DELETE请求。此外，还有exchange方法，它允许你更灵活地指定HTTP方法、Header和Body。

// POST请求
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity requestEntity = new HttpEntity<>(new MyRequest("someData"), headers);
ResponseEntity response = restTemplate.postForEntity("/my-endpoint", requestEntity, MyResponse.class);

// PUT请求
restTemplate.put("/my-endpoint/{id}", requestEntity, 123);

// DELETE请求
restTemplate.delete("/my-endpoint/{id}", 123);

// exchange请求
ResponseEntity response = restTemplate.exchange("/my-endpoint", HttpMethod.GET, null, MyResponse.class);

postForEntity方法接收请求URL、请求体（封装在HttpEntity中）和响应体的类型作为参数。put和delete方法则可以接受URL参数。exchange方法提供了最大的灵活性，允许你自定义HTTP方法和Header。

如何处理需要认证的API？

对于需要认证的API，你可以使用withBasicAuth方法来设置Basic Authentication。

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class MyIntegrationTest {

    @Autowired
    private TestRestTemplate restTemplate;

    @LocalServerPort
    private int port;

    @Test
    public void testAuthenticatedEndpoint() {
        TestRestTemplate authenticatedRestTemplate = restTemplate.withBasicAuth("user", "password");
        ResponseEntity response = authenticatedRestTemplate.getForEntity("http://localhost:" + port + "/secured-endpoint", String.class);
        assertEquals(HttpStatus.OK, response.getStatusCode());
    }
}

withBasicAuth方法返回一个新的TestRestTemplate实例，该实例在每次请求时都会自动添加Authorization Header。

如何自定义TestRestTemplate的行为？

有时候，你可能需要自定义TestRestTemplate的行为，例如设置超时时间、添加拦截器等。你可以通过RestTemplateBuilder来创建TestRestTemplate，并进行自定义配置。

@Configuration
public class TestRestTemplateConfig {

    @Bean
    public RestTemplateBuilder restTemplateBuilder() {
        return new RestTemplateBuilder()
                .setConnectTimeout(Duration.ofSeconds(5))
                .setReadTimeout(Duration.ofSeconds(5))
                .interceptors(new MyClientHttpRequestInterceptor());
    }

    @Bean
    public TestRestTemplate testRestTemplate(RestTemplateBuilder restTemplateBuilder) {
        return new TestRestTemplate(restTemplateBuilder);
    }
}

这里，我们创建了一个RestTemplateBuilder，设置了连接超时和读取超时，并添加了一个自定义的拦截器。然后，我们使用该RestTemplateBuilder创建了一个TestRestTemplate实例。

TestRestTemplate与RestTemplate的区别是什么？

主要区别在于TestRestTemplate更适合集成测试环境，它会自动处理一些与测试相关的配置，例如使用随机端口等。而RestTemplate则更通用，可以在各种环境中使用。TestRestTemplate实际上是对RestTemplate的封装，提供了更便捷的测试API。

TestRestTemplate在处理错误时有哪些策略？

TestRestTemplate默认会抛出异常来处理HTTP错误，例如HttpClientErrorException和HttpServerErrorException。你可以在测试代码中捕获这些异常，并进行相应的断言。另外，你也可以自定义ResponseErrorHandler来处理错误。

restTemplate.setErrorHandler(new DefaultResponseErrorHandler() {
    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
        if (response.getStatusCode().series() == HttpStatus.Series.SERVER_ERROR) {
            // 处理服务器错误
        } else if (response.getStatusCode().series() == HttpStatus.Series.CLIENT_ERROR) {
            // 处理客户端错误
            if (response.getStatusCode() == HttpStatus.NOT_FOUND) {
                // 处理404错误
            }
        }
    }
});

通过自定义ResponseErrorHandler，你可以更精细地控制错误处理逻辑。

如何模拟外部依赖服务？

在集成测试中，我们经常需要模拟外部依赖服务，以避免对真实服务的依赖。可以使用MockRestServiceServer来模拟RestTemplate的调用。

@Autowired
private RestTemplate restTemplate;

private MockRestServiceServer mockServer;

@BeforeEach
public void setUp() {
    mockServer = MockRestServiceServer.createServer(restTemplate);
}

@Test
public void testExternalService() {
    mockServer.expect(ExpectedCount.once(),
            requestTo(new URI("http://external-service/api")))
            .andExpect(method(HttpMethod.GET))
            .andRespond(withStatus(HttpStatus.OK)
                    .contentType(MediaType.APPLICATION_JSON)
                    .body("{\"data\":\"mocked data\"}"));

    // 调用restTemplate的代码

    mockServer.verify();
}

MockRestServiceServer允许你定义RestTemplate的预期行为，例如预期请求的URL、HTTP方法和响应。这使得你可以完全控制RestTemplate的调用，并专注于测试你的业务逻辑。

如何处理Cookie？

TestRestTemplate会自动处理Cookie，你无需手动设置Cookie。如果你的API需要Cookie认证，TestRestTemplate会自动在后续请求中携带Cookie。如果你需要手动设置Cookie，可以使用HttpHeaders。

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.COOKIE, "myCookie=someValue");
HttpEntity entity = new HttpEntity<>(headers);
ResponseEntity response = restTemplate.exchange("/my-endpoint", HttpMethod.GET, entity, String.class);

如何处理文件上传？

可以使用MultiValueMap来处理文件上传。

@Test
public void testFileUpload() {
    MultiValueMap body = new LinkedMultiValueMap<>();
    body.add("file", new FileSystemResource("path/to/your/file.txt"));
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.MULTIPART_FORM_DATA);
    HttpEntity> requestEntity = new HttpEntity<>(body, headers);
    ResponseEntity response = restTemplate.postForEntity("/upload", requestEntity, String.class);
}

这里，我们使用FileSystemResource来封装文件，并将其添加到MultiValueMap中。然后，我们设置Content-Type为multipart/form-data，并使用postForEntity方法发起POST请求。

好了，本文到此结束，带大家了解了《Java手把手教学！TestRestTemplate超详细使用案例》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！