Java中测试包含私有方法、字段或内部类的类

技术背景

在Java开发中，我们经常会遇到需要测试包含私有方法、字段或内部类的类的情况。按照面向对象的设计原则，私有成员是不应该被外部直接访问的，但在测试时，我们可能希望对这些私有成员进行单独测试，以确保代码的正确性和健壮性。然而，直接测试私有成员可能会破坏类的封装性，因此需要采用合适的方法来进行测试。

实现步骤

1. 通过公共方法间接测试

这是最常见且推荐的方法。由于私有方法通常是被公共方法调用的，所以可以通过测试公共方法来间接测试私有方法。
示例代码如下：

public class Calculator {
    private int add(int a, int b) {
        return a + b;
    }

    public int calculateSum(int a, int b) {
        return add(a, b);
    }
}

测试代码：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class CalculatorTest {
    @Test
    public void testCalculateSum() {
        Calculator calculator = new Calculator();
        int result = calculator.calculateSum(2, 3);
        assertEquals(5, result);
    }
}

2. 使用反射

如果无法通过公共方法间接测试私有方法，可以使用反射来访问和调用私有方法。
示例代码如下：

import java.lang.reflect.Method;

public class ReflectionTestExample {
    private int multiply(int a, int b) {
        return a * b;
    }

    public static void main(String[] args) throws Exception {
        ReflectionTestExample example = new ReflectionTestExample();
        Method method = ReflectionTestExample.class.getDeclaredMethod("multiply", int.class, int.class);
        method.setAccessible(true);
        int result = (int) method.invoke(example, 2, 3);
        System.out.println(result);
    }
}

3. 提取新类

当私有方法的逻辑较为复杂时，可以将其提取到一个新的类中，并将这些方法设置为公共方法，以便进行单元测试。
示例代码如下：

// 原类
public class OriginalClass {
    private HelperClass helper = new HelperClass();

    public int performTask(int a, int b) {
        return helper.add(a, b);
    }
}

// 新类
public class HelperClass {
    public int add(int a, int b) {
        return a + b;
    }
}

测试代码：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class HelperClassTest {
    @Test
    public void testAdd() {
        HelperClass helper = new HelperClass();
        int result = helper.add(2, 3);
        assertEquals(5, result);
    }
}

4. 使用Spring的ReflectionTestUtils

如果项目中使用了Spring框架，可以使用ReflectionTestUtils来调用私有方法。
示例代码如下：

import org.springframework.test.util.ReflectionTestUtils;

public class SpringTestExample {
    private int divide(int a, int b) {
        return a / b;
    }

    public static void main(String[] args) {
        SpringTestExample example = new SpringTestExample();
        int result = (int) ReflectionTestUtils.invokeMethod(example, "divide", 6, 3);
        System.out.println(result);
    }
}

5. 使用Google Guava的@VisibleForTesting注解

可以将私有方法改为包私有或受保护的方法，并使用@VisibleForTesting注解标记，以表明该方法仅用于测试。
示例代码如下：

import com.google.common.annotations.VisibleForTesting;

public class GuavaTestExample {
    @VisibleForTesting
    int subtract(int a, int b) {
        return a - b;
    }
}

核心代码

反射调用私有方法

import java.lang.reflect.Method;

public class ReflectionExample {
    private String privateMethod() {
        return "This is a private method.";
    }

    public static void main(String[] args) throws Exception {
        ReflectionExample example = new ReflectionExample();
        Method method = ReflectionExample.class.getDeclaredMethod("privateMethod");
        method.setAccessible(true);
        String result = (String) method.invoke(example);
        System.out.println(result);
    }
}

Spring的ReflectionTestUtils调用私有方法

import org.springframework.test.util.ReflectionTestUtils;

public class SpringReflectionExample {
    private int privateCalculation(int a, int b) {
        return a + b;
    }

    public static void main(String[] args) {
        SpringReflectionExample example = new SpringReflectionExample();
        int result = (int) ReflectionTestUtils.invokeMethod(example, "privateCalculation", 2, 3);
        System.out.println(result);
    }
}