一分钟上手SpringBootTest，单元测试如此简单

您好，我是码农飞哥，感谢您阅读本文！本文主要讲述如何在SpringBoot框架上进行单元测试。也就是使用SpringBootTest进行单元测试。

系统环境

Spring Boot Test介绍

Spring Test与Junit等其它框架结合起来，提供了便捷高效的测试手段，而SpringBootTest 是在Spring Test之上的再次封装，增加了切片测试，增强了Mock能力。

引入依赖

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-test</artifactId>
4. <version>${spring.boot.version}</version>
5. <scope>test</scope>
6. </dependency>

引入spring-boot-starter-test依赖，下面这些类库将被一同依赖进去：

1. Junit: java测试事实上的标准，默认依赖版本是4.12
2. Spring Test 依赖: Spring 的测试支持
3. AssertJ: 提供了流式的断言方式
4. Hamcrest: 提供了丰富的matcher
5. Mockito: mock框架，可以按类型创建mock对象，可以根据方法参数指定特定的响应，也支持对于mock调用过程的断言。
6. JSONassert: 为JSON提供了断言功能
7. JsonPath: 为JSON提供了XPATH功能

编写单元测试基类

1. @RunWith(SpringRunner.class)
2. @SpringBootTest
3. @ActiveProfiles("dev")
4. @AutoConfigureMockMvc
5. @WebAppConfiguration
6. @Transactional
7. public class BaseControllerTest {
8. @Autowired
9. private MockHttpServletRequest mockHttpServletRequest;
10. @Autowired
11. private MockMvc mockMvc;
13. @Before
14. public void setUp() {
15. mockHttpServletRequest.setAttribute("userId", "123");
16. }
18. protected String getMockResultStr(MockHttpServletRequestBuilder requestBuilder) {
19. try {
20. MvcResult mvcResult = this.mockMvc
21. .perform(requestBuilder)
22. .andExpect(status().isOk())
23. .andDo(MockMvcResultHandlers.print())
24. .andReturn();
25. MockHttpServletResponse response = mvcResult.getResponse();
26. response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
27. return response.getContentAsString();
28. } catch (Exception e) {
29. e.printStackTrace();
30. return null;
31. }
32. }
33. }

代码说明

1. @RunWith(SpringRunner.class) 注解表明使用SpringRunner来运行测试用例。@RunWith 注解是Junit4提供的注解，将Spring和Junit链接了起来。
2. @SpringBootTest 注解替换了SpringMVC中用到的 @ContextConfiguration注解，目的是加载ApplicationContext，启动Spring容器。使用 @SpringBootTest并没有像 @ContextConfiguration一样显示指定location或classes属性，原因在于 @SpringBootTest注解会自动检索程序的配置文件，检索的顺序是从当前包开始逐级向上查找被 @SpringBootApplication或 @SpringBootConfiguration注解的类
3. @ActiveProfiles 注解是指定连接的环境。
4. @AutoConfigureMockMvc 注解是用于自动配置 MockMvc，加上这个注解之后就可以直接通过 @Autowired 注入 MockMvc
5. @WebAppConfiguration 注解声明为集成测试加载的ApplicationContext应该是WebApplicationContext。
6. @Transactional 注解是为了回滚测试产生的数据。
7. MockHttpServletRequest 类为了模拟HttpServletRequest 对象，可以通过它来设置请求头，这在需要鉴权的接口测试中十分实用。
8. MockMvc 实现了对Http请求的模拟，能够直接使用网络的形式，转换到Controller的调用，这样可以使得测试速度快，不依赖网络环境，而且提供了一套验证的工具，这样可以使得请求的验证统一而且很方便。getMockResultStr 方法是封装了公共的测试。其中

1. MvcResult mvcResult = this.mockMvc
2. .perform(requestBuilder)
3. .andExpect(status().isOk())
4. .andDo(MockMvcResultHandlers.print())
5. .andReturn();

• perform方法是执行一个RequestBuilder请求，调用Controller的业务处理逻辑。
• andExpect 方法是添加执行完成后的断言，添加ResultMatcher验证规则，验证控制器执行完成后结果是否正确，此处是验证状态是否是200
• andDo 方法是添加一个结果处理器，比如在此处是 andDo(MockMvcResultHandlers.print())输出整个响应结果信息，可以在调试的时候使用。
• andReturn：方法是执行完成后返回相应的结果。

MockMvcRequestBuilders

RequestBuilder是用来构建请求的。其提供了一个方法buildRequest(ServletContext servletContext) 用于构建MockHttpServletRequest；其主要有两个子类MockHttpServletRequestBuilder和MockMultipartHttpServletRequestBuilder（文件上传时使用），即用来mock客户端请求需要的所有数据，主要API：MockHttpServletRequestBuilder get(String urlTemplate, Object... urlVariables)：根据uri模板和uri变量值得到一个GET请求方式的RequestBuilder，如果在controller的方法中method选择的是RequestMethod.GET，那在controllerTest中对应就要使用MockMvcRequestBuilders.get。post(String urlTemplate, Object... urlVariables)：同get类似，但是是POST方法；通过param 方法来设置请求参数。

get请求测试

1. MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.get("/v1/works/lineup/set")
2. .param("id", "123")
3. .param("first_flag", String.valueOf(true));
4. String result = getMockResultStr(requestBuilder);

post请求测试

1. MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.post("/v1/blockly/copy")
2. .param("id", "1211");
3. success(requestBuilder);

文件上传测试

1. File file = new File(RestArmWorksControllerTest.class.getClassLoader().getResource("20201102172053.png").toURI());
2. MockMultipartFile mockMultipartFile = new MockMultipartFile("file", "20201102172053.png", "", new FileInputStream(file));
3. MockMultipartHttpServletRequestBuilder servletRequestBuilder = MockMvcRequestBuilders.multipart("/creation/fileUpload.do")
4. .file(mockMultipartFile);
5. String result = getMockResultStr(servletRequestBuilder);

发送一个json格式的数据到Controller层

1. String requestJson = JSONObject.toJSONString(folderInfo);
2. MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.post("//v1/works/save").contentType(MediaType.APPLICATION_JSON).content(requestJson)；

总结

本文详细介绍了SpringBootTest的使用，首先介绍了如何引入依赖，接着介绍了编写一个测试基类，并且对其中涉及的各个注解做了一个详细说明。最后就是罗列了各种测试情况。

参考

SpringBoot Test及注解详解Spring Boot Test （二、注解详解）MockMvc详解