Spring Boot单元测试入门实战

一、关于JUnit的一些东西

在我们开发Web应用时，经常会直接去观察结果进行测试。虽然也是一种方式，但是并不严谨。作为开发者编写测试代码来测试自己所写的业务逻辑是，以提高代码的质量、降低错误方法的概率以及进行性能测试等。经常作为开发这写的最多就是单元测试。引入spring-boot-starter-testSpringBoot的测试依赖。该依赖会引入JUnit的测试包，也是我们用的做多的单元测试包。而Spring Boot在此基础上做了很多增强，支持很多方面的测试，例如JPA，MongoDB，Spring MVC（REST）和Redis等。

接下来主要是测试业务逻辑层的代码，REST和Mock测试。

1.1 JUnit介绍

JUnit是一个Java语言的单元测试框架。它由Kent Beck和Erich Gamma建立，逐渐成为源于Kent Beck的sUnit的xUnit家族中最为成功的一个。 JUnit有它自己的JUnit扩展生态圈。多数Java的开发环境都已经集成了JUnit作为单元测试的工具。

JUnit相关概念	含义
测试	一个以@Test注释的方法定义一个测试，运行这个方法，JUnit会创建一个包含类的实例，然后再调用这个被注释的方法。
测试类	包含多个@Test方法的一个类
Assert	定义想测试的条件，当条件成立时，assert 方法保持沉默，条件不成立时，则抛出异常
Suite	Suite允许将测试类归类成一组
Runner	Runner类用于运行测试，JUnit4是向后兼容的，可以运行JUnit3的测试实例

这里使用的是JUnit4.x版本，JUnit中有两个重要的类Assume+Assert，以及重要的注解：BeforeClass、AfterClass、After、Before、Test和Ignore。BeforeClass和AfterClass在每个类的开始和结束的时候运行，需要static修饰方法。而Before和After则是在每个测试方法的开始和结束的时候运行。

代码片段：TestDeployApplication.class是自己编写的Spring Boot启动类。

复制代码

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {TestDeployApplication.class})
public class UnitTest1 {
@BeforeClass
public static void beforeClass() {
System.out.println("=================BeforeClass================");
}
@AfterClass
public static void afterClass() {
System.out.println("=================AfterClass================");
}
@Before
public void beforeTest() {
System.out.println("before test");
}
@After
public void afterTest() {
System.out.println("after test");
}
@Test
public void test1() {
System.out.println("test1");
}
@Test
public void test2() {
System.out.println("test2");
}
}

1.2 JUnit的Assert类

Assert类中常用的方法：

assertEquals("提示信息",A,B)：当判断A是否等于B，不等于就抛出错误。比较对象是调用的是equals()方法。
assertSame("提示信息",A,B)：判断对象是否相同。
assertTrue("提示信息",A)：判断条件A是否为真。
assertFalse("提示信息",A)：判断条件是否为假。
assertNotNull("提示信息",A)：判断对象是否不为空。
assertNull("提示信息",A)：判断对象是否不为空。
assertArrayEqual("提示信息",A,B)：判断数组A和数组B是否相等。

1.3 JUnit的Suite

JUnit的Suite设计就是一次性运行一个或多个测试用例，Suite可以看作是一个容器，用来把测试类归类在一起，并把他们作为一个集合来运行，运行器启动Suite。

复制代码

@RunWith(Suite.class)
@SuiteClasses({UnitTest1.class,UnitTest2.class})
public class MainTest{
}

二、Spring Boot单元测试

添加需要的依赖

复制代码

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>

2.1 Spring Boot测试依赖提供的测试范围

引入了spring-boot-starter-test继承了很多的测试库：

JUnit，标准的单元测试Java程序。
Spring Test和Spring Boot Test，对Spring Boot应用的单元测试。
Mockito，Java Mock测试框架，用于模拟任何Spring管理的Bean。例如在- - 单元测试中，模拟一个第三方系统接口返回的数据，而不用真正地去请求第三方接口。
AssertJ，一个assertion库，同时提供了更加多的期望值与测试返回值的比较方式。
Hamcrest，库的匹配对象。
JSONassert，对JSON对象或者JSON字符串断言的库。
JSONPath，提供向XPath那样的符号来获取JSON字段。

2.2 Spring Boot单元测试的脚手架

在使用spring.io创建的Spring Boot工程中，就默认常见了一个单元测试的类。

复制代码

@RunWith(SpringRunner.class)
@SpringBootTest
public class UnitTest1 {
@Test
public void contextLoads(){
}
}

@RunWith是JUnit中的注解，用来通知JUnit单元测试框架不要使用内置的方式进行单元测试，向上面的写法，就是指定使用SpringRunner类来提供单元测试。

@SpringBootTest注解则是用于Spring Boot应用的测试，默认会分局报名逐级往上查找Spring Boot主程序，也就是@SpringBootApplocation注解，并在单元测试启动的时候启动该类来创建Spring上下文。所以我们在对Spring Boot应用进行单元测试的时候，在日志输出都可以看到Spring Boot应用的启动日志。

2.3 对Service层代码测试

复制代码

import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.*;
@RunWith(SpringRunner.class)
@SpringBootTest
@Transactional
public class ServiceUnitTest {
@MockBean
private ThirdSystemService thirdSystemService;
@Autowired
private ISysUserService userService;
@Test
public void test1() {
Long expectResult = 100L;
given(thirdSystemService.develop()).willReturn(expectResult);
SysUser sysUser = userService.findById(expectResult);
System.out.println(sysUser.toString());
}
}

@MockBean可以获取在Spring下上文管理的Bean，但是thirdSystemService这个Bean并不是真的实列，而是通过Mockito工具创建的测试实例。通过@MockBean注解模拟出来的Bean，调用方法是不会真正的调用真正的方法，适用于在依赖了第三方的系统，然而第三方的系统的对接并没有实现完成，自己可以单独测试自己的业务代码。willReturn(expectResult)说明结果永远返回100L。

2.5 测试MVC代码

Spring Boot中还能单独测试Controller的代码，例如测试Controller中方法的参数绑定和校验之类的逻辑。可以通过@WebMvcTest注解来完成单元测试。

复制代码

@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test2() throws Exception {
MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.get("/hello/{id}", 1L);
mockMvc.perform(requestBuilder)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print());
}
}

像Get方法传递参数

复制代码

MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders
.get("/hello/{id}", 1L) // path变量
.param("name", "hello"); // @RequestParam 获取变量。post请求也适用

文件上传

复制代码

@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test3() throws Exception {
// 获取文件
FileInputStream fileInputStream = new FileInputStream("文件路径");
// 构建文件上传对象
MockMultipartFile mockMultipartFile = new MockMultipartFile("file", fileInputStream);
// 构建mock文件上传请求
MockMultipartHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.multipart("/upload").file(mockMultipartFile);
// 发送请求
mockMvc.perform(requestBuilder)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print());
}
}

复制代码

模拟Cookie和Session
@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test4() throws Exception {
MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders
.get("index.html")
.sessionAttr("name", "hello")
.cookie(new Cookie("token", "123345"));
mockMvc.perform(requestBuilder)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print());
}
}

设置请求头

复制代码

@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test5() throws Exception {
MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders
.get("index.html")
.content(MediaType.APPLICATION_JSON_VALUE) // 期望返回类型
.contentType(MediaType.APPLICATION_JSON_VALUE) // 提交的内容类型
.header("token", 1235); // 设置请求头
mockMvc.perform(requestBuilder)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print());
}
}

2.6 比较返回结果

MockMvc类的perform方法会返回一个ResultAction类，可以对结果进行一些操作(andExpect、andDo和andReturn)。

复制代码

@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test2() throws Exception {
MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders
.get("/hello/{id}", 1L)
.param("name", "hello");
mockMvc.perform(requestBuilder)
.andExpect(MockMvcResultMatchers.jsonPath("$.id", "id").value(2L));
.andDo(MockMvcResultHandlers.print());
}
}

例如上面获取返回的JSON结果中的id字段的值，value是期望值，如果期望值与实际值不一样测试就会报错。

也可以断言测试返回结果的View(视图)和Model(数据模型)是否是期望值

复制代码

@RunWith(SpringRunner.class)
@WebMvcTest(SysUserController.class)
public class ServiceUnitTest {
@Autowired
private MockMvc mockMvc;
MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders
.get("/hello/{id}", 1L)
.param("name", "hello");
mockMvc.perform(requestBuilder)
// 断言返回的试图
.andExpect(MockMvcResultMatchers.view().name("index.html"))
// 断言返回的数据模型中的数据
.andExpect(MockMvcResultMatchers.model().attribute("id",1L))
.andDo(MockMvcResultHandlers.print());
}

更多的结果断言可以在MockMvcResultMatchers类中找到，该类是请求结果的匹配的一个工具类。