使用 Mockk 模拟 Java 静态方法

1. 概述

Kotlin 与 Java 兼容性极佳，但两者之间仍存在差异。例如，Kotlin 不提供 static 关键字，而 Java 中的静态方法在单元测试中又难以模拟（mock）。幸运的是，Mocking 框架 Mockk 提供了强大的能力，可以轻松模拟 Java 的静态方法。

✅ 本文重点：掌握如何使用 Mockk 模拟 Java 静态方法，并在测试后正确清理，避免污染其他测试用例。

我们将学习：

如何使用 mockkStatic() 拦截静态方法调用
测试后如何安全地还原（unmock），防止“测试污染”
扩展到 Kotlin 顶层函数和扩展函数的模拟技巧

⚠️ 踩坑提示：若忘记清理 mock，极易导致测试间相互影响，出现非预期的失败，尤其在并行执行时更难排查。

2. 模拟 Java 静态方法

我们以一个典型的 Java 工具类 RandomNumberGenerator 为例：

public class RandomNumberGenerator {
    public static Double random() {
        return Math.random();
    }
}

假设我们在 Kotlin 中有一个抛硬币逻辑，依赖该静态方法：

fun coinFlip() = if(RandomNumberGenerator.random() < 0.5) "heads" else "tails"

对于某些测试场景，无需 mock 即可验证基础行为，比如：

@Test
fun `Doing a coin flip should not throw an exception`() {
    repeat(1000) {
        coinFlip()
    }
}

但如果我们想精确控制随机结果来验证业务逻辑（如：当 random < 0.5 时返回 "heads"），就必须 mock 静态方法。

此时使用 mockkStatic() 是最直接的方式：

@Test
fun `Heads should be returned whenever random returns less than 0,5`() {
    // 拦截 RandomNumberGenerator 类的所有静态调用
    mockkStatic(RandomNumberGenerator::class)
    // 定义 mock 行为：random() 永远返回 0.1
    every { RandomNumberGenerator.random() } returns 0.1
    
    assertEquals(coinFlip(), "heads")
}

✅ 核心步骤：

mockkStatic(目标类::class) —— 开启对静态方法的拦截
every { 方法调用 } returns 返回值 —— 定义期望的返回行为

3. 测试后清理单个 Mock

⚠️ 非常重要：静态方法是全局共享的！如果不在测试后还原，会导致后续测试行为异常。

因此，必须在每个测试结束后清除对该类的 mock：

@AfterEach
fun `Remove RandomNumberGenerator mockks`() {
    unmockkStatic(RandomNumberGenerator::class)
}

✅ 推荐做法：将 unmockkStatic() 放在 @AfterEach 回调中，确保无论测试成功或失败都能执行清理。

4. 一次性清除所有 Mock

如果你的测试类中 mock 了多个静态类，逐个调用 unmockkStatic() 显得繁琐且易遗漏。

更优雅的方式是统一使用 unmockkAll()：

@AfterEach
fun `Remove all mocks`() {
    unmockkAll()
}

✅ 优势：

✅ 集中管理，避免遗漏
✅ 简洁清晰，提升可维护性
✅ 安全兜底，防止 mock 泄漏

❌ 反模式：仅在个别测试中手动 unmock，容易造成“测试污染”。

5. 模拟 Kotlin 顶层函数与扩展函数

Mockk 的 mockkStatic() 不仅适用于 Java 静态方法，也能用于 Kotlin 的顶层函数和扩展函数 —— 因为它们在编译后本质上也是静态方法。

5.1 模拟顶层函数

Kotlin 中定义在 .kt 文件顶层的函数，会被编译成对应文件名的 JVM 静态方法（包装在 XXXKt 类中）。

示例函数：

fun topLevelFunction(): String {
    return "Hello, World!"
}

要 mock 它，需指定其生成的类的全限定名：

@Test
fun `mock top-level function`() {
    // 注意：类名由文件名决定，通常为 XxxKt
    mockkStatic("com.baeldung.mock.TopLevelFunctionKt")
    every { topLevelFunction() } returns "Mocked Response"

    assertEquals("Mocked Response", topLevelFunction())
    unmockkStatic("com.baeldung.mock.TopLevelFunctionKt")
}

⚠️ 踩坑提示：包名和文件名必须完全匹配，否则会抛出 ClassNotFoundException。建议通过 IDE 查看反编译代码确认类名。

5.2 模拟扩展函数

扩展函数同样被编译为静态方法，接收者作为第一个参数。

定义一个字符串扩展：

fun String.greet(): String {
    return "Hello, $this"
}

模拟方式与顶层函数一致：

@Test
fun `mock extension function`() {
    mockkStatic("com.baeldung.mockk.TopLevelExtensionKt")
    every { "World".greet() } returns "Mocked Greeting"
    assertEquals("Mocked Greeting", "World".greet())
    unmockkStatic("com.baeldung.mockk.TopLevelExtensionKt")
}

✅ 关键点：

使用 mockkStatic("包名.文件名Kt") 拦截整个文件中的所有顶层/扩展函数
every { ... } 中的调用语法保持不变，Mockk 会自动匹配到对应的静态方法

6. 总结

本文系统介绍了如何使用 Mockk 模拟 Java 静态方法及 Kotlin 相关静态化函数：

场景	方法	清理方式
Java 静态方法	`mockkStatic(类::class)`	`unmockkStatic(类::class)` 或 `unmockkAll()`
Kotlin 顶层函数	`mockkStatic("包名.文件名Kt")`	同上
Kotlin 扩展函数	`mockkStatic("包名.文件名Kt")`	同上

✅ 最佳实践建议：

✅ 始终在 @AfterEach 中调用 unmockkAll()，确保环境干净
✅ 对于复杂项目，可考虑使用 @TestInstance(Lifecycle.PER_METHOD) 隔离测试实例
✅ 避免在 @BeforeAll 或 @BeforeEach 中过早 mock，按需使用

示例代码已上传至 GitHub：https://github.com/Baeldung/kotlin-tutorials/tree/master/kotlin-mockito

Persistence

REST

Security