如何让单元测试变得简单

╰+攻爆jí腚メ 2023-03-12 07:22 24阅读 0赞

### 文章目录 ###

*   *  1 单元测试的好处
     *  2 单元测试质量不高的原因
     *  3 本文目标
     *  4 单元测试内容
     *   *  4.1 单元测试的定义与目的
         *  4.2 集成测试的定义与目的
         *  4.3 单元测试场景
         *  4.4 单元测试的原则
         *  4.5 单元测试组成
     *  5 如何使单元测试变得简单
     *   *  5.1 单元测试现象
         *  5.2 思路
         *  5.3 测试方法之间独立
         *  5.4 减少测试方法依赖
         *  5.5 识别有效参数、等价类
         *  5.6 代码可读性提升
     *  6 项目中哪里使用单元测试、哪里使用集成测试
     *   *  6.1 单元测试
         *  6.2 集成测试
     *  7 项目地址

本文主要针对目前单元测试可能存在的现象，来探讨一些解决方案

--------------------

## 1 单元测试的好处 ##

*  保证项目质量
 *  降低项目成本（项目改动越频繁降低的成本越多）
    
     *  降低开发过程中需求变更带来的代码改动成本
     *  降低测试人员的工作
     *  降低后期先维护成本
     *  降低后期项目重构成本
 *  增加自信
    
     *  优质的单元测试可以使得开发人员对项目质量非常放心
     *  功能迭代、重构时也没有后顾之忧
     *  他人也会对你的项目有信心
 *  提高设计能力：如果你觉得哪个方法难以测试，肯定(99%)是你设计有问题

--------------------

## 2 单元测试质量不高的原因 ##

*  排期少，写单元测试耗时太长
 *  单元测试运行耗时太长：导致大量 ignore
 *  单元测试依赖本地服务（redis、数据库等）导致线上测试不通过：导致大量 ignore
 *  单元测试没有强制要求

--------------------

## 3 本文目标 ##

*  加强单元测试认知（不在于语言和测试框架）
 *  使单元测试变得简单
 *  在相同时间内，写出更好、覆盖率更高、更优质的测试用例
 *  减少单元测试运行时间

--------------------

## 4 单元测试内容 ##

### 4.1 单元测试的定义与目的 ###

*  **定义：** 是针对软件设计的最小单元，做正确性检验的测试工作
 *  **目的：** 证明最小单元的行为符合开发者预期

### 4.2 集成测试的定义与目的 ###

*  **定义：** 对多个最小单元组成的集成模块的正确性检验测试工作
 *  **目的：** 证明集成模块的行为符合开发者预期

### 4.3 单元测试场景 ###

*  添加功能：保证其他模块正确，避免引入新的bug
 *  修改 bug：好的单元测试可以避免引入新的 bug
 *  回归测试
 *  重构：检验重构是否正确

### 4.4 单元测试的原则 ###

*  **独立性**
    
     *  测试方法能不调用其他测试方法
     *  测试方法之间操作的**资源隔离**
     *  不依赖方法间的执行顺序（完全认为所有方法时并行执行的）
     *  不依赖其他方法
 *  可重复：重复执行结果一致

### 4.5 单元测试组成 ###

*  测试标识（如：@Test）、测试条件（如：@Ingore）、测试前后动作（如：@Before、@After）
 *  mock：模拟测试方法中可能依赖的对象
 *  stubbing：为 mock 出来的对象打桩（控制模拟对象的行为）
 *  assert：断言，没有断言的测试不是测试

--------------------

## 5 如何使单元测试变得简单 ##

### 5.1 单元测试现象 ###

*  太多重复的测试（controller、service、mapper 层都进行了启动 spring 测试）
 *  运行时间太长（主要是spring启动时间）
 *  测试不完整（只测正常流程，因为测所有参数非常麻烦）
 *  总结：对单元测试的认知不够，没有形成一个好的**套路**

### 5.2 思路 ###

*  使测试方法之间独立
 *  较少测试方法的依赖
 *  识别有效参数
 *  识别等价类与边界值

### 5.3 测试方法之间独立 ###

*  保证方法独立，解决数据冲突后顾之忧

@RunWith(SpringRunner.class)
    @SpringBootTest(classes = BaseApplicationTest.class)
    @ActiveProfiles("unit_test")
    @Rollback //此注解保证了事务方法执行后都会进行回滚操作，保证了方法之间的数据隔离
    public class MapperTest { 
        @Test
        @Transactional //开启事务，保证数据隔离
        public void selectByName1() throws Exception { 
        }
    }

### 5.4 减少测试方法依赖 ###

*  测试方法中包含的其它方法调用，是测试复杂度的核心因素之一

@Service
    public class UserService implements UserApi { 
        @Autowired
        UserInfoService userInfoService;
        
        @Override
        public UserDTO getOrderListDemo(UserInfoRequest req, String site, String name, List<String> names){ 
            if (req == null) { 
                throw new RuntimeException("req 对象是null");
            }
            UserDTO userDTO;
            try { 
                //其它方法调用！！
                userDTO = userInfoService.getUserInfo(req);
            } catch (IllegalArgumentException e) { 
                userDTO = new UserDTO();
                userDTO.setId(2L);
            } catch (IllformedLocaleException e) { 
                userDTO = new UserDTO();
                userDTO.setId(1L);
            }
            return userDTO;
        }
    }

### 5.5 识别有效参数、等价类 ###

*  正确识别有效参数、等价类，可以降低 99.9% 测试用例复杂度！

//age 为有效参数，它的等价类：null、负整数、正整数、0
    public Integer test(String name, Integer age) { 
        if (age == null) { 
            return null;
        }
        if (age < 0) { 
            return -1;
        }
        if (age == 0) { 
            return 0;
        }
        if (age > 0) { 
            return 1;
        }
    }

@RunWith(MockitoJUnitRunner.class)
    public class UserServiceTest { 
        //mock
        @Mock
        UserInfoService userInfoService;
        @InjectMocks
        UserService userService;
        
        @Test
        public void getOrderListDemo() { 
            //stubbing
            doReturn(null,new UserDTO())
            .doThrow(new IllegalArgumentException("远程调用发生异常"),new IllformedLocaleException("异常")).when(userInfoService).getUserInfo(any());
    		//assert
            UserInfoRequest req = new UserInfoRequest();
            //第1次调用
            userDTO result = userService.getOrderListDemo(req,null,null,null);
            assert result == null;
            //第2次调用
            result = userService.getOrderListDemo(req,null,null,null);
            assert result.getId() == null;
            //第3次调用
            result = userService.getOrderListDemo(req,null,null,null);
            assert result.getId() == 2;
            //第4次调用
            result = userService.getOrderListDemo(req,null,null,null);
            assert result.getId() == 1;
    
            req = null;
            try { 
                //第5次调用
                userController.getOrderListDemo(req,null,null,null);
                Assert.fail();
            } catch (RuntimeException e) { }
        }
    }

### 5.6 代码可读性提升 ###

*  使用 spock 测试框架，提升代码可读性

class UserInfoSpecTest extends Specification { 
        @Shared
        UserInfoService service
        @Shared
        UserService userService;
        //mock 与 stubbing
        def setupSpec() { 
            service = Mock(UserInfoService);
            controller = Spy(UserInfoController);
            service.getUserInfo(_) >>> [null, new UserDTO()] >> {  throw new IllegalArgumentException() } >> { 
                throw new IllformedLocaleException()
            }
            ReflectionTestUtils.setField(controller, "userInfoService", service)
        }
    
        @Unroll
        def "test user info #msg"() { 
            expect:
            try { 
                assert userService.getOrderListDemo(request, null, null, null).getInfo().getId() == id
            } catch (ConditionFailedWithExceptionError e) { 
                //这里捕获的是 ConditionFailedWithExceptionError 包装后的业务抛出的异常
                if (msg.equals("外部调用返回null，捕获 getInfo().getId 抛的 NPX 异常")) { 
                    assert e.getCause() instanceof NullPointerException; return
                }
                if (msg.equals("捕获 req 为 null 时内部方法抛异常")) { 
                    assert "req 对象是null".equals(e.getCause().getMessage()); return
                }
                Assert.fail()
            }
            where:
            request               | id   | msg
            new UserInfoRequest() | _    | "异常：外部调用返回null，捕获 getInfo().getId 抛的 NPX 异常"
            new UserInfoRequest() | null | "正常：外部调用返回空对象"
            new UserInfoRequest() | 2    | "正常：外部调用返回对象 id 为 2"
            new UserInfoRequest() | 1    | "正常：外部调用返回对象 id 为 1"
            null                  | _    | "异常：捕获 req 为 null 时内部方法抛异常"
        }
    }

--------------------

## 6 项目中哪里使用单元测试、哪里使用集成测试 ##

### 6.1 单元测试 ###

*  项目中绝大部分的public方法
 *  逻辑非常简单的方法可以不测（controller 直接调 service 等）
 *  private 方法如何测试
    
     *  测试对于的 public 方法时，把其对应的 private 方法的代码看成自己本身的代码测试
     *  使用可以测试 private 的测试框架（推荐，因为简单）
 *  static 方法如何测试：正常测试

### 6.2 集成测试 ###

*  controller 层
 *  测试项目依赖组件 **使用的正确性**（redis、消息队列）
 *  要点1：对应组件有优质内存模式(h2,rabbitmq-mock )的使用内存模式，没有的使用远程独立服务，而不要使用本地服务
 *  要点2：如果仅仅集成测试 controller 层，不好测到一些依赖组件，则去指定的位置去集成测试依赖组件

--------------------

## 7 项目地址 ##

[mockito/spock 语法测试项目][mockito_spock]

[mockito_spock]: https://github.com/wangkang09/unit-test