Java单元测试之 TestableMock

之前写过几篇关于Java单元测试的文章，最近注意到了阿里开源了自家的 Mock 工具：TestableMock

该工具号称最轻量、简单、舒适的 Mock 测试工具，功能十分强大，媲美 PowerMock，用法比 Mockito 还要简洁，还不挑框架，指哪换哪，一个 @MockMethod 注解打天下。

“让Java没有难测的方法”。

TestableMock 简介

开源地址：https://github.com/alibaba/testable-mock
用户手册：https://alibaba.github.io/testable-mock

TestableMock 在 2020 年 12 月开始开源，出自阿里云云效团队，主要想解决 Java 开发者在日常单元测试中经常遇到的痛点：

• 外部依赖Mock繁琐
• 私有方法难测试
• 无返回值方法难测试
• 复杂参数难构造

它所承载的职责是 “让Java没有难测的方法”，换种思路写Mock，让单元测试更简单，这也是 TestableMock 名字的来历。

无需初始化，不挑测试框架，甭管要换的是私有方法、静态方法、构造方法还是其他任何类的任何方法，也甭管要换的对象是怎么创建的。

写好 Mock 定义，加个 @MockMethod 注解，一切统统搞定。

主流Mock工具对比

在 TestableMock 开源之前，目前市面上主流的 Mock 工具主要有：

• Mockito
• Spock
• PowerMock
• JMockit
• EasyMock
• ....

Mockito 应该是目前使用最多的 Mock 工具了，因为它使用足够简单，在 IntelliJ IDEA 和 Eclipse 开发工具上也都有专用的插件支持，但 Mock 功能相对来说还是较弱，不能覆盖所有应用场景。因为其使用的是动态代理技术，我们都知道，动态代理只能在方法前后环绕，有一定的局限性，所以 final 类型、静态方法、私有方法全都无法覆盖到。

上面所列的主流的 Mock 工具也只有 PowerMock 在功能上能够与 TestableMock 持平，但 PowerMock 使用较为复杂，而且由于使用的是自定义类加载器技术，所以也还会存在一定的使用问题。

TestableMock 和 JMockit 底层一致，使用的是 "运行时字节码修改" 技术，在单元测试启动时就扫描测试类和被测类的字节码，完成 Mock 方法的替换。

上手 TestableMock

Maven依赖

在项目pom.xml文件中，增加testable-all依赖和maven-surefire-plugin配置，具体方法如下。

建议先添加一个标识TestableMock版本的property，便于统一管理：

<properties>
    <testable.version>0.5.0</testable.version>
</properties>

在dependencies列表添加TestableMock依赖：

<dependencies>
    <dependency>
        <groupId>com.alibaba.testable</groupId>
        <artifactId>testable-all</artifactId>
        <version>${testable.version}</version>
        <scope>test</scope>
    </dependency>
</dependencies>

最后在build区域的plugins列表里添加maven-surefire-plugin插件（如果已包含此插件则只需添加部分配置）：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <configuration>
                <argLine>-javaagent:${settings.localRepository}/com/alibaba/testable/testable-agent/${testable.version}/testable-agent-${testable.version}.jar</argLine>
            </configuration>
        </plugin>
    </plugins>
</build>

若项目同时还使用了Jacoco的on-the-fly模式（默认模式）统计单元测试覆盖率，则需在配置中添加一个@{argLine}参数，添加后的配置如下：

<argLine>@{argLine} -javaagent:${settings.localRepository}/com/alibaba/testable/testable-agent/${testable.version}/testable-agent-${testable.version}.jar</argLine>

具体参见项目java-demo的pom.xml和kotlin-demo的pom.xml文件。

Mock示例

在Mock测试类中定义一个有@MockMethod注解的普通方法，使它与需覆写的方法名称、参数、返回值类型完全一致，并在注解的targetClass参数指定该方法原本所属对象类型。此时被测类中所有对该需覆写方法的调用，将在单元测试运行时，将自动被替换为对上述自定义Mock方法的调用。

例如，被测类中有一处"anything".substring(1, 2)调用，我们希望在运行测试的时候将它换成一个固定字符串，则只需在Mock容器类定义如下方法：

// 原方法签名为`String substring(int, int)`
// 调用此方法的对象`"anything"`类型为`String`
@MockMethod(targetClass = String.class)
private String substring(int i, int j) {
    return "sub_string";
}

当遇到待覆写方法有重名时，可以将需覆写的方法名写到@MockMethod注解的targetMethod参数里，这样Mock方法自身就可以随意命名了。

下面这个例子展示了targetMethod参数的用法，其效果与上述示例相同：

// 使用`targetMethod`指定需Mock的方法名
// 此方法本身现在可以随意命名，但方法参数依然需要遵循相同的匹配规则
@MockMethod(targetClass = String.class, targetMethod = "substring")
private String use_any_mock_method_name(int i, int j) {
    return "sub_string";
}

有时，在Mock方法里会需要访问发起调用的原始对象中的成员变量，或是调用原始对象的其他方法。此时，可以将@MockMethod注解中的targetClass参数去除，然后在方法参数列表首位增加一个类型为该方法原本所属对象类型的参数。

TestableMock约定，当@MockMethod注解的targetClass参数值为空时，Mock方法的首位参数即为目标方法所属类型，参数名称随意。通常为了便于代码阅读，建议将此参数统一命名为self或src。举例如下：

// Mock方法在参数列表首位增加一个类型为`String`的参数（名字随意）
// 此参数可用于获得当时的实际调用者的值和上下文
@MockMethod
private String substring(String self, int i, int j) {
    // 可以直接调用原方法，此时Mock方法仅用于记录调用，常见于对void方法的测试
    return self.substring(i, j);
}

在测试用例中可用通过TestableTool.verify()方法，配合with()、withInOrder()、without()、withTimes()等方法实现对Mock调用情况的验证，例如：

    // 验证Mock方法被执行
    TestableTool.verify("substring").withTimes(1);

结束语

本篇中只给出了最基础的Mock示例，TestableMock还有很多其他增强技能，如：Mock构造方法、无返回值方法、私有方法等等，不得不说TestableMock的功能真的十分强大，堪称业界良心。