java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > java  mockito 模拟静态方法与私有方法

Java 单元测试之Mockito 模拟静态方法与私有方法最佳实践

作者：Jinkxs

本文将深入探讨如何使用 Mockito 来模拟静态方法和私有方法,结合大量实战代码示例,带你突破传统单元测试的边界,写出更彻底、更独立、更具可读性的测试用例,感兴趣的朋友跟随小编一起看看吧

幸运的是，Mockito 作为 Java 生态中最流行的 mocking 框架之一，在近年来不断进化，已经支持了对静态方法和私有方法的模拟（mocking）与验证，极大地扩展了其在真实项目中的适用范围。

本文将深入探讨如何使用 Mockito 来模拟静态方法和私有方法，结合大量实战代码示例，带你突破传统单元测试的边界，写出更彻底、更独立、更具可读性的测试用例。

Mockito 简介：为什么选择它？

在进入高级主题之前，让我们快速回顾一下 Mockito 的核心优势：

从 3.x 版本开始，Mockito 引入了对 mock-making（mock 制作）引擎的插件化支持，并通过 mockito-inline 模块实现了对静态方法的支持，这标志着 Mockito 正式迈入“无所不能 mock”的新时代。

环境准备

首先，在你的 pom.xml 中添加以下依赖：

<dependencies>
    <!-- JUnit 5 -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <version>5.9.2</version>
        <scope>test</scope>
    </dependency>
    <!-- Mockito Core -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <version>5.7.0</version>
        <scope>test</scope>
    </dependency>
    <!-- 关键：Mockito Inline（支持静态方法） -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-inline</artifactId>
        <version>5.7.0</version>
        <scope>test</scope>
    </dependency>
</dependencies>

注意：mockito-inline 是必须的。如果你只引入 mockito-core，将无法使用 MockedStatic 功能。

Gradle 用户可以使用：

testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
testImplementation 'org.mockito:mockito-core:5.7.0'
testImplementation 'org.mockito:mockito-inline:5.7.0'

模拟静态方法：打破“不可变”的枷锁

静态方法因其无状态、易于调用的特性，常被用于工具类（如 StringUtils、DateUtils）、工厂方法或全局配置访问器。但这也带来了测试难题——你无法通过常规方式 mock 它们，因为它们不属于任何实例。

传统困境

考虑以下代码：

public class UserService {
    private final UserRepository userRepository;
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
    public User createUser(String name, String email) {
        if (StringUtils.isEmpty(name)) {
            throw new IllegalArgumentException("Name cannot be empty");
        }
        if (!EmailValidator.isValid(email)) {
            throw new IllegalArgumentException("Invalid email format");
        }
        User user = new User(name.trim(), email.toLowerCase());
        return userRepository.save(user);
    }
}

其中 StringUtils.isEmpty() 和 EmailValidator.isValid() 都是静态方法。如果我们想测试 createUser 方法，就必须确保这些静态方法的行为可控，否则测试将依赖于它们的真实实现，失去了“单元”测试的意义。

解法一：使用MockedStatic<T>模拟静态方法

从 Mockito 3.4.0 开始，你可以使用 MockedStatic 来 mock 静态方法。这是目前最推荐的方式。

import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;
class UserServiceTest {
    private final UserRepository userRepository = mock(UserRepository.class);
    private final UserService userService = new UserService(userRepository);
    @Test
    void shouldThrowExceptionWhenNameIsEmpty() {
        // 使用 try-with-resources 确保 mock 被正确关闭
        try (MockedStatic<StringUtils> mocked = mockStatic(StringUtils.class)) {
            // 设定行为：当调用 isEmpty("") 时返回 true
            mocked.when(() -> StringUtils.isEmpty(""))
                  .thenReturn(true);
            // 执行 & 验证
            IllegalArgumentException exception = assertThrows(
                IllegalArgumentException.class,
                () -> userService.createUser("", "user@example.com")
            );
            assertEquals("Name cannot be empty", exception.getMessage());
            // 验证静态方法被调用了一次
            mocked.verify(() -> StringUtils.isEmpty(""), times(1));
        }
    }
    @Test
    void shouldCreateUserWhenValidInput() {
        User savedUser = new User("Alice", "alice@example.com");
        when(userRepository.save(any(User.class))).thenReturn(savedUser);
        try (MockedStatic<StringUtils> stringUtilsMock = mockStatic(StringUtils.class);
             MockedStatic<EmailValidator> emailValidatorMock = mockStatic(EmailValidator.class)) {
            stringUtilsMock.when(() -> StringUtils.isEmpty(anyString()))
                           .thenReturn(false); // 假设所有非空字符串都不为空
            emailValidatorMock.when(() -> EmailValidator.isValid("alice@example.com"))
                              .thenReturn(true);
            User result = userService.createUser("Alice", "alice@example.com");
            assertEquals(savedUser, result);
            verify(userRepository).save(any(User.class));
        }
    }
}

关键点解析：

解法二：使用@ExtendWith(MockitoExtension.class)+@MockedStatic

Mockito 也支持通过 JUnit 5 扩展来管理 MockedStatic 的生命周期。

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.MockedStatic;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.mockito.Mockito.*;
@ExtendWith(MockitoExtension.class)
class UserServiceWithExtensionTest {
    private final UserRepository userRepository = mock(UserRepository.class);
    private final UserService userService = new UserService(userRepository);
    @Test
    void testWithInjectedMockedStatic(MockedStatic<StringUtils> mocked) {
        mocked.when(() -> StringUtils.isEmpty(anyString()))
              .thenAnswer(invocation -> {
                  String str = invocation.getArgument(0);
                  return str == null || str.trim().isEmpty();
              });
        assertThrows(IllegalArgumentException.class,
                    () -> userService.createUser("   ", "invalid"));
        mocked.verify(() -> StringUtils.isEmpty("   "), times(1));
    }
}

这种方式由 JUnit 扩展自动管理资源，代码更简洁，但灵活性略低。

处理静态方法链与复杂逻辑

有时静态方法内部会调用其他静态方法，形成调用链。Mockito 同样可以处理：

public class DataProcessor {
    public static String process(String input) {
        if (ValidationUtils.isValid(input)) {
            return TransformationUtils.transform(input).toUpperCase();
        }
        return null;
    }
}
@Test
void shouldProcessValidInput() {
    try (MockedStatic<ValidationUtils> validationMock = mockStatic(ValidationUtils.class);
         MockedStatic<TransformationUtils> transformMock = mockStatic(TransformationUtils.class)) {
        validationMock.when(() -> ValidationUtils.isValid("hello"))
                      .thenReturn(true);
        transformMock.when(() -> TransformationUtils.transform("hello"))
                     .thenReturn("HELLO_PROCESSED");
        String result = DataProcessor.process("hello");
        assertNotNull(result);
        assertEquals("HELLO_PROCESSED", result.toUpperCase()); // 注意：transform 返回小写，process 转大写
        validationMock.verify(() -> ValidationUtils.isValid("hello"));
        transformMock.verify(() -> TransformationUtils.transform("hello"));
    }
}

模拟私有方法：深入类的“内心世界”

私有方法是类的内部实现细节，按理说不应在单元测试中直接调用。传统观点认为，只要公共方法的行为正确，私有方法自然也就正确了。

但在某些场景下，我们仍希望：

方法一：使用反射（不推荐）

最原始的方法是通过 Java 反射强行访问私有方法：

import java.lang.reflect.Method;
@Test
void testPrivateMethodWithReflection() throws Exception {
    UserService userService = new UserService(mock(UserRepository.class));
    // 获取私有方法
    Method method = UserService.class.getDeclaredMethod("validateEmail", String.class);
    method.setAccessible(true); // 破坏封装！
    // 调用并获取结果
    boolean result = (boolean) method.invoke(userService, "valid@email.com");
    assertTrue(result);
}

问题：

方法二：使用 PowerMock（历史方案）

PowerMock 曾是解决此类问题的主流方案，但它需要字节码操作，与现代测试框架（尤其是 Java 11+）兼容性差，且配置复杂。

// ❌ 已过时，不推荐
@RunWith(PowerMockRunner.class)
@PrepareForTest(UserService.class)
public class UserServiceWithPowerMockTest {
    @Test
    public void testPrivateMethod() throws Exception {
        UserService spy = PowerMockito.spy(new UserService(...));
        PowerMockito.when(spy, "privateMethod", anyString())
                    .thenReturn("mocked result");
        // ...
    }
}

方法三：Mockito 内置支持（Mockito 3.4.0+）

从 Mockito 3.4.0 开始，可以通过 MockSettings 的 withSettings().defaultAnswer() 结合 AdditionalAnswers.delegatesTo() 来间接控制私有方法的行为，但这并不直接。

真正革命性的变化出现在 Mockito 4.6.0，它引入了 Mockito.lenient() 和对私有方法的部分支持，但截至目前（Mockito 5.x），Mockito 仍然没有原生支持直接 mock 私有方法。

当前最佳实践：重构 + Spy

既然 Mockito 不直接支持 mock 私有方法，我们应该怎么做？

✅ 推荐策略一：提取为独立组件

将复杂的私有逻辑提取到一个新的类中，然后正常 mock 它。

public interface EmailValidatorService {
    boolean isValid(String email);
}
@Service
public class DefaultEmailValidator implements EmailValidatorService {
    @Override
    public boolean isValid(String email) {
        // 复杂的验证逻辑
        return email != null && email.contains("@") && email.length() > 5;
    }
}
public class UserService {
    private final UserRepository userRepository;
    private final EmailValidatorService emailValidator; // 依赖注入
    public UserService(UserRepository userRepository, EmailValidatorService emailValidator) {
        this.userRepository = userRepository;
        this.emailValidator = emailValidator;
    }
    public User createUser(String name, String email) {
        if (!emailValidator.isValid(email)) { // 调用接口
            throw new IllegalArgumentException("Invalid email");
        }
        // ...
    }
}

测试时：

@Test
void shouldRejectInvalidEmail() {
    UserRepository repo = mock(UserRepository.class);
    EmailValidatorService validator = mock(EmailValidatorService.class);
    when(validator.isValid("bad")).thenReturn(false);
    UserService userService = new UserService(repo, validator);
    assertThrows(IllegalArgumentException.class,
                () -> userService.createUser("Alice", "bad"));
}

优点：

✅ 推荐策略二：使用spy和部分 mock

如果你无法重构，可以使用 spy 来部分 mock 对象，让大多数方法调用真实实现，只 mock 特定方法。

public class PaymentService {
    public boolean processPayment(double amount, String cardNumber) {
        if (amount <= 0) return false;
        String token = generateToken(cardNumber); // 私有方法
        return sendPaymentRequest(amount, token);
    }
    private String generateToken(String cardNumber) {
        // 模拟调用第三方加密服务
        return "TOKEN-" + cardNumber.substring(cardNumber.length() - 4);
    }
    private boolean sendPaymentRequest(double amount, String token) {
        // 调用外部支付网关
        return true; // 简化
    }
}

测试 generateToken 的逻辑：

@Test
void shouldGenerateTokenFromLastFourDigits() {
    PaymentService spyService = spy(new PaymentService());
    // 即使是私有方法，如果它是 protected 或 package-private，
    // 我们可以通过 spy 模拟其行为（但不能直接 mock 私有方法）
    // 实际上，对于私有方法，我们通常测试其被调用的情况
    // 我们可以验证 processPayment 是否调用了 generateToken
    // 但由于是私有方法，无法直接 verify
    // 所以更好的方式是测试最终行为
    doReturn("MOCKED_TOKEN").when(spyService).generateToken("1234"); // ❌ 编译错误！无法 mock 私有方法
    // 因此，我们转而测试整个流程
    // 或者，将 generateToken 改为 protected/package-private 并使用 spy
}

如果我们将 generateToken 改为 protected：

protected String generateToken(String cardNumber) { ... }

则可以：

@Test
void shouldUseGeneratedTokenInPaymentRequest() {
    PaymentService spyService = spy(new PaymentService());
    doReturn("MOCK-TOKEN-5678").when(spyService).generateToken("1234-5678-9012-5678");
    boolean result = spyService.processPayment(100.0, "1234-5678-9012-5678");
    assertTrue(result);
    // 进一步验证 sendPaymentRequest 是否使用了 MOCK-TOKEN...
}

综合案例：一个真实的微服务场景

假设我们正在开发一个订单处理服务，它依赖于一个静态的 TaxCalculator 工具类和一个私有的库存检查方法。

// 静态工具类
public class TaxCalculator {
    public static double calculate(double amount, String region) {
        // 第三方 API 调用
        return switch (region) {
            case "US" -> amount * 0.08;
            case "EU" -> amount * 0.20;
            default -> 0.0;
        };
    }
}
// 主服务类
public class OrderService {
    private final OrderRepository orderRepository;
    public OrderService(OrderRepository orderRepository) {
        this.orderRepository = orderRepository;
    }
    public Order createOrder(CreateOrderRequest request) {
        double tax = TaxCalculator.calculate(request.getAmount(), request.getRegion());
        double total = request.getAmount() + tax;
        if (!checkInventory(request.getProductId(), request.getQuantity())) {
            throw new InsufficientInventoryException("Not enough stock");
        }
        Order order = new Order(request.getUserId(), request.getProductId(),
                               request.getQuantity(), total);
        return orderRepository.save(order);
    }
    private boolean checkInventory(String productId, int quantity) {
        // 查询库存系统
        return true; // 简化
    }
}

现在，我们来编写全面的单元测试：

class OrderServiceTest {
    private final OrderRepository orderRepository = mock(OrderRepository.class);
    private final OrderService orderService = new OrderService(orderRepository);
    @Test
    void shouldCalculateCorrectTaxAndSaveOrder() {
        CreateOrderRequest request = new CreateOrderRequest("U123", "P456", 2, 100.0, "US");
        Order savedOrder = new Order("U123", "P456", 2, 108.0); // 100 + 8% tax
        when(orderRepository.save(any(Order.class))).thenReturn(savedOrder);
        try (MockedStatic<TaxCalculator> taxMock = mockStatic(TaxCalculator.class)) {
            taxMock.when(() -> TaxCalculator.calculate(100.0, "US"))
                   .thenReturn(8.0);
            Order result = orderService.createOrder(request);
            assertEquals(108.0, result.getTotal());
            verify(orderRepository).save(any(Order.class));
            taxMock.verify(() -> TaxCalculator.calculate(100.0, "US"), times(1));
        }
    }
    @Test
    void shouldThrowExceptionWhenInventoryInsufficient() {
        OrderService spyService = spy(orderService);
        doReturn(false).when(spyService).checkInventory("P456", 5);
        CreateOrderRequest request = new CreateOrderRequest("U123", "P456", 5, 50.0, "US");
        assertThrows(InsufficientInventoryException.class,
                    () -> spyService.createOrder(request));
        verify(spyService).checkInventory("P456", 5);
    }
}

在这个例子中：

高级技巧与注意事项

1. 模拟静态初始化块

某些类在加载时会执行静态初始化，可能连接数据库或启动线程。你可以通过 mockStatic 在类加载前拦截。

@Test
void shouldPreventStaticInitSideEffects() {
    try (MockedStatic<LegacyConfig> mock = mockStatic(LegacyConfig.class)) {
        mock.when(LegacyConfig::getInstance).thenThrow(new RuntimeException("Disabled"));
        // 现在任何尝试获取实例的操作都会失败，防止真实初始化
    }
}

2. 限制作用域

始终使用 try-with-resources 来限制 MockedStatic 的作用域，避免“污染”其他测试。

3. 性能考量

静态 mock 涉及字节码操作，比普通 mock 稍慢。确保只在必要时使用。

4. 与 Spring Test 的集成

在 Spring Boot 测试中，你可以结合 @SpringBootTest 和 mockStatic：

@SpringBootTest
@ExtendWith(MockitoExtension.class)
class SpringIntegrationTest {
    @Autowired
    private OrderService orderService;
    @Test
    void testWithStaticMock(@MockBean OrderRepository repo) {
        try (MockedStatic<TaxCalculator> mock = mockStatic(TaxCalculator.class)) {
            mock.when(() -> TaxCalculator.calculate(100.0, "US")).thenReturn(8.0);
            // 测试...
        }
    }
}

常见陷阱与避坑指南

❌ 陷阱一：忘记添加mockito-inline

如果没有 mockito-inline 依赖，mockStatic 会抛出 MockitoException。

❌ 陷阱二：未正确关闭MockedStatic

// 错误
MockedStatic<TaxCalculator> mock = mockStatic(TaxCalculator.class);
mock.when(...).thenReturn(...);
// 忘记 close() —— 静态方法将永久被 mock！

❌ 陷阱三：过度使用静态 mock

静态方法难以测试往往是设计问题。优先考虑重构为依赖注入。

❌ 陷阱四：试图 mockfinal类的静态方法

虽然 mockito-inline 支持 final 类，但仍需谨慎。某些情况下需要额外配置 JVM 参数。

最佳实践总结

  1. 优先重构，而非强行 mock：将静态方法和私有逻辑提取为可注入的服务。
  2. 静态 mock 仅用于遗留代码或工具类：如 LocalDateTime.now()、System.getProperty()。
  3. 使用 try-with-resources 管理生命周期。
  4. 保持测试的可读性：复杂的 mock 设置可能意味着代码设计需要改进。
  5. 不要 mock 一切：关注行为，而非实现细节。

监控与 CI/CD 集成

在持续集成流水线中，确保你的测试覆盖率包含对关键静态和私有逻辑的验证。使用 JaCoCo 等工具生成报告：

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.11</version>
    <executions>
        <execution>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>report</id>
            <phase>test</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>

结语

Mockito 对静态方法的支持，标志着 Java 单元测试能力的一次重大飞跃。它让我们能够更彻底地隔离被测代码，编写出真正“单元化”的测试。而对于私有方法，虽然 Mockito 尚未提供直接支持，但通过合理的重构和 spy 机制，我们依然可以达到理想的测试覆盖率。

记住，测试的目的不是为了追求 100% 的覆盖率数字，而是为了构建一个可靠、可维护、可演进的软件系统。工具是手段，设计才是根本。

参考资料

到此这篇关于Java 单元测试之Mockito 模拟静态方法与私有方法最佳实践的文章就介绍到这了,更多相关java mockito 模拟静态方法与私有方法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文