为什么要写单元测试
一聊起测试用例，很多人第一反应就是，我们公司的测试会写测试用例的，我自己也会使用postman或者swagger之类的进行代码自测。那我们研发到底要不要写单元测试用例呢？参考阿里巴巴开发手册，第8条规则（单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率都要达到 100%），大厂的要求就是必须喽。我个人感觉，写单元测试用例也是很有必要的，好处很多，例如：
- 保证代码质量！！！无论初级，中级，高级开发工程的代码，功能是必要要保证是正确的；交付测试以后，bug锐减，联调飞快。
- 代码逻辑“文档化”！！！新人接手维护模块代码时，通过单元测试用例，以debug的方式就能熟悉业务代码。比起，看代码，研究表结构梳理代码结构，效率提升飞快。
- 易维护！！！新人接手维护代码模块时，提交自己的代码时，远行之前的单元测试达到回归测试，保证了新改动不会影响老业务。
到底如何写单元测试
Java开发springboot项目都是基于junit测试框架，比较MockitoJUnitRunner与SpringRunner与使用，MockitoJUnitRunner基于mockito，模拟业务条件，验证代码逻辑。SpringRunner是MockitoJUnitRunner子类，集成了Spring容器，可以在测试的根据配置加载Spring bean对象。在Springboot开发中，结合@SpringBootTest注解，加载项目配置，进行单元测试。
基于MockitoJUnitRunner的方法测试
以springboot项目为例，一般，对单个的方法都是进行mock测试，在测试方法使用MockitoJUnitRunner，根据不同条件覆盖测试。使用@InjectMocks注解，可以让模拟的方法正常发起请求；@Mock注解可以模拟期望的条件。以删除菜单服务为例，源码如下：
-
-
@Service
-
public
class MenuManagerImpl implements IMenuManager {
-
-
/**
-
* 删除菜单业务逻辑
-
**/
-
@Override
-
@OptimisticRetry
-
@Transactional(rollbackFor = Exception.class)
-
public boolean delete(Long id) {
-
-
if (Objects.isNull(id)) {
-
return
false;
-
}
-
Menu existingMenu =
this.menuService.getById(id);
-
if (Objects.isNull(existingMenu)) {
-
return
false;
-
}
-
if (!
this.menuService.removeById(id)) {
-
throw
new OptimisticLockingFailureException(
"删除菜单失败！");
-
}
-
return
true;
-
}
-
}
-
-
-
/**
-
* 删除菜单方法级单元测试用例
-
**/
-
@RunWith(MockitoJUnitRunner.class)
-
public
class MenuManagerImplTest {
-
-
@InjectMocks
-
private MenuManagerImpl menuManager;
-
-
@Mock
-
private IMenuService menuService;
-
-
@Test
-
public void delete() {
-
-
Long id =
null;
-
boolean flag;
-
// id为空
-
flag = menuManager.delete(id);
-
Assert.assertFalse(flag);
-
-
// 菜单返回为空
-
id =
1l;
-
Mockito.when(
this.menuService.getById(ArgumentMatchers.anyLong())).thenReturn(
null);
-
flag = menuManager.delete(id);
-
Assert.assertFalse(flag);
-
-
// 修改成功
-
Menu mockMenu =
new Menu();
-
Mockito.when(
this.menuService.getById(ArgumentMatchers.anyLong())).thenReturn(mockMenu);
-
Mockito.when(
this.menuService.removeById(ArgumentMatchers.anyLong())).thenReturn(
true);
-
flag = menuManager.delete(id);
-
Assert.assertTrue(flag);
-
}
-
}
基于SpringRunner的Spring容器测试
在api开发过程中，会对单个api的调用链路进行验证，对第三方服务进行mock模拟，本服务的业务逻辑进行测试。一般，会使用@SpringBootTest加载测试环境的Spring容器配置，使用MockMvc以http请求的方式进行测试。以修改新增菜单测试用例为例，如下：
-
/**
-
* 成功新增菜单api
-
*/
-
@Api(tags = "管理员菜单api")
-
@RestController
-
public
class AdminMenuController {
-
-
@Autowired
-
private IMenuManager menuManager;
-
-
-
@PreAuthorize("hasAnyAuthority('menu:add','admin')")
-
@ApiOperation(value = "新增菜单")
-
@PostMapping("/admin/menu/add")
-
@VerifyLoginUser(type = IS_ADMIN, errorMsg = INVALID_ADMIN_TYPE)
-
public Response<MenuVo> save(@Validated @RequestBody SaveMenuDto saveMenuDto) {
-
return Response.success(menuManager.save(saveMenuDto));
-
}
-
}
-
-
-
-
/**
-
* 成功新增菜单单元测试用例
-
*/
-
@RunWith(SpringRunner.class)
-
@SpringBootTest(classes = MallSystemApplication.class)
-
@Slf4j
-
@AutoConfigureMockMvc
-
public
class AdminMenuControllerTest extends BaseTest {
-
-
/**
-
* 成功新增菜单
-
*/
-
@Test
-
public void success2save() throws Exception {
-
-
SaveMenuDto saveMenuDto =
new SaveMenuDto();
-
saveMenuDto.setName(
"重置密码");
-
saveMenuDto.setParentId(
1355339254819966978l);
-
saveMenuDto.setOrderNum(
4);
-
saveMenuDto.setType(MenuType.button.getValue());
-
saveMenuDto.setVisible(MenuVisible.show.getValue());
-
saveMenuDto.setUrl(
"https:baidu.com");
-
saveMenuDto.setMethod(MenuMethod.put.getValue());
-
saveMenuDto.setPerms(
"user:reset-pwd");
-
// 发起http请求
-
MvcResult mvcResult = mockMvc.perform(MockMvcRequestBuilders
-
.post(
"/admin/menu/add")
-
.contentType(MediaType.APPLICATION_JSON_UTF8_VALUE)
-
.content(JSON.toJSONString(saveMenuDto))
-
.accept(MediaType.APPLICATION_JSON_UTF8_VALUE)
-
.header(GlobalConstant.AUTHORIZATION_HEADER, GlobalConstant.ADMIN_TOKEN))
-
.andExpect(MockMvcResultMatchers.status().isOk())
-
.andDo(MockMvcResultHandlers.print())
-
.andReturn();
-
Response<MenuVo> response = JSON.parseObject(mvcResult.getResponse().getContentAsString(), menuVoTypeReference);
-
// 断言结果
-
Assert.assertNotNull(response);
-
MenuVo menuVo;
-
Assert.assertNotNull(menuVo = response.getData());
-
Assert.assertEquals(menuVo.getName(), saveMenuDto.getName());
-
Assert.assertEquals(menuVo.getOrderNum(), saveMenuDto.getOrderNum());
-
Assert.assertEquals(menuVo.getType(), saveMenuDto.getType());
-
Assert.assertEquals(menuVo.getVisible(), saveMenuDto.getVisible());
-
Assert.assertEquals(menuVo.getStatus(), MenuStatus.normal.getValue());
-
Assert.assertEquals(menuVo.getUrl(), saveMenuDto.getUrl());
-
Assert.assertEquals(menuVo.getPerms(), saveMenuDto.getPerms());
-
Assert.assertEquals(menuVo.getMethod(), saveMenuDto.getMethod());
-
}
-
}
具体编写单元测试用例规则参考测试用例的编写。简单说，一般api的单元测试用例，编写两类，如下：
- 业务参数的校验，和义务异常的校验。例如，名称是否为空，电话号码是否正确，用户未登陆则抛出未登陆异常。
- 各类业务场景的真实测试用例，例如，编写成功添加顶级菜单的测试用例，已经编写成功添加子级菜单的测试用例。
注意事项
此外，如上的编写的测试用例，会对项目发起真实的调用，如果，环境的配置为线上配置，容易出现安全问题。一般，处于安全考虑，很多公司不会进行真实环境的调用。这时，可以在src/test/resources目录下，添加与src/main/resources目录下，相同的文件进行配置覆盖。src/test/main目录下的代码，会首先加载src/test/resources目录下的配置，如果没有则在加载src/main/resources目录的配置。示例，在单元测试环境使用内存数据库（h2数据库）,在单元测试环境不输出日志文件等等。以日志文件为例，如图：
main/resource目录下的logback-spring.xml，内容如下：
-
<?xml version="1.0" encoding="UTF-8"?>
-
<configuration scan="true">
-
-
<contextName>mall-system
</contextName>
-
-
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-
<encoder>
-
<pattern>
-
[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%level][%thread] [%contextName] [%logger{80}:%L] %msg%n
-
</pattern>
-
<charset>UTF-8
</charset>
-
</encoder>
-
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-
<level>DEBUG
</level>
-
</filter>
-
</appender>
-
-
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
-
<file>log/info.log
</file>
-
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
-
<fileNamePattern>log/info-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
-
<maxFileSize>50MB
</maxFileSize>
-
<maxHistory>50
</maxHistory>
-
<totalSizeCap>10GB
</totalSizeCap>
-
</rollingPolicy>
-
<encoder>
-
<pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%level] [%contextName] [%logger{80}:%L] %msg%n
</pattern>
-
</encoder>
-
</appender>
-
-
<root level="DEBUG">
-
<appender-ref ref="STDOUT" />
-
<appender-ref ref="FILE" />
-
</root>
-
<logger name="com.kuqi.mall.system.dao" level="DEBUG" />
-
</configuration>
src/test//resource目录下的logback-spring.xml，屏蔽了file文件日志输出，只有控制台日志输出，内容如下：
-
<?xml version="1.0" encoding="UTF-8"?>
-
<configuration scan="true">
-
-
<contextName>mall-system
</contextName>
-
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-
<encoder>
-
<pattern>
-
[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%level][%thread] [%contextName] [%logger{80}:%L] %msg%n
-
</pattern>
-
<charset>UTF-8
</charset>
-
</encoder>
-
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-
<level>DEBUG
</level>
-
</filter>
-
</appender>
-
-
<root level="DEBUG">
-
<appender-ref ref="STDOUT"/>
-
</root>
-
<logger name="com.kuqi.mall.system.dao" level="DEBUG"/>
-
</configuration>
转载：https://blog.csdn.net/new_com/article/details/116098959
查看评论