SpringBoot 使用 TestRestTemplate 进行 RESTful API 集成测试

约定不等于承诺〃 2024-03-16 22:52 6阅读 0赞

## SpringBoot 使用 TestRestTemplate 进行 RESTful API 集成测试 ##

RESTful API 集成测试是测试应用程序与其外部依赖项之间的集成。SpringBoot提供了TestRestTemplate来测试RESTful API，本文将介绍如何使用TestRestTemplate进行RESTful API集成测试。

![在这里插入图片描述][32c70540725e42c58b8d61a6ce94d0aa.png]

### 1. 什么是 TestRestTemplate ###

TestRestTemplate是SpringBoot提供的用于测试RESTful API的工具类。TestRestTemplate可以在测试中模拟HTTP请求，并验证响应是否符合预期。TestRestTemplate是基于RestTemplate实现的，但它使用了不同的配置和拦截器，以便在测试中使用。

### 2. 如何使用 TestRestTemplate ###

使用TestRestTemplate非常简单，只需要在测试类中创建一个TestRestTemplate实例，并使用该实例执行HTTP请求即可。例如，以下是一个使用TestRestTemplate测试RESTful API的示例：

@RunWith(SpringRunner.class)
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    public class UserControllerIntegrationTest {
        
    
        @Autowired
        private TestRestTemplate restTemplate;
    
        @Test
        public void shouldReturnUserById() {
        
            ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
            User user = responseEntity.getBody();
            assertThat(user.getId()).isEqualTo(1L);
            assertThat(user.getName()).isEqualTo("John Smith");
        }
    }

在测试中，使用了Spring Boot Test和JUnit的注解来配置测试环境。@Autowired注解用于自动注入TestRestTemplate实例。在测试方法中，使用TestRestTemplate执行HTTP GET请求，并使用断言验证响应是否符合预期。

### 3. TestRestTemplate 的高级用法 ###

TestRestTemplate提供了许多高级用法，以便在测试中模拟HTTP请求和验证响应。以下是一些常见的高级用法：

#### 3.1 模拟 HTTP 请求 ####

TestRestTemplate可以模拟各种HTTP请求，例如GET、POST、PUT、DELETE等。以下是一些示例：

// GET 请求
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
    
    // POST 请求
    User user = new User("John Smith");
    ResponseEntity<User> responseEntity = restTemplate.postForEntity("/users", user, User.class);
    
    // PUT 请求
    User user = new User("John Smith");
    restTemplate.put("/users/{id}", user, 1);
    
    // DELETE 请求
    restTemplate.delete("/users/{id}", 1);

#### 3.2 验证 HTTP 响应 ####

TestRestTemplate可以验证HTTP响应的各种属性，例如状态码、响应头和响应体。以下是一些示例：

// 验证状态码
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
    assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
    
    // 验证响应头
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
    assertThat(responseEntity.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
    
    // 验证响应体
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
    User user = responseEntity.getBody();
    assertThat(user.getId()).isEqualTo(1L);
    assertThat(user.getName()).isEqualTo("John Smith");

#### 3.3 添加请求头 ####

TestRestTemplate可以添加HTTP请求头，以模拟真实的HTTP请求。以下是一些示例：

HttpHeaders headers = new HttpHeaders();
    headers.set("Authorization", "Bearer token");
    HttpEntity<Object> entity = new HttpEntity<>(headers);
    ResponseEntity<User> responseEntity = restTemplate.exchange("/users/{id}", HttpMethod.GET, entity, User.class, 1);
    User user = responseEntity.getBody();
    assertThat(user.getId()).isEqualTo(1L);
    assertThat(user.getName()).isEqualTo("John Smith");

#### 3.4 使用参数化 URL ####

TestRestTemplate可以使用参数化URL，以便在测试中动态生成URL。以下是一些示例：

// 使用占位符
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, 1);
    
    // 使用Map
    Map<String, Long> params = new HashMap<>();
    params.put("id", 1L);
    ResponseEntity<User> responseEntity = restTemplate.getForEntity("/users/{id}", User.class, params);
    
    // 使用URI
    URI uri = UriComponentsBuilder.fromUriString("/users/{id}").build(1);
    ResponseEntity<User> responseEntity = restTemplate.getForEntity(uri, User.class);

#### 3.5 使用拦截器 ####

TestRestTemplate可以使用拦截器，在HTTP请求和响应之间添加自定义逻辑。以下是一些示例：

// 添加请求拦截器
    restTemplate.getRestTemplate().setInterceptors(Collections.singletonList((request, body, execution) -> {
        
        request.getHeaders().set("Authorization", "Bearer token");
        return execution.execute(request, body);
    }));
    
    // 添加响应拦截器
    restTemplate.getRestTemplate().setInterceptors(Collections.singletonList((request, body, execution) -> {
        
        ResponseEntity<User> responseEntity = execution.execute(request, body, User.class);
        User user = responseEntity.getBody();
        user.setName(user.getName().toUpperCase());
        return new ResponseEntity<>(user, responseEntity.getStatusCode());
    }));

在上述示例中，使用了请求和响应拦截器。请求拦截器添加了Authorization请求头，响应拦截器将响应体中的name字段转换为大写字母。

### 4. 总结 ###

TestRestTemplate是SpringBoot提供的用于测试RESTful API的工具类。使用TestRestTemplate可以模拟HTTP请求，并验证响应是否符合预期。TestRestTemplate提供了许多高级用法，例如模拟各种HTTP请求、验证HTTP响应、添加请求头、使用参数化URL和使用拦截器。使用TestRestTemplate可以有效地测试应用程序的RESTful API，保证其与外部依赖项的集成正常工作。

[32c70540725e42c58b8d61a6ce94d0aa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/9d4f6ae61ccf49fe8798681997b60ee5.png