使用TestRestTemplate对REST接口进行单元测试

复杂系统开发中, 单元测试是必不可少的一个环节。而对于接口的测试，小型系统一般使用PostMan等工具对接口进行简单测试，但它有重复操作性差，返回值确认困难等缺点。SpringBoot提供了TestRestTemplate来针对接口编写单元测试。
pom.xml引入

  
      org.springframework.boot
      spring-boot-starter-test
      test
    

看一个基础的测试用例：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class MinimallTest {

  @LocalServerPort
  private int port;

  @Autowired
  private TestRestTemplate restTemplate;

  private String xAuthToken = "";

  private HttpHeaders headers = new HttpHeaders();

  @Before
  public void setHeaders() {
    JSONObject result = exchangeForJSON(HttpMethod.POST, "/wx/login", null);
    assertThat(result.getJSONObject("data").getString("sessionId")).isNotEmpty();
    xAuthToken = result.getJSONObject("data").getString("sessionId");
    headers.add("X-Requested-With", "XMLHttpRequest");
    headers.add("X-Auth-Token", xAuthToken);
  }

  @After
  public void clearHeaders(){
    headers.clear();
  }

  /**
   * 首页数据
   */
  @Test
  public void homepage() {
    JSONObject result = exchangeForJSON(HttpMethod.GET, "/wx/homepage", null);
    assertThat(result.getJSONObject("data").getString("banners")).isNotNull();
    assertThat(result.getJSONObject("data").getString("recommends")).isNotNull();
    assertThat(result.getJSONObject("data").getString("categories")).isNotNull();
  }

  private JSONObject exchangeForJSON(HttpMethod method, String url, MultiValueMap formData, String... variables) {
    HttpEntity> entity = new HttpEntity<>(formData, headers);
    if(method.equals(HttpMethod.POST)){
      headers.setContentType(MediaType.MULTIPART_FORM_DATA);
    }
    ResponseEntity response = restTemplate.exchange(
        "http://localhost:" + port + "/minimall_api/" + url,
        method, entity, String.class, variables);
    JSONObject result = JSON.parseObject(response.getBody());
    log.info(result.toJSONString());
    return result;
  }

类上的两个注解，@RunWith(SpringRunner.class)为测试用例添加Spring支持，而@SpringBootTest注解让每次测试运行时都会启动一个随机端口。只要在port属性上添加@LocalServerPort就可以获取到这个随机的端口用来访问。同时，使用了@SpringBootTest之后，我们就可以使用@Autowired来注入一个TestRestTemplate用来模拟Http请求。

@Before和@After顾名思义，会在每个测试之前和之后分别执行。
那么要发送一个GET请求的话，我们可以直接使用
restTemplate.getForEntity()
也可以使用通用的
restTemplate.exchange(String url, HttpMethod method, HttpEntity requestEntity, Class responseType, Object... urlVariables)
比如:
restTemplate.exchange( "http://localhost:" + port + "/minimall_api/login?userId={1}&password={2}", HttpMethod.GET, new HttpEntity<>(), String.class, "abc", "123456")

要发送POST请求就相对复杂一点, 要根据接口的需求设置Content-Type。比如，要发送一个multipart/formdata的请求:

MultiValueMap formData = new LinkedMultiValueMap<>();
formData.add("userId", "abc");
formData.add("password", "123456");
HttpHeaders headers = new HttpHeaders();
HttpEntity> entity = new HttpEntity<>(formData, headers);
restTemplate.exchange("http://localhost:" + port + "/minimall_api/" + url, HttpMethod.POST, entity, String.class);

这里要注意的是HttpEntity的body一定要是MultiValueMap的, 这样在测试运行的时候, RestTemplate才会判断这个消息应当调用FormHttpMessageConverter来进行转换, 判断逻辑是在RestTemplate的doWithRequest里:

public void doWithRequest(ClientHttpRequest httpRequest) throws IOException {
...
for (HttpMessageConverter messageConverter : getMessageConverters()) {
    if (messageConverter instanceof GenericHttpMessageConverter) {
        GenericHttpMessageConverter