PowerMock 单元测试总结与常见坑解决方案
PowerMock 单元测试总结与常见坑解决方案
官方文档: PowerMock GitHub
PowerMock 在单元测试中能够帮助我们解决静态类、final 方法、私有方法等无法轻易 mock 的问题。下面是我在实际使用 PowerMock 时踩过的一些坑，并结合 PowerMock 的一些方法进行总结。
基本依赖和设置
- 在 Maven 中添加 PowerMock 依赖。
- 在测试类中使用
@RunWith(PowerMockRunner.class)注解。
@RunWith(PowerMockRunner.class)
@PrepareForTest({ClassToMock.class})
public class TestClass {
// 测试代码
}
当你需要 mock 静态方法、final 方法或私有方法时，必须使用 @PrepareForTest 注解，并将需要 mock 的类传入其中。
第一类坑: 静态方法的调用
问题描述: 待测的类中某方法调用了其他类的静态方法。
解决方案: 使用 mockStatic() 方法。
示例代码：
@RunWith(PowerMockRunner.class)
@PrepareForTest(Astatic.class)
public class ATest {
@Test
public void testMethod() {
mockStatic(Astatic.class);
Astatic astatic = mock(Astatic.class);
when(Astatic.staticMethod()).thenReturn(expectedValue);
// 测试逻辑
}
}
第二类坑: 类的初始化包含静态方法
问题描述: 待测的类在初始化时依赖于其他类的静态方法，或者包含一些复杂对象初始化。
解决方案:
- 使用
@PrepareForTest和@PowerMockIgnore注解。 - 避免使用注入的形式来创建测试类，手动实例化并使用
ReflectionTestUtils.setField()为类的成员赋值。
示例代码：
@RunWith(PowerMockRunner.class)
@PrepareForTest({XXUtil.class, OkHttpClient.class})
@PowerMockIgnore({ "javax.xml.*", "javax.management.*", "com.sun.org.apache.xerces.*", "javax.net.ssl.*" })
public class ATest {
@Test
public void testMethod() {
A a = new A();
ReflectionTestUtils.setField(a, "str", "abc");
// 测试逻辑
}
}
注意: 如果类初始化中的构造函数是私有的，需要使用 suppress(constructor(XXUtil.class)) 来抑制它。
第三类坑: Static 块调用私有静态方法
问题描述: 我们希望 mock 的类包含静态块，并且静态块中调用了私有静态方法。
解决方案: 使用 @SuppressStaticInitializationFor 注解来抑制静态块的执行。
示例代码：
@RunWith(PowerMockRunner.class)
@SuppressStaticInitializationFor("com.example.StaticClass")
@PrepareForTest({StaticClass.class})
public class StaticClassTest {
@Test
public void testMethod() {
// 测试逻辑
}
}
注意: @SuppressStaticInitializationFor 不能用于测试类本身，否则会导致单元测试覆盖率为 0。
第四类坑: 静态类或含静态方法的测试
问题描述: 需要测试的类本身是静态类，或者其中包含静态方法。
解决方案: 对所有依赖的方法进行逐层 mock，建议将依赖的类方法抽象出来。
示例代码：
private void mockXXXBuilder(String S) {
XXX.Builder xxxBuilderMock = mock(XXX.Builder.class);
when(xxxBuilderMock.build()).thenReturn(xxxBuilderMock);
when(xxxBuilderMock.name(anyString())).thenReturn(xxxBuilderMock);
when(XXX.builder()).thenReturn(xxxBuilderMock);
when(xxxBuilderMock.create(anyString())).thenReturn(xxxBuilderMock);
}
静态类的 mock:
mockStatic(XXXUtil.class);
String str = mock(String.class);
when(String.format(any(), any(), any())).thenReturn(str);
或者：
PowerMockito.mockStatic(String.class);
when(String.format(any(), any(), any())).thenReturn("abcdefg");
PowerMock 常见方法总结
- mockStatic(Class.class): 用于 mock 静态方法。
- suppress(constructor(Class.class)): 抑制某个类的构造函数。
- suppress(method(Class.class, “methodName”)): 禁止某个类的方法执行。
- suppress(field(Class.class, “fieldName”)): 禁止某个类的字段初始化。
- ReflectionTestUtils.setField(): 使用反射设置类的私有成员变量。
- @SuppressStaticInitializationFor: 禁止静态初始化块的执行。
总结
当遇到复杂的类结构，PowerMock 提供了丰富的工具来帮助我们绕过不必要的依赖并聚焦于类本身的测试逻辑。通过组合使用 mockStatic、suppress 以及 ReflectionTestUtils 等方法，可以有效解决静态方法、final 方法、私有方法等难以测试的场景。
合理地使用 @PrepareForTest 和 @PowerMockIgnore 注解，能够帮助我们避免常见的类加载和初始化错误，从而编写更健壮的单元测试代码。