Mockito中如何有效模拟Java嵌套静态类

本教程旨在解决mockito中模拟java嵌套静态类时遇到的`nullpointerexception`问题。核心在于理解`@injectmocks`无法注入静态字段。文章将详细指导如何通过在`@beforeeach`方法中手动将模拟对象赋值给目标静态字段，从而正确地对嵌套静态类进行模拟，确保测试的顺利执行。

在Java单元测试中，使用Mockito模拟对象是常见的实践。然而，当涉及到模拟嵌套静态类，尤其是当这些类通过静态字段被访问时，开发者可能会遇到NullPointerException。这通常是因为对Mockito的注入机制存在误解。

理解@InjectMocks的局限性

首先，我们需要明确@InjectMocks注解的作用范围。@InjectMocks主要用于自动注入依赖到被测试对象（SUT, System Under Test）的实例字段中。它会尝试查找SUT中与@Mock或@Spy注解声明的模拟对象类型匹配的字段，并进行注入。

然而，@InjectMocks有几个重要的局限性：

• 不注入静态字段： 它不会尝试注入任何静态字段。静态字段属于类本身，而非类的特定实例。
• 不注入协作类字段： 它只会将被测试对象自身的依赖进行注入，而不会去注入被测试对象所依赖的协作类（例如示例中的A类）的字段。

在提供的示例场景中，Parent类通过A.b.append(string)调用了A类中的静态嵌套类B的方法。这里的关键是A.b是通过静态字段来访问的。由于A.b是一个静态字段，@InjectMocks无法对其进行注入，导致在测试运行时，A.b仍然为null，从而引发NullPointerException。

立即学习“Java免费学习笔记（深入）”；

正确模拟嵌套静态类的方法

要解决这个问题，我们需要采取一种手动的方式来设置静态字段。鉴于A.b是一个public static字段，我们可以直接对其进行赋值操作。

原始代码结构回顾

假设我们有如下的类结构：

Parent 类:

有道小P

有道小P，新一代AI全科学习助手，在学习中遇到任何问题都可以问我。

64

查看详情

class Parent {
    void record(String str) {
        // 在此处可能出现 NullPointerException
        A.b.append(str);
    }
}

嵌套静态类 A 和 B:

class A {
    public static B b; // 关键：这是一个静态字段

    public static class B {
        public void append(String str) {
            // 执行一些任务
            System.out.println("Appending: " + str);
        }
    }
}

初始的测试尝试 (可能导致NPE):

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.mockito.Mockito.*;

@ExtendWith(MockitoExtension.class)
public class ParentTest {

    @InjectMocks
    Parent parent; // SUT

    @Test
    public void dummy_test() {
        A.B writer = mock(A.B.class); // 模拟了 A.B，但没有将其赋值给 A.b
        doNothing().when(writer).append(any());
        parent.record("Text"); // A.b 仍然是 null，抛出 NPE
    }
}

在这个初始的测试中，尽管我们模拟了A.B并设置了其行为，但这个模拟对象writer并没有被赋值给A.b。当parent.record("Text")执行时，它仍然尝试访问A.b，而此时A.b仍为null，导致NullPointerException。

解决方案：手动注入静态字段

正确的做法是在测试设置阶段（通常是@BeforeEach方法中）手动将模拟对象赋值给目标静态字段。

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.mockito.Mockito.*; // 导入静态方法

@ExtendWith(MockitoExtension.class)
public class ParentTest {

    // 直接实例化 Parent 对象，因为其内部没有需要 @InjectMocks 注入的字段
    Parent parent = new Parent(); 

    // 声明一个 A.B 类型的模拟对象
    @Mock
    A.B writer; 

    @BeforeEach
    void setup() {
        // 在每个测试方法执行前，将模拟对象赋值给静态字段 A.b
        A.b = writer;
        // 可选：设置模拟对象的行为
        doNothing().when(writer).append(anyString()); 
    }

    @Test
    public void dummy_test() {
        parent.record("Text");
        // 验证 append 方法是否被调用
        verify(writer).append("Text"); 
    }

    // 可选：在测试结束后清理静态字段，防止影响其他测试
    @AfterEach
    void tearDown() {
        A.b = null; 
    }
}

代码解析：

1. Parent parent = new Parent();: 我们不再使用@InjectMocks来注解Parent对象，而是直接实例化它。因为Parent类本身没有需要@InjectMocks注入的依赖。
2. @Mock A.B writer;: 声明一个A.B类型的模拟对象writer。MockitoExtension会自动为这个字段创建模拟实例。
3. @BeforeEach void setup() { A.b = writer; ... }: 这是解决问题的核心。在每个测试方法执行之前，setup方法会被调用。在这里，我们将由@Mock创建的writer模拟对象手动赋值给A.b这个静态字段。这样，当parent.record("Text")执行时，A.b就不再是null，而是我们控制的模拟对象。
4. doNothing().when(writer).append(anyString());: 设置模拟对象的行为。这里我们让append方法在被调用时什么都不做。
5. verify(writer).append("Text");: 在测试方法中，我们可以验证writer（即A.b）的append方法是否被调用，以及调用时传入的参数是否正确。
6. @AfterEach void tearDown() { A.b = null; } (可选但推荐): 在某些情况下，为了避免静态字段的模拟对象在不同测试之间产生干扰（尤其是在测试套件中），你可能需要在每个测试方法执行完毕后，将静态字段重置为null或其原始状态。

注意事项与总结

• 静态字段的特殊性： 静态字段属于类，而不是实例。因此，常规的实例注入机制（如@InjectMocks）对其无效。
• 手动赋值的必要性： 当需要模拟通过静态字段访问的依赖时，手动赋值是直接且有效的解决方案。
• 可见性要求： 这种方法依赖于静态字段是public或至少在测试类中可访问。如果静态字段是private的，则可能需要更高级的工具（如PowerMock）或反射机制来修改其值，但这通常会增加测试的复杂性。
• 测试隔离： 每次测试前设置（@BeforeEach）和测试后清理（@AfterEach）静态字段对于维护测试之间的隔离至关重要，可以防止一个测试的副作用影响到后续测试。

通过上述方法，我们可以有效地在Mockito中模拟Java的嵌套静态类，解决因静态字段未被注入而导致的NullPointerException，从而编写出健壮可靠的单元测试。

以上就是Mockito中如何有效模拟Java嵌套静态类的详细内容，更多请关注php中文网其它相关文章！