SpringBoot 单元测试：优雅地 Mock 静态方法，升级 Mockito 到 4.0

在进行 SpringBoot 单元测试时，我们经常需要模拟（Mock）一些外部依赖或工具类，以隔离被测代码，使其更容易测试。然而，当需要 Mock 静态方法时，可能会遇到一些问题。本文将详细介绍如何升级 Mockito 版本到 4.0，从而优雅地 Mock 静态方法，并分享一些升级过程中的注意事项。

问题背景：SpringBoot 1.0 及更早版本 Mockito 不支持静态方法 Mock

在 SpringBoot 1.0 及更早版本中，默认依赖的 Mockito 版本不支持直接 Mock 静态方法。这使得在某些场景下进行单元测试变得困难，因为无法有效地隔离静态方法的行为。 Mockito 4.0 引入了对静态方法 Mock 的支持，这大大简化了单元测试的复杂性。

解决方案：升级 Mockito 版本到 4.0

为了解决这个问题，我们需要升级 Mockito 的版本。但是，直接升级可能会因为版本冲突而导致问题。因此，我们需要进行一些必要的配置来排除 SpringBoot 默认依赖的 Mockito 版本，并引入我们期望的版本。

步骤 1：排除 SpringBoot 默认依赖的 Mockito 版本

SpringBoot spring-boot-starter-test 依赖默认包含了 Mockito 的一个版本。为了避免版本冲突，我们需要在 pom.xml 文件中排除这个依赖。

xml 复制代码

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
  <exclusions>
    <exclusion>
      <artifactId>mockito-core</artifactId>
      <groupId>org.mockito</groupId>
    </exclusion>
  </exclusions>
</dependency>

说明:

scope>test</scope>：确保该依赖仅在测试环境中生效。
<exclusions>：用于排除 spring-boot-starter-test 依赖中包含的 mockito-core 依赖。

步骤 2：添加 Mockito 4.0 依赖

在排除 SpringBoot 默认依赖后，我们需要添加我们期望的 Mockito 4.0 依赖。

xml 复制代码

<dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-core</artifactId>
  <version>4.11.0</version> <!-- 建议使用最新稳定版本 -->
  <exclusions>
    <exclusion>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
    </exclusion>
    <exclusion>
      <artifactId>org.hamcrest.core</artifactId>
      <groupId>org.hamcrest</groupId>
    </exclusion>
  </exclusions>
</dependency>

说明:

<version>4.11.0</version>： 强烈建议使用最新稳定版本 。可以访问 Maven Central 仓库 mvnrepository.com/artifact/or... 查找最新的版本。
<exclusions>：这里排除了 spring-core 和 org.hamcrest.core，这是因为我们后续会明确引入 org.hamcrest.core，并且避免与 Spring 的版本冲突。虽然在很多情况下可以省略，但为了保证最佳兼容性，建议保留。

步骤 3：引入 Hamcrest 依赖

由于我们排除了 spring-boot-starter-test 依赖中的 Hamcrest 依赖，我们需要显式地引入它。

xml 复制代码

<dependency>
  <groupId>org.hamcrest</groupId>
  <artifactId>hamcrest-core</artifactId>
  <version>1.3</version>
</dependency>

步骤 4：引入 Mockito Inline (可选，但推荐)

Mockito Inline 是一个非常有用的扩展，它允许你更灵活地 mock final 类和静态方法。虽然不是必须的，但强烈推荐使用。

xml 复制代码

<dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-inline</artifactId>
  <version>4.11.0</version>  <!-- 确保与 mockito-core 版本一致 -->
  <scope>test</scope>
</dependency>

说明:

确保 mockito-inline 的版本与 mockito-core 版本一致，以避免潜在的兼容性问题。

如何 Mock 静态方法

升级完成后，就可以使用 Mockito 4.0 来 Mock 静态方法了。以下是一个简单的示例：

typescript 复制代码

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

class MyStaticClass {
    public static String getStaticValue() {
        return "Original Value";
    }
}

class MyTest {

    @Test
    void testMockStaticMethod() {
        // 使用 Mockito.mockStatic() 创建一个静态方法的 Mock
        Mockito.mockStatic(MyStaticClass.class).when(MyStaticClass.getStaticValue()).thenReturn("Mocked Value");

        // 验证被测代码使用了 Mocked Value
        String result = MyClassUnderTest.useStaticValue();

        assertEquals("Mocked Value", result);
    }
}

class MyClassUnderTest {
    public String useStaticValue() {
        return MyStaticClass.getStaticValue();
    }
}

注意事项和最佳实践

版本兼容性： 始终确保 mockito-core、mockito-inline 和 org.hamcrest 的版本兼容。
依赖管理： 使用 Maven 或 Gradle 管理依赖，避免手动下载和管理 JAR 文件。
测试覆盖率： 编写充分的单元测试用例，覆盖各种场景，确保代码的质量。
避免过度 Mock： 只 Mock 那些真正需要隔离的外部依赖，避免过度 Mock，保持代码的可读性和可维护性。
使用 JUnit 5: Mockito 4.0 最佳实践是与 JUnit 5 一起使用，以获得更好的测试体验。
检查 Maven 依赖树: 升级后，使用 mvn dependency:tree 命令检查 Maven 依赖树，确保没有冲突的依赖。

总结

通过升级 Mockito 版本到 4.0，并进行适当的配置，我们可以轻松地 Mock 静态方法，提高单元测试的灵活性和覆盖率。希望这篇文章能够帮助你更好地进行单元测试，提升代码的质量。