如何使用Mockito mock静态方法并验证其调用次数？

Question

如何使用Mockito mock静态方法并验证其调用次数？ 在单元测试中，Mockito是一个强大的工具，但默认情况下它不支持mock静态方法。从Mockito 3.4.0开始，通过与mockito-inline依赖结合，可以轻松mock静态方法。例如，若要mock某个类的静态方法并验证调用次数，首先需引入`mockito-inline`依赖。然后使用`Mockito.mockStatic()`创建一个尝试关闭的静态mock对象，在其中定义静态方法的行为。最后通过`verify()`方法验证静态方法被调用的具体次数。这种方式极大地增强了测试能力，但要注意避免过度依赖静态方法，以免降低代码灵活性和可测试性。

Answer 1

1. Mockito基础与静态方法Mock的背景

在单元测试中，Mockito是一个强大的工具，用于模拟对象的行为并验证交互。然而，默认情况下Mockito并不支持mock静态方法。这是因为静态方法属于类本身，而不是实例，这使得它们难以被拦截和重写。

从Mockito 3.4.0版本开始，通过引入`mockito-inline`依赖，可以实现对静态方法的mock。这种能力为测试提供了更大的灵活性，但同时也提醒开发者尽量减少对静态方法的过度依赖，以保持代码的可维护性和可测试性。

2. 引入`mockito-inline`依赖

要使用Mockito mock静态方法，首先需要在项目中添加`mockito-inline`依赖。以下是Maven和Gradle中的配置示例：

• Maven配置:

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-inline</artifactId>
    <version>4.x.x</version>
    <scope>test</scope>
</dependency>

• Gradle配置:

testImplementation 'org.mockito:mockito-inline:4.x.x'

确保使用的Mockito版本不低于3.4.0，这样才能支持静态方法的mock功能。

3. 使用`Mockito.mockStatic()`模拟静态方法

通过`Mockito.mockStatic()`方法，可以创建一个尝试关闭的静态mock对象，并定义静态方法的行为。以下是一个完整的示例：

import static org.mockito.Mockito.*;
import org.junit.jupiter.api.Test;

public class StaticMethodMockTest {
    @Test
    public void testStaticMethod() {
        // 创建一个静态mock对象
        try (var mockedStatic = mockStatic(Utilities.class)) {
            // 定义静态方法的行为
            mockedStatic.when(() -> Utilities.computeValue(10)).thenReturn(50);

            // 调用静态方法
            int result = Utilities.computeValue(10);

            // 验证调用次数
            verify(mockedStatic).computeValue(10);
        }
    }
}

在这个例子中，我们mock了`Utilities`类的`computeValue`静态方法，并验证它是否被调用了正确的参数和次数。

4. 验证静态方法的调用次数

通过`verify()`方法，可以验证静态方法被调用的具体次数。例如，验证某个静态方法是否被调用了一次：

verify(mockedStatic, times(1)).computeValue(10);

如果希望验证方法没有被调用，可以使用`never()`：

verify(mockedStatic, never()).computeValue(10);

还可以结合其他匹配器（如`atLeastOnce()`、`atMost(n)`等）来验证调用频率。

5. 注意事项与最佳实践

虽然Mockito支持mock静态方法，但在设计代码时应尽量避免过多依赖静态方法。以下是一些最佳实践：

建议	原因
优先使用依赖注入	依赖注入使代码更灵活，更容易测试
限制静态方法的数量	静态方法不易替换或扩展
仅对必要的静态方法进行mock	过度mock可能导致测试变得复杂且不直观

此外，可以通过流程图展示静态方法mock的基本步骤：

sequenceDiagram
        participant Tester as 测试人员
        participant Mockito as Mockito框架
        participant StaticMethod as 静态方法
        Tester->>Mockito: 创建静态mock对象
        Mockito->>StaticMethod: 定义行为
        Tester->>StaticMethod: 调用静态方法
        Tester->>Mockito: 验证调用次数