Android单元测试之PowerMockito

由于Mockito的局限性，对final、private、static等方法不能mock，那如何对这样的方法进行单元测试呢？我们是不是真的束手无策呢？肯定不是的啦，今天我们一起来学习PowerMockito测试框架，又是如何完美的弥补Mockito测试框架的不足呢。

PowerMock是一个扩展了其它如EasyMock等mock框架的、功能更加强大的框架。PowerMock使用一个自定义类加载器和字节码操作来模拟静态方法，构造函数，final类和方法，私有方法，去除静态初始化器等等。通过使用自定义的类加载器，简化采用的IDE或持续集成服务器不需要做任何改变。熟悉PowerMock支持的mock框架的开发人员会发现PowerMock很容易使用，因为对于静态方法和构造器来说，整个的期望API是一样的。PowerMock旨在用少量的方法和注解扩展现有的API来实现额外的功能。目前PowerMock支持EasyMock和Mockito。

Gradle配置如下：

PowerMock有三个重要的注解：

@RunWith(PowerMockRunner.class)

@PrepareForTest({YourClassWithEgStaticMethod.class})

@PowerMockIgnore("javax.management.*")

如果你的测试用例里没有使用注解@PrepareForTest，那么可以不用加注解@RunWith(PowerMockRunner.class)，反之亦然。当你需要使用PowerMock强大功能（Mock静态、final、私有方法等）的时候，就需要加注解@PrepareForTest。这一点和Mockito的使用方式是类似的，要么使用这种注解的方式

@RunWith(PowerMockRunner.class)

@PrepareForTest({YourClassWithEgStaticMethod.class})

要么使用注解加代码的方式

@PrepareForTest({YourClassWithEgStaticMethod.class})

MockitoAnnotations.initMocks(this);

其中@PrepareForTest注解是声明需要进行mock的静态类，如果你需要声明多个静态类，使用

@PrepareForTest({Example1.class, Example2.class, ...})这种方式声明。

最后就是@PowerMockIgnore注解，声明package路径，表示不使用PowerMockito来加载所声明的package路径的类。

测试目标代码：

注意到了么有，普通Mock不需要加@RunWith和@PrepareForTest注解，在这种情况下，使用Mockito也是可以实现的。上述步骤如下：

通过PowerMockito.mock(File.class)创建出一个mock对象

然后再通过PowerMockito.when(file.exists()).thenReturn(true);来指定这个mock对象具体的行为

再将mock对象作为参数传递个测试方法，执行测试方法。

测试目标代码：

测试用例代码：

当使用PowerMockito.whenNew().thenReturn()方法时，必须加上注解@PrepareForTest和@RunWith，注解@PrepareForTest里写的类是需要mock的new对象代码所在的类。需要mock的对象是在方法内部new出来的，这是一种比较常见的mock方式。 步骤（已经讲过的步骤省略）：

通过PowerMockito.whenNew(File.class).withArguments("aaa").thenReturn(file);来指定当以参数为"aaa"创建File对象的时候，返回已经mock的File对象。

在测试方法之上加注解@PrepareForTest(CommonExample.class)，注解里写的类是需要mock的new对象代码所在的类。

测试目标代码：

测试用例代码：

Mock的步骤和之前的一样，只是需要在测试方法之上加注解@PrepareForTest(ClassDependency.class)，注解里写的类是需要mock的final方法所在的类。

测试目标代码：

测试用例代码：

当需要mock静态方法的时候，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是静态方法所在的类。

测试目标方法：

测试用例代码：

和Mock普通方法一样，只是需要加注解@PrepareForTest(CommonExample.class)，注解里写的类是私有方法所在的类。

目标测试方法：

public class CommonExample {

    public String callSystemStaticMethod(String str) {

        return System.getProperty(str);

    }

}

测试用例代码：

public class CommonExampleTest extends BasePowerMockTestCase {

    @Test

    @PrepareForTest(CommonExample.class)

    public void callSystemStaticMethod() {

        CommonExample commonExample = new CommonExample();

        PowerMockito.mockStatic(System.class);

        PowerMockito.when(System.getProperty("aaa")).thenReturn("bbb");

        Assert.assertEquals("bbb", commonExample.callSystemStaticMethod("aaa"));

    }

}

和Mock普通对象的静态方法、final方法一样，只不过注解@PrepareForTest里写的类不一样 ，注解里写的类是需要调用系统方法所在的类。

测试目标方法：

public class PowerMockSample {

    private static final int STATE_NOT_READY = 0;

    private static final int STATE_READY = 1;

    private int mState = STATE_NOT_READY;

    public boolean doSomethingIfStateReady() {

        if (mState == STATE_READY) {

            // DO some thing

            return true;

        } else {

            return false;

        }

    }

}

测试用例代码：

public class PowerMockSampleTest extends BasePowerMockTestCase {

    @Test

    public void testDoSomethingIfStateReady() throws Exception {

        PowerMockSample sample = new PowerMockSample();

        Whitebox.setInternalState(sample, "mState", 1);

        assertThat(sample.doSomethingIfStateReady()).isTrue();

    }

}

当需要mock私有变量mState的时候，不需要加注解@PrepareForTest和@RunWith，而是使用Whitebox来mock私有变量mState并注入你预设的变量值。

上面介绍了PowerMockito的简单使用，对static方法、构造方法、private方法以及final方法的mock支持，专治Mockito各种不服。不过还有其他的API没有介绍，感兴趣的同学可以参考PowerMockito官方wiki。

我们看一下PowerMockito的依赖：

Paste_Image.png

可以看出来，它有两个重要的依赖：javassist和objenesis，javassist是一个修改java字节码的工具包，objenesis是一个绕过构造方法来实例化一个对象的工具包。由此看来，PowerMock的本质是通过修改字节码来实现对静态和final等方法的mock的。

我们结合上面的例子来介绍：

testCallPrivateMethod()被注解@PrepareForTest(CommonExample.class)标注以后，在运行时，会创建一个org.powermock.core.classloader.MockClassLoader对象来加载该测试用例使用到的类（系统类除外）。

PowerMockito会根据你的mock要求，去修改写在注解@PrepareForTest里的class文件（当前测试类会自动加入注解中），以满足特殊的mock需求。例如：去除final方法的final标识，在静态方法的最前面加入自己的虚拟实现等。

如果mock的是系统类的final方法和静态方法，PowerMockito不会直接修改系统类的class文件，而是修改调用系统类的class文件，以满足mock需求

1.使用PowerMockito会提示classloader错误

加入注解：@PowerMockIgnore(YourPackagePath.*)来解决由于MockClassLoader造成的class加载错误，通过这个注解可以让报错的类使用系统的ClassLoader来加载报错类。如下：

setUp now

java.security.NoSuchAlgorithmException: class configured for SSLContext: sun.security.ssl.SSLContextImpl$TLSContext not a SSLContext

    at sun.security.jca.GetInstance.checkSuperClass(GetInstance.java:260)

    at sun.security.jca.GetInstance.getInstance(GetInstance.java:237)

    at sun.security.jca.GetInstance.getInstance(GetInstance.java:164)

    at javax.net.ssl.SSLContext.getInstance(SSLContext.java:156)

    at me.ele.shopcenter.network.request.CustomClient.getSslSocketFactory(CustomClient.java:124)

这种就是ClassLoader造成的SSLContext对象不一致的问题，只要加载注解@PowerMockIgnore({"sun.security.*", "javax.net.*"})就可以解决。

2.PowerMockito 和Mockito mock出来的对象不能相互使用，否则会抛出异常

小伙伴们，感受到PowerMockito的强大了吧。根据实践发现，推荐使用JUnit4+Mockito+PowerMockito测试工具，在Java单元测试中可以说是无所不能。