Mockito 3.4.0 开始可 Mock 静态方法

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,能拿来用就行。

引入 mockito-inline 依赖

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

换成

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

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

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

测试 Mock 静态方法

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

测试 UtilsTest

测试通过,当前日期是 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) 则会报错,像下面的代码

运行后报错

org.mockito.exceptions.misusing.UnfinishedStubbingException:
Unfinished stubbing detected here:
-> at yanbin.blog.UtilsTest.testGetCurrentDate(UtilsTest.java:21)
E.g. thenReturn() may be missing.
Examples of correct stubbing:
    when(mock.isOk()).thenReturn(true);
    when(mock.isOk()).thenThrow(exception);
    doThrow(exception).when(mock).someVoidMethod();
Hints:
  1. missing thenReturn()
  2. you are trying to stub a final method, which is not supported
  3. you are stubbing the behaviour of another mock inside before 'thenReturn' instruction is completed

    at java.time.LocalDate.of(LocalDate.java:266)
    at yanbin.blog.UtilsTest.testGetCurrentDate(UtilsTest.java:21)
    ............

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

Mock 带参数的静态方法

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

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

先改造一下  Utils 类,为

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

其实前面无参静态方法也可以把方法引用替代为一个 Lambda 表达式

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.MemberAccessormember-accessor-module 增强了 Mockito 的其他特性,初步猜测是可用来替换测试类的内部成员属性值,新任务又来了。

Mockito Mock 静态方法的弊端

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

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

输出为

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

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

链接:

  1. How to mock static methods with Mockito

类别: Java/JEE. 标签: , . 阅读(2,430). 订阅评论. TrackBack.
guest
2 Comments
Inline Feedbacks
View all comments
Lucas
Lucas
3 months ago

你好,我最近也遇到了这个问题,翻到了你的博文,请问一下“要在 classpath 下创建个文件 mockito-extensions/org.mockito.plugins.MockMaker, 内容为 mock-maker-inline” 这个文件具体怎么创建?这个文件是class文件,还是txt文件还是其他?

Yanbin Qiu
3 months ago
Reply to  Lucas

文本文件,像在 Maven 项目中,可以创建在 src/main/resources 目录中。
如果引入的依赖是 mockito-inline 的话就不需要自己创建那个文件

2
0
Would love your thoughts, please comment.x
()
x