Java mocking 单元测试框架介绍

海鸥一飞

我需要在数据库里插入一些数据，基于这些真实的数据我才可以进行单元测试，而且每次都需要重复
准备脚本，还要考虑数据的清理。
我需要启动一个Tomcat，然后通过Http Client发送请求，然后观察数据，才可以进行测试。
我需要启动Dubbo服务的提供者，因为我的类里依赖的这个服务，否则我的类没办法正常运行。
我需要依赖第三方的一个接口，因为我这个类是用来发送短信的，这样我才能验证我的短信发送时正
常的。往往第三方都没有测试环境，即使有的话也不稳定，导致我不能经常进行持续集成的测试。
……
我们主要的面临的问题是，由于所依赖的组件不容易构造或者不容易获取，所以导致我们不容易写出
单元测试，甚至由于觉得麻烦索性不写单元测试(悲伤)，如：
HttpServletRequest必须在web容器中才能构造出来；
Dubbo服务必须有服务提供者；
依赖第三方的一个接口，如短信，支付等。http接口， webservice接口等；
JDBC中的ResultSet对象；

Mock测试就是在测试过程中，对于某些不容易构造或者不容易获取比较复杂的对象，用一个虚拟的对
象来创建以便测试的测试方法。
Mock最大的功能是帮你把单元测试的解耦，如果你的代码对另一个类或者接口有依赖，它能够帮你模
拟这些依赖，并帮你验证所调用的依赖的行为。

Mcokito框架使用：

验证行为

1. import static org.mockito.Mockito.*;
   
2. 
   
3. public void once_created_mock_will_remember_all_interactions() {
   
4.     List<String> mockedList = mock(List.class);
   
5. 
   
6.     mockedList.add("one");
   
7.     mockedList.clear();
   
8. 
   
9.     //验证调用了add方法,并且参数为one
   
10.     verify(mockedList).add("one");
    
11.     verify(mockedList).clear();
    
12. 
    
13.     verify(mockedList).add("two");
    
14. }

复制代码

打桩–>Stubbing

1. public void stubbing() {
   
2.     LinkedList mockedList = mock(LinkedList.class);
   
3. 
   
4.     when(mockedList.get(0)).thenReturn("first");
   
5.     when(mockedList.get(0)).thenReturn("second");
   
6. 
   
7.     System.out.println(mockedList.get(0));
   
8. 
   
9.     //mock对象会覆盖整个被mock的对象，因此没有stub的方法只能返回默认值。
   
10.     System.out.println(mockedList.get(999));
    
11. 
    
12.     when(mockedList.get(1)).thenThrow(new RuntimeException());
    
13. 
    
14.     System.out.println(mockedList.get(1));
    
15. }

复制代码

如果方法返回值没有stub过，mockito会返回相应的默认值。如int会返回0，布尔值返回false。对于其
他类型会返回null。重复stub两次,则以第二次为准。

参数匹配器

1. public void argument_matcher() {
   
2.     LinkedList mockedList = mock(LinkedList.class);
   
3. 
   
4.     //设置无论获取任何位置的值,都返回固定的一个fixed-element
   
5.     when(mockedList.get(anyInt())).thenReturn("fixed-element");
   
6. 
   
7.     System.out.println(mockedList.get(999));
   
8. 
   
9.     verify(mockedList).get(anyInt());
   
10. 
    
11.     //自定义参数匹配器
    
12.     when(mockedList.contains(argThat(isValid()))).thenReturn(true);
    
13. 
    
14.     System.out.println(mockedList.contains("custom-matcher"));
    
15. 
    
16.     System.out.println(mockedList.contains("custom-matcher2"));
    
17. }
    
18. 
    
19. 顺序调用
    
20. 
    
21. public void verify_invoke_in_order() {
    
22. 
    
23.     List singleMock = mock(List.class);
    
24. 
    
25.     singleMock.add("was added first");
    
26.     singleMock.add("was added second");
    
27. 
    
28.     InOrder inOrder = inOrder(singleMock);
    
29. 
    
30.     inOrder.verify(singleMock).add("was added first");
    
31.     inOrder.verify(singleMock).add("was added second");
    
32. }

复制代码

注解的使用

@mock：需要被Mock的对象，mock对象的方法不会再被真实调用，如果需要调用需要使用stub(打桩)；
@InjectMocks: 需要将Mock对象注入的对象；
@Captor：（参数捕获器）捕获方法参数进行验证；

@mock与@InjectMocks使用如下：



现在假设在service层有如下代码需要测试：

1. public boolean isEmployee(String phoneNumber) {
   
2.         if (StringUtils.isEmpty(phoneNumber)) {
   
3.             return false;
   
4.         }
   
5.         return userRepository.findByPhoneNumber(phoneNumber).isPresent();
   
6.     }

复制代码

测试代码

1. @Mock
   
2. private userRepository userRepository;
   
3. @InjectMocks
   
4. private userServiceImpl userServiceImpl;
   
5. 
   
6. @Test
   
7. public void testMock() {
   
8.       User user = new User();
   
9.       stub(userRepository
   
10.                 .findByPhoneNumber(anyString()))
    
11.                 .toReturn(Optional.of(user));
    
12.       userServiceImpl.isEmployee("110");
    
13.       verify(userRepository,times(1))
    
14.      .findByPhoneNumber("110");//findByPhoneNumber方法被调用一次
    
15.     }

复制代码

如上可以正常测试。但是将最后一行findByPhoneNumber(“110”)号码改成119酒会报错，如下：

单元测试三步骤：设置测试数据，设定预期结果，验证结果，三步通过，测试通过。

@Captor使用如下：
ArgumentCaptor的Api
argument.capture() 捕获方法参数
argument.getValue() 获取方法参数值，如果方法进行了多次调用，它将返回最后一个参数值
argument.getAllValues() 方法进行多次调用后，返回多个参数值
代码案例：

1. @Captor
   
2. private ArgumentCaptor<Money> moneyCaptor;
   
3. @Captor
   
4. private ArgumentCaptor<User> userCaptor;
   
5. 
   
6. 
   
7. verify(userMoneyService, times(1)).updateStatus( userCaptor.capture(),moneyCaptor.capture());//获取参数
   
8. assertThat(userCaptor.getValue().getRole(), is("Admin");//验证参数
   
9. assertThat(moneyCaptor.getValue(), is("15rmb");
   
10. 
    
11. //updateStatus方法如下
    
12. public void updateStatus(User user,Money money){
    
13.     执行方法……
    
14. }

复制代码