记一次 Mockito.mockStatic 泄漏导致的单元测试偶发报错排查过程

最新推荐文章于 2025-03-12 15:30:44 发布

最新推荐文章于 2025-03-12 15:30:44 发布 · 5.1k 阅读

文章标签：

#单元测试 #java #开发语言 #unit testing #Mockito

文章讲述了在ApacheShardingSphere项目中，由于Mockito.mockStatic使用后未正确释放，导致单元测试偶发性失败的问题。作者通过排查和调试，发现静态方法mock的生命周期管理问题，并提供了修复方案和代码规范更新。

相信用 Java 写过单元测试的读者们对 Mockito 不会陌生。至于 Mockito 是什么，为什么要用 Mockito，本文不再赘述。本文记录了一次在 Apache ShardingSphere 项目中，由 Mockito.mockStatic 使用不当导致的单元测试偶发报错排查过程。

文章目录

前言

Mockito 自 3.4.0 起新增了一个方法 Mockito.mockStatic，支持对静态方法 mock。

本人也曾在 Stack Overflow 上回答过一个问题，展示了我在 Apache ShardingSphere 的单元测试代码中使用 Mockito.mockStatic mock 单例的案例，对 Mockito.mockStatic 方法不是特别熟悉的同学可以了解一下：
如何使用 Mockito mock 单例 Mocking a singleton with mockito

mockStatic 使用有哪些注意实现？我们查看一下 Mockito 官方文档的说明：48. Mocking static methods (since 3.4.0)

When using the inline mock maker, it is possible to mock static method invocations within the current thread and a user-defined scope. This way, Mockito assures that concurrently and sequentially running tests do not interfere. To make sure a static mock remains temporary, it is recommended to define the scope within a try-with-resources construct.

大致的意思是：mockStatic 方法作用范围是当前线程和用户定义的作用域。为确保 mockStatic 只是临时生效，建议使用 try-with-resources 代码块包裹 mockStatic。
解读 Mockito 文档提供的示例：

assertEquals("foo", Foo.method()); // 静态方法 Foo.method() 原本行为
try (MockedStatic mocked = mockStatic(Foo.class)) {
   
    // 对 Foo 类进行 mockStatic 
    mocked.when(Foo::method).thenReturn("bar")