Mockito和PowerMock用法
在单元测试中，我们往往想去独立地去测一个类中的某个方法，但是这个类可不是独立的，它会去调用一些其它类的方法和service，这也就导致了以下两个问题：外部服务可能无法在单元测试的环境中正常工作，因为它们可能需要访问数据库或者使用一些其它的外部系统。我们的测试关注点在于这个类的实现上，外部类的一些行为可能会影响到我们对本类的测试，那也就失去了我们进行单测的意义
一、mock测试和Mock对象
mock对象就是在调试期间用来作为真实对象的替代品 mock测试就是在测试过程中，对那些不容易构建的对象用一个虚拟对象来代替测试的方法就叫mock测试
二、Mockito和PowerMock
PowerMock是Java开发中的一种Mock框架，用于单元模块测试。当你想要测试一个service接口，但service需要经过防火墙访问，防火墙不能为你打开或者你需要认证才能访问。遇到这样情况时，你可以在你能访问的地方使用MockService替代，模拟实现获取数据。 PowerMock可以实现完成对private/static/final方法的Mock（模拟），而Mockito可以对普通的方法进行Mock，如：public等。
三、Mockito的使用
Maven依赖
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.0.111-beta</version>
</dependency>
创建Mock对象
@Test public void createMockObject() { // 使用 mock 静态方法创建 Mock 对象. List mockedList = mock(List.class); Assert.assertTrue(mockedList instanceof List); // mock 方法不仅可以 Mock 接口类, 还可以 Mock 具体的类型. ArrayList mockedArrayList = mock(ArrayList.class); Assert.assertTrue(mockedArrayList instanceof List); Assert.assertTrue(mockedArrayList instanceof ArrayList); }
我们有了一个 Mock 对象后, 我们可以定制它的具体的行为。
@Test public void configMockObject() { List mockedList = mock(List.class); // 我们定制了当调用 mockedList.add("one") 时, 返回 true when(mockedList.add("one")).thenReturn(true); // 当调用 mockedList.size() 时, 返回 1 when(mockedList.size()).thenReturn(1); Assert.assertTrue(mockedList.add("one")); // 因为我们没有定制 add("two"), 因此返回默认值, 即 false. Assert.assertFalse(mockedList.add("two")); Assert.assertEquals(mockedList.size(), 1); Iterator i = mock(Iterator.class); when(i.next()).thenReturn("Hello,").thenReturn("Mockito!"); String result = i.next() + " " + i.next(); //assert Assert.assertEquals("Hello, Mockito!", result); }
我们使用 when(...).thenReturn(...) 方法链来定义一个行为, 例如 "when(mockedList.add("one")).thenReturn(true)" 表示: 当调用了mockedList.add("one"), 那么返回 true.. 并且要注意的是, when(...).thenReturn(...) 方法链不仅仅要匹配方法的调用, 而且要方法的参数一样才行.
而且有趣的是, when(...).thenReturn(...) 方法链可以指定多个返回值, 当这样做后, 如果多次调用指定的方法, 那么这个方法会依次返回这些值. 例如 "when(i.next()).thenReturn("Hello,").thenReturn("Mockito!");", 这句代码表示: 第一次调用 i.next() 时返回 "Hello,", 第二次调用 i.next() 时返回 "Mockito!"。
抛出异常
@Test(expected = NoSuchElementException.class) public void testForIOException() throws Exception { Iterator i = mock(Iterator.class); when(i.next()).thenReturn("Hello,").thenReturn("Mockito!"); // 1 String result = i.next() + " " + i.next(); // 2 Assert.assertEquals("Hello, Mockito!", result); doThrow(new NoSuchElementException()).when(i).next(); // 3 i.next(); // 4 }
doThrow(ExceptionX).when(x).methodCall, 它的含义是: 当调用了 x.methodCall 方法后, 抛出异常 ExceptionX.
因此 doThrow(new NoSuchElementException()).when(i).next() 的含义就是: 当第三次调用 i.next() 后, 抛出异常 NoSuchElementException.(因为 i 这个迭代器只有两个元素)
校验 Mock 对象的方法调用
@Test public void testVerify() { List mockedList = mock(List.class); mockedList.add("one"); mockedList.add("two"); mockedList.add("three times"); mockedList.add("three times"); mockedList.add("three times"); when(mockedList.size()).thenReturn(5); Assert.assertEquals(mockedList.size(), 5); verify(mockedList, atLeastOnce()).add("one"); verify(mockedList, times(1)).add("two"); verify(mockedList, times(3)).add("three times"); verify(mockedList, never()).isEmpty(); }
-
第一句校验 mockedList.add("one") 至少被调用了 1 次(atLeastOnce)
-
第二句校验 mockedList.add("two") 被调用了 1 次(times(1))
-
第三句校验 mockedList.add("three times") 被调用了 3 次(times(3))
第四句校验 mockedList.isEmpty() 从未被调用(never)
使用 spy() 部分模拟对象
@Test public void testSpy() { List list = new LinkedList(); List spy = spy(list); // 对 spy.size() 进行定制. when(spy.size()).thenReturn(100); spy.add("one"); spy.add("two"); // 因为我们没有对 get(0), get(1) 方法进行定制, // 因此这些调用其实是调用的真实对象的方法. Assert.assertEquals(spy.get(0), "one"); Assert.assertEquals(spy.get(1), "two"); Assert.assertEquals(spy.size(), 100); }
这个例子中我们实例化了一个 LinkedList 对象, 然后使用 spy() 方法对 list 对象进行部分模拟. 接着我们使用 when(...).thenReturn(...) 方法链来规定 spy.size() 方法返回值是 100. 随后我们给 spy 添加了两个元素, 然后再 调用 spy.get(0) 获取第一个元素.
这里有意思的地方是: 因为我们没有定制 add("one"), add("two"), get(0), get(1), 因此通过 spy 调用这些方法时, 实际上是委派给 list 对象来调用的.
然而我们 定义了 spy.size() 的返回值, 因此当调用 spy.size() 时, 返回 100.
参数捕获
@Test public void testCaptureArgument() { List<String> list = Arrays.asList("1", "2");
// 创建一个Mockito的mock对象 List mockedList = mock(List.class);
// 创建一个ArgumentCaptor，用于捕获List类型的参数 ArgumentCaptor<List> argument = ArgumentCaptor.forClass(List.class);
// 调用需要测试的方法 mockedList.addAll(list);
// 验证方法是否被正确调用，并捕获传递的参数 verify(mockedList).addAll(argument.capture());
// 对传递的参数进行断言，判断是否符合预期 Assert.assertEquals(2, argument.getValue().size()); Assert.assertEquals(list, argument.getValue()); }
ArgumentCaptor是Mockito中的一个工具，用于捕获方法调用时传递的参数。
在上述代码中，我们首先使用Mockito创建了一个mock对象。然后，我们调用需要测试的方法，并传递mockedList作为参数。接下来，我们创建了一个ArgumentCaptor对象，并指定它用于捕获List类型的参数。我们使用verify方法来验证方法是否被正确调用，并使用ArgumentCaptor来捕获传递的参数。最后，我们使用assertEquals方法来断言捕获的参数是否符合预期。
四、PowerMock使用
Maven引入
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-core</artifactId>
<version>2.0.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-module-junit4</artifactId>
<version>2.0.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-api-mockito2</artifactId>
<version>2.0.2</version>
<scope>test</scope>
</dependency>
重要注解说明
@RunWith(PowerMockRunner.class) // 告诉JUnit使用PowerMockRunner进行测试 /** * 需要使用此注解声明的类通常是需要进行字节码操作的类。 * 这包括final类，带有final，private，static或本地方法的类，这些方法应该被mock，并且类应该在实例化时返回一个模拟对象。 * 请注意当前你在测试的类不能列在这个注解里，要不然jacoco不会计算当前类的单测覆盖率, 认为没有单测覆盖。 */ @PrepareForTest({RandomUtil.class}) @PowerMockIgnore("") //用于忽略特定的类或包在单元测试中的初始化。这对于那些不应该被 mock 的类很有用，因为它们可能对单元测试产生影响。
模拟接口返回
InterfaceToMock mock = Powermockito.mock(InterfaceToMock.class) Powermockito.when(mock.method(Params…)).thenReturn(value) Powermockito.when(mock.method(Params..)).thenThrow(Exception)
设置对象的private属性
Whitebox.setInternalState(Object object, String fieldname, Object… value);
测试private方法
Whitebox.invokeMethod(Object object, String methodname, Object… value);
模拟构造函数
@RunWith(PowerMockRunner.class) @PrepareForTest({ InstanceClass.class }) @PowerMockIgnore("javax.management.\*")
Powermockito.whenNew(InstanceClass.class).thenReturn(Object value)
对于模拟构造函数，也即当出现new InstanceClass()时可以将此构造函数拦截并替换结果为我们需要的mock对象。不过要注意写法
模拟静态方法
@RunWith(PowerMockRunner.class) @PrepareForTest({ StaticClassToMock.class }) @PowerMockIgnore("javax.management.\*") Powermockito.mockStatic(StaticClassToMock.class); Powermockito.when(StaticClassToMock.method(Object.. params)).thenReturn(Object value)
模拟final方法
@RunWith(PowerMockRunner.class) @PrepareForTest({ FinalClassToMock.class }) @PowerMockIgnore("javax.management.\*") Powermockito.mockStatic(FinalClassToMock.class); Powermockito.when(StaticClassToMock.method(Object.. params)).thenReturn(Object value)
使用spy方法避免执行测试类中的成员函数
如：TargetClass，想要屏蔽的方法为targetMethod.
(1) PowerMockito.spy(TargetClass.class); (2) Powemockito.when(TargetClass.targetMethod()).doReturn() (3) 注意加入 @RunWith(PowerMockRunner.class) @PrepareForTest(DisplayMoRelationBuilder.class) @PowerMockIgnore("javax.management.*")
参数匹配器
