Mockito

Posted 2020-10-06 激流勇进、

Mockito

一 mockito基本概念

Mock测试是单元测试的重要方法之一，而Mockito作为一个流行的Mock框架，简单易学，且有非常简洁的API，测试代码的可读性很高。

Mock测试就是在测试过程中，对于一些不容易构造(如HttpServletRequest必须在Servlet容器中才能构造出来)或者说获取比较复杂的对象(如JDBC中的ResultSet对象)或者说我们并不需要关注的对象，用一个虚拟的对象(Mock对象)来创建方便测试的测试方法。

Mock最大的功能是可以帮我们把单元测试的耦合分解开，如果代码中对另一个类或接口有依赖，它就能帮你模拟这些依赖，并帮你验证所调用的依赖的行为。

Java中目前主要的Mock测试工具有Mockito,JMock,EasyMock等等，很多Java Mock库如EasyMock或JMock都是expect-run-verify(期望-运行-测试)的方式，而Mockito则更简单：在执行后的互动中提问。使用Mockito主要记住，在执行前stub，而后在交互中验证即可。

 

那么什么是stub呢？了解一下Stub和Mock的区别。

Stub对象用来提供测试时所需要的测试数据，可以对各种交互设置相应的回应，比如说设置方法调用的返回值等等。我们在Mockito中可以通过when(...)thenReturn(...)来设置方法调用的返回值。

Mock对象用来验证测试中所依赖的对象间的交互能否达到预期，我们可以在Mockito中用verify(...)methodXxx(...)语法来验证methodXxx方法是否按预期被调用。它也有限制，对于final类、匿名类和Java的基本类型是无法mock的。

 

二 具体使用

1.如果项目是Maven管理的，那么就要在pom.xml中加入依赖：

<dependency> 
    <groupId>org.mockito</groupId> 
    <artifactId>mockito-all</artifactId> 
    <version>1.8.5</version> 
    <scope>test</scope> 
</dependency>

然后在程序中直接import static org.mockito.Mockito.*; 即可

2.首先看一个例子：

List mockList = mock( List.class ); 
when( mockList .get(0) ).thenReturn( 1 ); 
assertEquals( "预期返回1", 1, mockList .get( 0 ) );

mockList模拟了List的对象，拥有List的所有方法和属性。when(...).thenReturn(...)是指当执行这个方法的时候，返回指定的值。相当于模拟配置对象的过程，为某些条件给定一个预期的返回值。

这里的List是Java.util.List接口，并不是实现类，你也可以使用实现类，我们可以使用它们作为打桩对象。这里的打桩(Stub)也可以叫存根，就是把所需的测试数据塞进对象中，关注的是输入和输出。这里的when(...).thenReturn(...)就是在定义对象方法和参数(输入)，然后在thenReturn()中指定结果(输出)，这个过程就是Stub打桩，一旦这个方法被Stub了，就会一直返回这个stub的值。当我们连续两次为同一个方法使用stub的时候，最后的那个stub是有效的。

一旦mock了一个对象之后，mock对象会覆盖掉整个被mock的对象，因此如果没有stub方法，就只能返回默认值。当我们mock一个接口时，很多成员方法只是一个签名，并没有实现，需要我们手动写出这些实现方法。比如说，我们模拟request请求对象，被测试的代码中使用了HttpServletRequest的什么方法，就要写出相应的实现方法：

HttpServletRequest request = mock(HttpServletRequest.class); 
when(request.getParameter("foo")).thenReturn("boo");

如果我们不通过when().thenReturn()返回预期值，mockito就会默认返回null，也不会报错说这个方法找不到。mock实例默认的会给所有的方法添加基本实现：返回null或者空集合，或者0等基本类型的值。

3.迭代风格

打桩支持迭代风格的返回值设定，如：

// 第一种方式   
when(i.next()).thenReturn("Hello").thenReturn("World"); 
// 第二种方式 
when(i.next()).thenReturn("Hello", "World"); 
// 第三种方式，都是等价的 
when(i.next()).thenReturn("Hello"); 
when(i.next()).thenReturn("World");

4.测试无返回值的方法

如果被测试的方法没有返回值，那么测试方法是：

doNothing().when(i).remove();   
doNothing().when(obj).notify(); 
// 或直接 
when(obj).notify();

5.抛出异常

mockito还能对被测试的方法强行抛出异常：

when(i.next()).thenThrow(new RuntimeException());
doThrow(new RuntimeException()).when(i).remove();

支持迭代风格：

doNothing().doThrow(new RuntimeException()).when(i).remove();  //第一次调用remove方法什么都不做，第二次调用抛出RuntimeException异常。  

6.参数匹配器

Argument Matcher(参数匹配器)

Mockito通过equals()方法，来对方法参数进行验证。但是有时候我们需要更加灵活的参数需求，比如，匹配任何的String类型的参数等等。参数匹配器就是一个能够满足这些需求的工具。

Mockito框架中的Matchers类内建了很多参数匹配器，我们常用的Mockito对象就是继承自Matchers。比如anyInt()匹配任何int类型的参数，anyString()匹配任何字符串...

@Test 
public void argumentMatchersTest(){ 
    List<String> mock = mock(List.class); 
    when(mock.get(anyInt())).thenReturn("Hello").thenReturn("World"); 
    String result=mock.get(100)+" "+mock.get(200); 
    verify(mock,times(2)).get(anyInt()); 
    assertEquals("Hello World",result); 
} 

首先mock了List接口，然后用迭代的方式模拟了get方法的返回值，这里用了anyInt()参数匹配器来匹配任何的int类型的参数。所以当第一次调用get方法时输入任意参数为100方法返回”Hello”，第二次调用时输入任意参数200返回值”World”。

这里需要注意：

如果使用了参数匹配器，那么所有的参数需要由匹配器来提供，否则将会报错。假如我们使用参数匹配器stubbing了mock对象的方法，那么在verify的时候也需要使用它。如：

@Test 
public void argumentMatchersTest(){ 
    Map mapMock = mock(Map.class); 
    when(mapMock.put(anyInt(), anyString())).thenReturn("world"); 
    mapMock.put(1, "hello"); 
    verify(mapMock).put(anyInt(), eq("hello")); 
}   

在最后的验证时如果只输入字符串”hello”是会报错的，必须使用Matchers类内建的eq方法。如果将anyInt()换成1进行验证也需要用eq(1)。

7.验证Verify

之前的when(...).thenReturn(...)属于状态测试，有些时候，测试并不关心返回结果，而是关心方法是否被正确的参数调用过，这时候就应该使用验证方法了。从概念上讲，就是和状态测试不同的“行为测试”了。一旦通过mock对模拟对象打桩，意味着mockito会记录着这个模拟对象调用了什么方法，调用了多少次，最后由用户决定是否需要进行验证，即verify()方法。

mockedList.add("one"); 
mockedList.add("two"); 
verify(mockedList).add("one");

verify 内部跟踪了所有的方法调用和参数的调用情况，然后会返回一个结果，说明是否通过。

Map mock = Mockito.mock( Map.class ); 
when( mock.get( "city" ) ).thenReturn( "广州" ); 
// 关注参数有否传入 
verify(mock).get( Matchers.eq( "city" ) ); 
// 关注调用的次数 
verify(mock, times( 2 )); 

也就是说，这是对历史记录作一种回溯校验的处理。

Mockito 除了提供 times(N) 方法供我们调用外，还提供了很多可选的方法：

never() 没有被调用，相当于 times(0)

atLeast(N) 至少被调用 N 次

atLeastOnce() 相当于 atLeast(1)

atMost(N) 最多被调用 N 次

verify 也可以像 when 那样使用模拟参数，若方法中的某一个参数使用了matcher，则所有的参数都必须使用 matcher。

// correct   
verify(mock).someMethod(anyInt(), anyString(), eq("third argument"));   
// will throw exception   
verify(mock).someMethod(anyInt(), anyString(), "third argument"); 

8.Spy

Mock对象是能调用stubbed方法，调用不了它真实的方法，但是Mockito可以监视一个真实的对象，这时对它进行方法调用时它将调用真实的方法，同时也可以stubbing这个对象的方法让它返回我们的期望值。同时，我们也可以用verify进行验证。

监视对象

监视一个对象需要调用spy(T object)方法，如：List spy = spy(new LinkedList());那么spy变量就在监视LinkedList实例。

被监视对象的Stubbing

stubbing被监视对象的方法时要慎用when(Object)，如：

List spy = spy(new LinkedList()); 
//Impossible: real method is called so spy.get(0) throws IndexOutOfBoundsException (the list is yet empty) 
when(spy.get(0)).thenReturn("foo"); 
//You have to use doReturn() for stubbing 
doReturn("foo").when(spy).get(0);

当调用when(spy.get(0)).thenReturn("foo")时，会调用真实对象的get(0)，由于list是空的所以会抛出IndexOutOfBoundsException异常，用doReturn可以避免这种情况的发生，因为它不会去调用get(0)方法。

9.使用ArgumentCaptor(参数捕获器) 捕获方法参数进行验证

在某些场景中，不光要对方法的返回值和调用进行验证，同时需要验证一系列交互后所传入方法的参数，这时我们可以用参数捕获器来捕获传入方法的参数进行验证，看它是否符合我们的要求。

通过ArgumentCaptor对象的forClass(Class<T> clazz)方法来构建ArgumentCaptor对象然后就可以在验证时对方法的参数进行捕获，最后验证捕获的参数值。如果方法有多个参数都要捕获验证，那就需要创建多个ArgumentCaptor对象处理。

argument.capture()  捕获方法参数

argument.getValue() 获取方法参数值，如果方法进行了多次调用，它将返回最后一个参数值

argument.getAllValues() 方法进行多次调用后，返回多个参数值

@Test 
public void argumentCaptorTest() { 
    List mock = mock(List.class); 
    List mock2 = mock(List.class); 
    mock.add("John"); 
    mock2.add("Brian"); 
    mock2.add("Jim"); 

    ArgumentCaptor argument = ArgumentCaptor.forClass(String.class); 

    verify(mock).add(argument.capture()); 
    assertEquals("John", argument.getValue()); 

    verify(mock2, times(2)).add(argument.capture()); 

    assertEquals("Jim", argument.getValue()); 
    assertArrayEquals(new Object[]{"Brian","Jim"},argument.getAllValues().toArray()); 
} 

在某种程度上参数捕获器和参数匹配器有很大的相关性。它们都用来确保传入mock对象参数的正确性。然而，当自定义的参数匹配器的重用性较差时，用参数捕获器会更合适，只需在最后对参数进行验证即可。