Mockito Mock Static 方法

说明

Java 单元测试最趁手的 Mock 组件当属 Mockito，虽然它最初是基于继承来实现 Mock 的，所以对私有方法，私有属性，静态方法，final 类，final 方法，构造函数无能为力。于是有时不得不引入 JMockit 或 PowerMockit 来辅助。不过现在的 Mockito 功力有所增强。

首先是 Mockito 2.1.0 开始可以 Mock final 类和 final 方法，要在 classpath 下创建个文件 mockito-extensions/org.mockito.plugins.MockMaker, 内容为 mock-maker-inline。之前写过一篇介绍：Mockto 也能 Mock final 类和 final 方法了，其中也探索了它的实现细节，使用到了 ByteBuddy 修改字节码。

从 Mockito 3.4.0 通过类似的 mockto-extensions 扩展的方式，实现了对静态方法的 Mock。所有使用到的接口是 org.mockito.MockedStatic，它当前在 Mockito 3.7.7 中还是一个试验性方法 @Incubating，能拿来用就行。

导入依赖

从3.4.0版开始，Mock静态方法是Mockito的一部分。如果您使用的是Maven，请更新现有的Mockito版本或将以下依赖项包含到pom.xml中：

引入 mockito-inline 依赖

那么来看看 Mockito 是如何 Mock 静态方法，网上的文章一般是说要用 mockito-inline 替换 mockito-core 依赖，也就是要在 pom.xml 中的依赖由通常的

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>3.7.7</version>
    <scope>test</scope>
</dependency>

换成

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-inline</artifactId>
    <version>3.7.7</version>
    <scope>test</scope>
</dependency>

其实可以看出来，mockito-inline包含了mockito-core

那么由 mockito-core 到 mockito-inline 发生了什么呢，看 mockito-inline 的 pom.xml 文件就知道，它其实内部依赖了 mockito-core。使用了 mockito-inline 后效果如下：

实质上 mockito-inline 就是给 mockito-core 添加了两个插件配置，分别是 org.mockito.plugins.MockMaker 和 org.mockito.plugins.MemberAccessor，而前者也是用于 Mock final 类和 final 方法的。至于 Mock 静态方法是由前者还是后者支持的需要进一步研究。

要是不想直接引入 mockito-inline 的话，自己在 classpath 下创建相同的文件及其内容也是可以的。

测试 Mock 静态方法

有了 mockito-inline 接着尝试下用代码如何 Mock 一个静态方法，先创建一个含有静态方法的待测试类 Utils

package yanbin.blog;
 
import java.time.LocalDate;
 
public class Utils {
 
    public LocalDate getCurrentDate() {
        return LocalDate.now();
    }
}

测试 UtilsTest

package yanbin.blog;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;

import java.time.LocalDate;

import static org.junit.Assert.assertEquals;

@RunWith(MockitoJUnitRunner.class)
public class UtilsTest {

    private Utils target = new Utils();

    @Test
    public void testGetCurrentDate() {
        LocalDate yearOf2000 = LocalDate.of(2000, 1, 1);
        try (MockedStatic theMock = Mockito.mockStatic(LocalDate.class)) {
            theMock.when(LocalDate::now).thenReturn(yearOf2000);

            System.out.println(target.getCurrentDate());
            assertEquals(2000, target.getCurrentDate().getYear());
        }
    }
}

测试通过，当前日期是 2021-02-03, 打印的日期是 2000-01-01, 又重回到了 2000 年。

这里我们用到了 Mockito.mockStatic(LocalDate.class) Mock 了 LocalDate 的所有的静态方法，在它 try 块外端调用 LocalDate 的静态方法是可以, 其间不用 theMock.when(LocalDate::now).thenReturn(yearOf2000) 而直接调用 LocalDate 的其他静态方法，如 LocalDate.of(2000, 1, 1) 则会报错，像下面的代码

@Test
public void testGetCurrentDate() {
    try (MockedStatic<LocalDate> theMock = Mockito.mockStatic(LocalDate.class)) {
        theMock.when(LocalDate::now).thenReturn(LocalDate.of(2000, 1, 1));
 
        System.out.println(target.getCurrentDate());
        assertEquals(2000, target.getCurrentDate().getYear());
    }
}

运行后报错

也就是说用 try (MockedStatic theMock = Mockito.mockStatic(LocalDate.class)) { ... } 一旦 Mock 一个类，那么它所有的静态方法都被 Mockito 接管。

Mock 带参数的静态方法

前面 Mock 是不带参数的静态方法，注意到 MockedStatic.when(Verification) 的参数是一个 Verification，它是一个 SAM 接口

interface Verification {
    void apply() throws Throwable;
}

而我们通常用的 Mockito.when(T methodCall) 的参数是一个方法调用的返回值，所以当 Mock 带参数的静态方法时与 Mockito.when(obj.foo(1, 2)).thenReturn(34)) 的用法是不一样的，MockedStatic.when() 的参数需要放一个 () -> LocalDate.of(anyInt(), anyInt(), anyInt()) 这样的 Lambda. 完整例子如下

先改造一下Utils 类，为

package yanbin.blog;
 
import java.time.LocalDate;
 
public class Utils {
 
    public LocalDate getDate(int year, int month, int day) {
        return LocalDate.of(year, month, day);
    }
}

再就是下面的方式 Mock 带参数的静态方法

@RunWith(MockitoJUnitRunner.class)
public class UtilsTest {

    private Utils target = new Utils();

    @Test
    public void testGetCurrentDate() {
        LocalDate yearOf1970 = LocalDate.of(1970, 1, 1);
        try (MockedStatic<LocalDate> theMock = Mockito.mockStatic(LocalDate.class)) {
            theMock.when(() -> LocalDate.of(anyInt(), anyInt(), anyInt())).thenReturn(yearOf1970);

            System.out.println(target.getDate(2000, 2, 28));
            assertEquals(1970, target.getDate(2000, 2, 28).getYear());
            theMock.verify(()->LocalDate.of(anyInt(), anyInt(), anyInt()), times(1));
        }
    }
}

     theMock.when(() -> LocalDate.now()).thenReturn(yearOf1970);

并且注意到上面的第 14 行，对静态方法调用的 verify 也要用 theMock 的 verify() 方法，而不是 Mockito.verify()。

一张图大概看一下它的内部实现: 可以看出也是用的 ByteBuddy

再测试一下是哪个 Mockito 的插件在起作用

我们把依赖从 mockito-inline 恢复到 mockito-core, 然后在 classpath 下自己创建 mockito-extensions/org.mockito.plugins.MockMaker 并内容

     mock-maker-inline

重新运行最前面的 UtilsTest, 测试通过，说明 mock-maker-inline 同时支撑了对 final 类，final 方法和静态方法的 Mock。那就是说明 mockito-extensions/org.mockito.plugins.MemberAccessor 的 member-accessor-module 增强了 Mockito 的其他特性，初步猜测是可用来替换测试类的内部成员属性值。

Mockito Mock 静态方法的弊端

在实际应用 Mockito 对静态方法进行 Mock 的时候，发现在多线程的时候失效，问题在于当用

try (MockedStatic<LocalDate> theMock = Mockito.mockStatic(LocalDate.class)) {
    // 只对当前线程有效
}

只对当前线程对 LocalDate 静态方法的调用有效，看下面的例子就知道

@Test
public void testGetCurrentDate() throws InterruptedException {
    LocalDate yearOf2000 = LocalDate.of(1970, 1, 1);
    try (MockedStatic<LocalDate> theMock = Mockito.mockStatic(LocalDate.class)) {
        theMock.when(LocalDate::now).thenReturn(yearOf2000);
 
        System.out.println(Thread.currentThread().getName() + ":" + LocalDate.now()); //main:1970-01-01
 
        Thread thread = new Thread(() ->
            System.out.println(Thread.currentThread().getName() + ":" + LocalDate.now()) //Thread-0:2021-06-18，对于非当前线程无效
        );
        thread.start();
        thread.join();
 
        System.out.println(Thread.currentThread().getName() + ":" + LocalDate.now()); //main:1970-01-01
    }
    System.out.println(Thread.currentThread().getName() + ":" + LocalDate.now()); //main:2021-06-18, 退出 try block 后当然也失效
}

输出为

main:1970-01-01
Thread-0:2021-06-18
main:1970-01-01
main:2021-06-18

因为这一限制，几乎让 Mockito mock 静态方法这一表现淡然无色，在实际应用代码中线程的使用是非常普遍的。看来偶然间发现的亮点还得放弃掉。

附：Mockito 另一种模拟静态方法的例子

在测试类上添加@ExtendWith(MockitoExtension.class)

具体的测试方法操作如下

 Mockito.mockStatic(AppUserUtil.class);
 when(AppUserUtil.getLoginAppUser()).thenReturn(user);
 
 其中AppUserUtil是工具类，getLoginAppUser是静态方法

另外 Mock静态方法和Mock普通方法可以一起使用，不会有所冲突

92IT

Just love IT.

Mockito Mock Static 方法