004SpringBoot单元测试

上接003SpringBoot热部署

单元测试

单元测试在我们日常开发中必不可少，一个优秀的程序员，单元测试开发也非常完善。下面我们看下 Spring Boot 对单元测试又做了哪些支持？

如果我们只想运行一个 hello world，只需要一个 @Test 注解就可以了。在 src/test 目录下新建一个 HelloTest 类，代码如下：

public class HelloTest {
    @Test
    public void hello(){
        System.out.println("hello world");
    }
}

右键单击“运行”按钮，发现控制台会输出：hello world。如果需要测试 Web 层的请求呢？Spring Boot 也给出了支持。

以往我们在测试 Web 请求的时候，需要手动输入相关参数在页面测试查看效果，或者自己写 post 请求。在 Spring Boot 体系中，Spring 给出了一个简单的解决方案，使用 MockMVC 进行 Web 测试，MockMVC 内置了很多工具类和方法，可以模拟 post、get 请求，并且判断返回的结果是否正确等，也可以利用 print() 打印执行结果。

@SpringBootTest
public class HelloTest {

    private MockMvc mockMvc;

    @Before
    public void setUp() throws Exception {
        mockMvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();
    }

    @Test
    public void getHello() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.post("/hello?name=小明")
          .accept(MediaType.APPLICATION_JSON_UTF8)).andDo(print());
    }

}

• @Before 注解的方法表示在测试启动的时候优先执行，一般用作资源初始化。
• .accept(MediaType.APPLICATION_JSON_UTF8)) 这句是设置 JSON 返回编码，避免出现中文乱码的问题。
• 注意导包需要加入以下代码：

import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*;

因为 print() 等方法都是 MockMvcResultHandlers 类的静态方法。

在类的上面添加 @SpringBootTest，系统会自动加载 Spring Boot 容器。在日常测试中，可以注入 bean 来做一些局部的业务测试。MockMvcRequestBuilders 可以支持 post、get 请求，使用 print() 方法会将请求和相应的过程都打印出来，具体如下：

MockHttpServletRequest:
      HTTP Method = POST
      Request URI = /hello
       Parameters = {name=[小明]}
          Headers = {Accept=[application/json;charset=UTF-8]}
             Body = <no character encoding set>
    Session Attrs = {}

Handler:
             Type = com.neo.hello.web.HelloController
           Method = public java.lang.String com.neo.hello.web.HelloController.hello(java.lang.String)

...

MockHttpServletResponse:
           Status = 200
    Error message = null
          Headers = {Content-Type=[application/json;charset=UTF-8], Content-Length=[19]}
     Content type = application/json;charset=UTF-8
             Body = hello world ,小明
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

从返回的Body = hello world ,neo可以看出请求成功了。

当然每次请求都看这么多返回结果，不太容易识别，MockMVC 提供了更多方法来判断返回结果，其中就有判断返回值。我们将上面的 getHello() 方法稍稍进行改造，具体如下所示：

@Test
public void getHello() throws Exception {
    mockMvc.perform(MockMvcRequestBuilders.post("/hello?name=小明")
            .accept(MediaType.APPLICATION_JSON_UTF8))/*.andDo(print())*/
            .andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("小明")));
}

把刚才的 .andDo(print()) 方法注释掉，添加以下代码：

.andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("小明")));

• MockMvcResultMatchers.content()，这段代码的意思是获取到 Web 请求执行后的结果；
• Matchers.containsString("小明")，判断返回的结果集中是否包含“小明”这个字符串。

我们先将上面代码改为：

.andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("微笑")));

然后执行 test 即可返回以下结果：

java.lang.AssertionError: Response content
Expected: a string containing "微笑"
     but: was "hello world ,小明"
...

抛出异常说明：期望的结果是包含“微笑”，结果返回内容是“hello world ,小明”，不符合预期。

接下来我们把代码改回：

.andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("小明")));

再次执行测试方法，测试用例执行成功，说明请求的返回结果中包含了“小明”字段。

以上实践的测试方法，只是 spring-boot-starter-test 组件中的一部分功能，spring-boot-starter-test 对测试的支持是全方位的，后面会一一介绍到。