1. 概述
长期以来,借助模拟框架进行单元测试一直被认为是一种有用的实践,尤其是Mockito框架近年来主导了这个市场。
为了促进良好的代码设计并使公共 API 简单,一些所需的功能已被有意省略。然而,在某些情况下,这些缺点迫使测试人员编写繁琐的代码,只是为了使模拟的创建变得可行。
这就是PowerMock框架发挥作用的地方。
PowerMockito 是PowerMock的扩展API,用于支持Mockito。它提供了以简单的方式使用 Java Reflection API 的功能,以克服 Mockito 的问题,例如缺乏模拟最终、静态或私有方法的能力。
本教程将介绍 PowerMockito API 并看看它如何在测试中应用。
2. 准备使用 PowerMockito 进行测试
集成 PowerMock 对 Mockito 的支持的第一步是在 Maven POM 文件中包含以下两个依赖项:
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-module-junit4</artifactId>
<version>1.6.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-api-mockito</artifactId>
<version>1.6.4</version>
<scope>test</scope>
</dependency>
接下来,我们需要通过应用以下两个注释来准备使用 PowerMockito 的 测试用例:
@RunWith(PowerMockRunner.class)
@PrepareForTest(fullyQualifiedNames = "com.baeldung.powermockito.introduction.*")
@PrepareForTest 注释中的 fullQualifiedNames 元素表示我们要模拟的类型的完全限定名称的数组。在本例中,我们使用带有通配符的包名称来告诉 PowerMockito 准备 com.baeldung.powermockito.introduction 包中的所有类型以进行模拟。
现在我们准备好利用 PowerMockito 的强大功能了。
3. 模拟构造函数和最终方法
在本节中,我们将演示在使用 new 运算符实例化类时获取模拟实例而不是真实实例的方法,然后使用该对象来模拟最终方法。
以下是我们定义协作类的方式,其构造函数和最终方法将被模拟:
public class CollaboratorWithFinalMethods {
public final String helloMethod() {
return "Hello World!";
}
}
首先,我们使用 PowerMockito API 创建一个模拟对象:
CollaboratorWithFinalMethods mock = mock(CollaboratorWithFinalMethods.class);
接下来,我们设置一个期望,即每当调用该类的无参数构造函数时,都应该返回一个模拟实例而不是真实的实例:
whenNew(CollaboratorWithFinalMethods.class).withNoArguments().thenReturn(mock);
让我们通过使用其默认构造函数实例化 CollaboratorWithFinalMethods 类来看看此构造模拟如何实际工作,然后我们将验证 PowerMock 的行为:
CollaboratorWithFinalMethods collaborator = new CollaboratorWithFinalMethods();
verifyNew(CollaboratorWithFinalMethods.class).withNoArguments();
在下一步中,对最终方法设置期望:
when(collaborator.helloMethod()).thenReturn("Hello Baeldung!");
然后执行该方法:
String welcome = collaborator.helloMethod();
以下断言确认已在 协作者 对象上调用 helloMethod 方法并返回模拟期望设置的值:
Mockito.verify(collaborator).helloMethod();
assertEquals("Hello Baeldung!", welcome);
如果我们想要模拟特定的最终方法而不是对象内的所有最终方法,则 Mockito.spy(T object) 方法可能会派上用场。第 5 节对此进行了说明。
4. 模拟静态方法
假设我们想要模拟名为 CollaboratorWithStaticMethods 的类的静态方法。
以下是我们声明此类的方式:
public class CollaboratorWithStaticMethods {
public static String firstMethod(String name) {
return "Hello " + name + " !";
}
public static String secondMethod() {
return "Hello no one!";
}
public static String thirdMethod() {
return "Hello no one again!";
}
}
为了模拟这些静态方法,我们需要使用 PowerMockito API 注册封闭类:
mockStatic(CollaboratorWithStaticMethods.class);
或者,我们可以使用 Mockito.spy(Class class) 方法来模拟特定的方法,如下一节所示。
接下来,可以设置期望来定义方法在调用时应返回的值:
when(CollaboratorWithStaticMethods.firstMethod(Mockito.anyString()))
.thenReturn("Hello Baeldung!");
when(CollaboratorWithStaticMethods.secondMethod()).thenReturn("Nothing special");
或者可以设置在调用 thirdMethod 方法时抛出异常:
doThrow(new RuntimeException()).when(CollaboratorWithStaticMethods.class);
CollaboratorWithStaticMethods.thirdMethod();
现在是时候运行前两个方法了:
String firstWelcome = CollaboratorWithStaticMethods.firstMethod("Whoever");
String secondWelcome = CollaboratorWithStaticMethods.firstMethod("Whatever");
上述调用不是调用真实类的成员,而是委托给模拟的方法。
这些断言证明模拟已经生效:
assertEquals("Hello Baeldung!", firstWelcome);
assertEquals("Hello Baeldung!", secondWelcome);
我们还能够验证模拟方法的行为,包括调用方法的次数。
在这种情况下, firstMethod 已被调用两次,而 secondMethod 从未被调用:
verifyStatic(Mockito.times(2));
CollaboratorWithStaticMethods.firstMethod(Mockito.anyString());
verifyStatic(Mockito.never());
CollaboratorWithStaticMethods.secondMethod();
注意: 必须在任何静态方法验证之前调用 verifyStatic 方法,以便 PowerMockito 知道后续的方法调用是需要验证的。
最后,静态 ThirdMethod 方法应该抛出 RuntimeException ,如之前在模拟中声明的那样。
它通过 @Test 注释的 预期 元素进行验证:
@Test(expected = RuntimeException.class)
public void givenStaticMethods_whenUsingPowerMockito_thenCorrect() {
// other methods
CollaboratorWithStaticMethods.thirdMethod();
}
5. 部分模拟
PowerMockito API 允许使用 间谍 方法模拟部分类,而不是模拟整个类。
此类将用作协作者来说明 PowerMock 对部分模拟的支持:
public class CollaboratorForPartialMocking {
public static String staticMethod() {
return "Hello Baeldung!";
}
public final String finalMethod() {
return "Hello Baeldung!";
}
private String privateMethod() {
return "Hello Baeldung!";
}
public String privateMethodCaller() {
return privateMethod() + " Welcome to the Java world.";
}
}
让我们从模拟一个静态方法开始,该方法在上面的类定义中被命名为 staticMethod 。
首先,我们使用 PowerMockito API 部分模拟 CollaboratorForPartialMocking 类并为其静态方法设置期望:
spy(CollaboratorForPartialMocking.class);
when(CollaboratorForPartialMocking.staticMethod()).thenReturn("I am a static mock method.");
然后执行静态方法:
returnValue = CollaboratorForPartialMocking.staticMethod();
模拟行为已验证:
verifyStatic();
CollaboratorForPartialMocking.staticMethod();
以下断言通过将返回值与期望值进行比较来确认模拟方法实际上已被调用:
assertEquals("I am a static mock method.", returnValue);
现在是时候转向最终的私有方法了。
为了说明这些方法的部分模拟,我们需要实例化该类并告诉 PowerMockito API 来 监视 它:
CollaboratorForPartialMocking collaborator = new CollaboratorForPartialMocking();
CollaboratorForPartialMocking mock = spy(collaborator);
上面创建的对象用于演示最终方法和私有方法的模拟。
我们现在将通过设置期望并调用该方法来处理最终方法:
when(mock.finalMethod()).thenReturn("I am a final mock method.");
returnValue = mock.finalMethod();
部分模拟该方法的行为已得到证明:
Mockito.verify(mock).finalMethod();
测试验证调用 FinalMethod 方法将返回与期望匹配的值:
assertEquals("I am a final mock method.", returnValue);
类似的过程也适用于私有方法。主要区别在于我们不能直接从测试用例中调用此方法。
基本上,私有方法由同一类中的其他方法调用。在 CollaboratorForPartialMocking 类中, privateMethod 方法由 privateMethodCaller 方法调用,我们将使用后者作为委托。
让我们从期望和调用开始:
when(mock, "privateMethod").thenReturn("I am a private mock method.");
returnValue = mock.privateMethodCaller();
确认了对私有方法的嘲笑:
verifyPrivate(mock).invoke("privateMethod");
以下测试确保私有方法调用的返回值与预期相同:
assertEquals("I am a private mock method. Welcome to the Java world.", returnValue);
六,结论
本文介绍了 PowerMockito API,演示了它如何解决开发人员在使用 Mockito 框架时遇到的一些问题。
这些示例和代码片段的实现可以在链接的 GitHub 项目中找到。