转载

Mockito 也能 Mock final 类和 final 方法了

以实际 Java 项目中的单元测试 Mock 框架基本是 Mockito 了，因为它有一个十分流畅的 API。Mockito 也为 JUnit 5 配上了 MockitoExtension, 所以 JUnit 5 下使用 Mockito 的关节也打通了。但在我们享受 Mockito 便利的同时，与 JMockit 相比局限性就很明显，因为 Mockito 是通过创建匿名子类来进行 Mock 的，所以任何子类对父类无法突破的方面它都存在。譬如，final 类, final 方法, 私有方法, 静态方法, 构造函数都是无法通过子类型进行重写的。所以除非特别需要，在 Mockito 无法胜任时都求助于 JMockit，JMockit 借助于 javaagent 取得了 JVM 的高控制权才得已为所欲为。

当 Mockito 来到了 2.1.0 版本，它也觉得不能对以上所有的限制置若罔闻, 首先带给我们的突破是它也可以 Mock final 类和 final 方法，虽然仍处于孵化器中，但毕竟是应用在单元测试中，能用就很不错了，只要以后不被拿走就行。这是官方对它的介绍 Mock the unmockable: opt-in mocking of final classes/methods

下面我亲自操作一遍，并给出更全方位的测试样例

待测试类(final 类与 final 方法的组合)

class NonFinalClassWithFinalMethod {
    final String finalMethod() {
        return "something";
    }
}
 
final class FinalClassWitnNonFinalMethod {
    String nonFinalMethod() {
        return "somthing";
    }
}
 
final class FinalClassWithFinalMethod {
    final String finalMethod() {
        return "something";
    }
}

对 final 修饰符视而不见的 Mock 测试

package cc.unmi;
 
import org.hamcrest.CoreMatchers;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
 
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;
 
@RunWith(MockitoJUnitRunner.class)
public class FinalClassTest {
 
    @Test
    public void testNonFinalClassWithFinalMethod() {
        NonFinalClassWithFinalMethod testMe = Mockito.mock(NonFinalClassWithFinalMethod.class);
        when(testMe.finalMethod()).thenReturn("hello");
        assertThat(testMe.finalMethod(), CoreMatchers.equalTo("hello"));
    }
 
    @Test
    public void testFinalClassWithNonFinalMethod() {
        FinalClassWitnNonFinalMethod testMe = Mockito.mock(FinalClassWitnNonFinalMethod.class);
        when(testMe.nonFinalMethod()).thenReturn("hello");
        assertThat(testMe.nonFinalMethod(), CoreMatchers.equalTo("hello"));
    }
 
    @Test
    public void testFinalClassWithFinalMethod() {
        FinalClassWithFinalMethod testMe = Mockito.mock(FinalClassWithFinalMethod.class);
        when(testMe.finalMethod()).thenReturn("hello");
        assertThat(testMe.finalMethod(), CoreMatchers.equalTo("hello"));
    }
}

如果上面的待测试类没有 final 类和 final 方法，上面三个测试用例都能成功通过。然而基于待测试类存在 final 修饰符的事实，以上测试用例将全部失败，它们的错误信息将分别是

testNonFinalClassWithFinalMethod():

org.mockito.exceptions.misusing.MissingMethodInvocationException:

when() requires an argument which has to be 'a method call on a mock'.

For example:

when(mock.getArticles()).thenReturn(articles);

Also, this error might show up because:

1. you stub either of: final/private/equals()/hashCode() methods.

Those methods *cannot* be stubbed/verified.

Mocking methods declared on non-public parent classes is not supported.

2. inside when() you don't call method on mock but on some other object.

testFinalClassWithNonFinalMethod():

org.mockito.exceptions.base.MockitoException:

Cannot mock/spy class cc.unmi.FinalClassWitnNonFinalMethod

Mockito cannot mock/spy because :

- final class

testFinalClassWithFinalMethod:

org.mockito.exceptions.base.MockitoException:

Cannot mock/spy class cc.unmi.FinalClassWitnNonFinalMethod

Mockito cannot mock/spy because :

- final class

就是说正常情况下 final class, final method 等是不受 Mockito 待见的。

Mockito 也能 Mock final 类和 final 方法了

但是当再加上一个待测试类

class NonFinalClassWithNonFinalMethod {
    String nonFinalMethod() {
        return "something";
    }
}

和测试用例

    @Test
    public void testNonFinalClassWithNonFinalMethod() {
        NonFinalClassWithNonFinalMethod testMe = Mockito.mock(NonFinalClassWithNonFinalMethod.class);
        when(testMe.nonFinalMethod()).thenReturn("hello");
        assertThat(testMe.nonFinalMethod(), CoreMatchers.equalTo("hello"));
    }

四个测试用例一起运行结果又不一样了

Mockito 也能 Mock final 类和 final 方法了

此时单独运行 testNonFinalClassWithFinalMethod 还是提示与之前一样的错误

org.mockito.exceptions.misusing.MissingMethodInvocationException:

when() requires an argument which has to be 'a method call on a mock'.

For example:

when(mock.getArticles()).thenReturn(articles);

Also, this error might show up because:

1. you stub either of: final/private/equals()/hashCode() methods.

Those methods *cannot* be stubbed/verified.

Mocking methods declared on non-public parent classes is not supported.

2. inside when() you don't call method on mock but on some other object.

添加配置文件达成对 final 类 final 方法的 Mock

那么 Mockito 声称能 Mock final 类和 final 方法的角决之道在哪里呢？一个额外的配置文件，对于 Maven 标准布局的项目，创建这个文件

src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker

如果是其他项目的话，应该只需保证在 classpath 下有文件 mockito-extensions/org.mockio.plugins.MockMaker

该文件的内容是

mock-maker-inline

对，它就像是 SPI 模式的类似 META-INF/services/org.junit.platform.engine.TestEngine 文件。

有了 src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker 文件，及内容 mock-maker-inline 后，再次运行上面的测试用例

Mockito 也能 Mock final 类和 final 方法了

全绿，说明 Mockito 能对 final 类和 final 方法进行 Mock 了。这已经是 Mockito 的一大进步，先别对 private, static 有所奢欲。

MockMaker 让 Mockito 发生了什么

我们可以通过以下几张图来了解在 src/test/resources/mockio-extensions/org.mockito.plugin.MockMaker ( mock-maker-inline ) 前后发生了什么

前前，考查 Mock 的对象

Mockito 也能 Mock final 类和 final 方法了

Mock 非 final 类创建子类

Mockito 也能 Mock final 类和 final 方法了不能 Mock final 类

后后，再次考查 Mock 的对象

Mockito 也能 Mock final 类和 final 方法了

终于 final 类也可以 Mock 了, 不能生成子类，像是直接生成它的实例，也无可非

Mockito 也能 Mock final 类和 final 方法了

可是对于非 final 类型也不再生成子类了，和 mock final 类一样的行为了

基于 Mockito.mock(clazz) 直接创建实例这一事实，原理上我们可以使用 Mockito 来 Mock 构造函数的。

前前后后，针对接口和抽象类

Mockito 也能 Mock final 类和 final 方法了为抽象类创建子类型为接口也是创建子类型

对于接口和抽象类的 Mock 行为始终没变，总是必须创建它们的子类型。

原文 https://unmi.cc/mockito-mock-final-class-final-method/

正文到此结束

所属分类： Java 编程技术

本文标签： UI core javaagent classpath 配置 src id 测试 cat example MQ java tar final IO REST plugin 实例 ORM 静态方法突破 API Service JVM https IDE http equals maven
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

Mockito 也能 Mock final 类和 final 方法了

待测试类(final 类与 final 方法的组合)

对 final 修饰符视而不见的 Mock 测试

testNonFinalClassWithFinalMethod():

testFinalClassWithNonFinalMethod():

testFinalClassWithFinalMethod:

添加配置文件达成对 final 类 final 方法的 Mock

MockMaker 让 Mockito 发生了什么

前前，考查 Mock 的对象

后后，再次考查 Mock 的对象

前前后后，针对接口和抽象类

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流