JUnit + Mockito 单元测试（二）(good)-白红宇

JUnit + Mockito 单元测试（二）(good)

阅读量：5818 次

发布时间：2019-06-18

本文共 11047 字，大约阅读时间需要 36 分钟。

import org.junit.Test;import org.mockito.Matchers;import org.mockito.Mockito;import java.util.List;import java.util.Map;import static org.hamcrest.CoreMatchers.is;import static org.hamcrest.MatcherAssert.assertThat;import static org.mockito.Mockito.*;/** * Created by MyWorld on 2016/1/26. */public class MockitoDemo {    @Test    public void mockitoMapDemo1() {        Map mockedMap = Mockito.mock(Map.class);        when(mockedMap.get("city")).thenReturn("广州");        Object cityValue = mockedMap.get("city");        assertThat(cityValue.toString(), is("广州"));        verify(mockedMap).get(Matchers.eq("city"));        verify(mockedMap, times(2));    }    @Test    public void mockitoMapDemo2() {        Map mockedMap = Mockito.mock(Map.class);//        when(mockedMap.put(anyInt(), anyString())).thenReturn("world");        mockedMap.put(1, "hello");        verify(mockedMap).put(anyInt(), eq("hello"));    }    @Test    public void mockitoListDemo() {        List mockedList = Mockito.mock(List.class);        mockedList.add("one");        mockedList.add("two");        verify(mockedList).add("one");        verify(mockedList, times(2)).add(anyString());    }}

JUnit 是单元测试框架。Mockito 与 JUnit 不同，并不是单元测试框架（这方面 JUnit 已经足够好了），它是用于生成模拟对象或者直接点说，就是”假对象“的工具。两者定位不同，所以一般通常的做法就是联合 JUnit + Mockito 来进行测试。

入门

首先是配置 Mock 对象，看看例子怎么写的。

List mockedList = Mockito.mock(List.class);        when(mockedList.get(0)).thenReturn(1);        assertEquals("Descriptive information ", 1, mockedList.get(0));

其中 mock 是模拟 List 的对象，拥有 List 的所有方法和属性。when(xxxx).thenReturn(yyyy); 是指定当执行了这个方法的时候，返回 thenReturn 的值，相当于是对模拟对象的配置过程，为某些条件给定一个预期的返回值。相信通过这个简单的例子你可以明白所谓 Mock 便是这么一回事。

我们看到 List 为 Java.util.List 是接口，并不是实现类，但这不妨碍我们使用它作为我们的“打桩”对象，——当然你也可以使用实现类，传入 mock(obj) 方法中。

这里提到的是"打桩（Stub，也有人称其为“存根”）"的概念，是一个形象的说法，就是把所需的测试数据塞进对象中，

适用于基于状态的（state-based）测试，关注的是输入和输出。

Mockito 中 when(…).thenReturn(…) 这样的语法来定义对象方法和参数（输入），然后在 thenReturn 中指定结果（输出）。此过程称为 Stub 打桩。

一旦这个方法被 stub 了，就会一直返回这个 stub 的值。

打桩需要：

对于 static 和 final 方法， Mockito 无法对其 when(…).thenReturn(…) 操作。

当我们连续两次为同一个方法使用 stub 的时候，他只会只用最新的一次。

mock 对象会覆盖整个被 mock 的对象，因此没有 stub 的方法只能返回默认值。又因为，我们 mock 一个接口的时候，很多成员方法只是一个签名，并没有实现，这就要我们手动写出这些实现方法啦。典型地，我们模拟一个 request 请求对象，你被测试的代码中使用了 HttpSerevletRequest 什么方法，就要写出相应的实现方法！

HttpServletRequest mockedRequest = Mockito.mock(HttpServletRequest.class);        when(mockedRequest.getParameter("foo")).thenReturn("too");        assertThat(mockedRequest.getParameter("foo"), is("too"));

这里“打桩”之后，我们执行 request.getParamter("foo") 就会返回 boo，如果不这样设定，Mockito 就会返回默认的 null，也不会报错说这个方法找不到。

mock 实例默认的会给所有的方法添加基本实现：返回 null 或空集合，或者 0 等基本类型的值。

这取决于方法返回类型，如 int 会返回 0，布尔值返回 false。对于其他 type 会返回 null。

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

Iterator mockedIterator = Mockito.mock(Iterator.class);        //第一种方式        when(mockedIterator.next()).thenReturn("hello").thenReturn("world");        //第二种方式        when(mockedIterator.next()).thenReturn("hello", "world");        //第三种方式        when(mockedIterator.next()).thenReturn("hello");        when(mockedIterator.next()).thenReturn("world");

会返回 ”World”。

上述我们一直在讨论被测试的方法都有返回值的，那么没有返回值的 void 方法呢？也是测试吗？答案是肯定的。——只不过 Mockito 要求你的写法上有不同，因为都没返回值了，调用 thenReturn(xxx) 肯定不行，取而代之的写法是，

[java]

doNothing().when(obj).notify();

// 或直接

when(obj).notify();

Mockito 还能对被测试的方法强行抛出异常，

[java]

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

doThrow(new RuntimeException()).when(i).remove(); // void 方法的

// 迭代风格

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

如需指定异常类型，参见。

模拟传入的参数 argument matchers

拿上面的例子说，其中一个问题，

when(request.getParameter(

"foo")).thenReturn("boo");

这里 getParameter("foo") 这里我们是写死参数 foo 的，但是如果我不关心输入的具体内容，可以吗？可以的，最好能像正则表达式那样，/w+ 表示任意字符串是不是很方便，不用考虑具体什么参数，只要是字符串型的参数，就可以打桩。如此方便的想法 Mockito 也考虑到了，提供 argument matchers 机制，例如 anyString() 匹配任何 String 参数，anyInt() 匹配任何 int 参数，anySet() 匹配任何 Set，any() 则意味着参数为任意值。例子如下，

when(mockedList.get(anyInt())).thenReturn("element");

System.out.println(mockedList.get(999));// 此时打印是 element

再进一步，自定义类型也可以，如 any(User.class)，另，参见和和。

获取返回的结果

一个问题，thenReturn 是返回结果是我们写死的。如果要让被测试的方法不写死，返回实际结果并让我们可以获取到的——怎么做呢？

有时我们需要自定义方法执行的返回结果，Answer 接口就是满足这样的需求而存在的。

例如模拟常见的 request.getAttribute(key)，由于这本来是个接口，所以连内部实现都要自己写了。此次通过 Answer 接口获取参数内容。

[java]

final Map<String, Object> hash = new HashMap<String, Object>();

Answer<String> aswser = new Answer<String>() {

public String answer(InvocationOnMock invocation) {

Object[] args = invocation.getArguments();

return hash.get(args[0].toString()).toString();

}

};

when(request.getAttribute("isRawOutput")).thenReturn(true);

when(request.getAttribute("errMsg")).thenAnswer(aswser);

when(request.getAttribute("msg")).thenAnswer(aswser);

利用 InvocationOnMock 提供的方法可以获取 mock 方法的调用信息。下面是它提供的方法：

getArguments() 调用后会以 Object 数组的方式返回 mock 方法调用的参数。

getMethod() 返回 java.lang.reflect.Method 对象

getMock() 返回 mock 对象

callRealMethod() 真实方法调用，如果 mock 的是接口它将会抛出异常

void 方法可以获取参数，只是写法上有区别，

[java]

doAnswer(new Answer<Object>() {

public Object answer(InvocationOnMock invocation) {

Object[] args = invocation.getArguments();

// Object mock = invocation.getMock();

System.out.println(args[1]);

hash.put(args[0].toString(), args[1]);

return "called with arguments: " + args;

}

}).when(request).setAttribute(anyString(), anyString());

其实就是一个回调，——如果不是接口，是实现类的话，估计不用自己写实现。

验证 Verify

前面提到的 when(……).thenReturn(……) 属于状态测试，某些时候，测试不关心返回结果，而是侧重方法有否被正确的参数调用过，这时候就应该使用验证方法了。从概念上讲，就是和状态测试所不同的“行为测试”了。

一旦使用 org.mockito.Mockito.mock() 对模拟对象打桩，意味着 Mockito 会记录着这个模拟对象调用了什么方法，还有调用了多少次。

最后由用户决定是否需要进行验证，即 org.mockito.Mockito.verify() 方法。

verify() 说明其作用的例子：

List mockedList = Mockito.mock(List.class);        mockedList.add("one");        mockedList.add("two");        verify(mockedList).add("one");// 如果times不传入，则默认是1        verify(mockedList, times(2)).add(anyString());

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

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

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

这里补充一个学究的问题，所谓 Mock 与 Stub 打桩，其实它们之间不能互为其表。但 Mockito 语境中则。因为它既可以设置方法调用返回值，又可以验证方法的调用。有关 stub 和 mock 的详细论述请见 Martin Fowler 大叔的文章。

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

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

atLeast(N) 至少被调用 N 次

atLeastOnce() 相当于 atLeast(1)

atMost(N) 最多被调用 N 次

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

Map mockedMap = Mockito.mock(Map.class);        mockedMap.put("", "");        String newValue = "newValue";        String oldValue = "oldValue";        //若方法中的某一个参数使用了matcher，则所有的参数都必须使用 matcher.        // 否则会报异常：org.mockito.exceptions.misusing.InvalidUseOfMatchersException:        // When using matchers, all arguments have to be provided by matchers.        when(mockedMap.put(anyInt(), eq(newValue))).thenReturn(oldValue);//mock a put operation        Object oldValueForPut = mockedMap.put(1, newValue);//get the mock value        assertThat(oldValueForPut.toString(), is(oldValue));//assert the mock operation        verify(mockedMap).put(anyInt(), eq(newValue));//verify  whether the mock operation execute or not        mockedMap.put(1, "hello");        verify(mockedMap).put(anyInt(), eq("hello"));

其他高级用法，详见，主要特性如下，

参数验证，详见

超时验证，通过 timeout，并制定毫秒数验证超时。注意，如果被调用多次，times 还是需要的。

方法调用顺序通过 InOrder 对象，验证方法的执行顺序，如上例子中，如果 mock 的 get(0) 和 get(1) 方法反过来则测试不通过。这里 mock2 其实没有被调用过。所以不需要些。

verifyNoMoreInteractions 查询是否存在被调用，但未被验证的方法，如果存在则抛出异常。这里因为验证了get(anyInt())，相当于所有的 get 方法被验证，所以通过。

verifyZeroInteractions 查询对象是否未产生交互，如果传入的 mock 对象的方法被调用过，则抛出异常。这里 mock2 的方法没有被调用过，所有通过。

参见：

看mockito的api时，一直都不清楚veriry()这个方法的作用，因为如果我mock了某个方法，肯定是为了调用的啊。直到今天在回归接口测试用例的时候，发现有两个用例，用例2比用例1多了一个 mock 的步骤，不过最后的结果输出是一样的。由于代码做了修改，我重新 mock 后，其实用例2中对于的步骤是不会执行的，可测试还是通过了。仔细查看后，发现mock的方法没有被调用，所以用例2和用例1就变成一样的了。于是，就产生了这么个需求：单单通过结果来判断正确与否还是不够的，我还要判断是否按我指定的路径执行的用例。到这里，终于领略到了mockito的verify的强大威力，以下是示例代码：

若调用成功，则程序正常运行，反之则会报告： Wanted but not invoked:verify(mockedList).add("one"); 错误。

感觉 verify 会用的比较少。