Spring单元测试之反射利器：ReflectionTestUtils

Spring单元测试之反射利器：ReflectionTestUtils

• 使用场景
• 核心功能
• • [1. 设置私有字段值](#1. 设置私有字段值)
  • [2. 获取私有字段值](#2. 获取私有字段值)
  • [3. 调用私有方法](#3. 调用私有方法)
• 注意事项
• • [1. 字段名是String](#1. 字段名是String)
  • [2. final字段的限制](#2. final字段的限制)
  • [3. 静态字段的影响](#3. 静态字段的影响)
  • [4. 方法调用的返回值处理](#4. 方法调用的返回值处理)

在编写Java的单元测试时，我们经常会遇到类的私有字段或方法，导致无法顺利地进行测试。例如，一个 Service 类中通过 @Autowired 注入的依赖是私有的，并且没有提供 Setter 方法；或者一个私有方法包含核心逻辑，我们想直接验证它。当然我们可以通过反射直接手动操作，但不仅代码冗长，还容易因为字段名变更出问题。这时，Spring 为我们提供了一个非常实用的工具类------ReflectionTestUtils，它能够让我们在测试中轻松地通过反射操作私有成员。

---

使用场景

1. 依赖注入的私有字段无法直接赋值，尤其是当使用字段注入（@Autowired）且没有 Setter；
2. 某些私有方法包含复杂逻辑，我们希望能直接测试，而不是通过公有方法间接覆盖；
3. 静态字段或常量在测试前需要重置或设置特定值。

---

核心功能

1. 设置私有字段值

setField(Object targetObject, String name, Object value)

设置目标对象指定名称的字段（包括私有字段）的值。

setField(Class<?> targetClass, String name, Object value)

设置类的静态字段的值。

示例：设置 User 类的私有字段 name

public class UserService {
    private String name; // 私有字段
    public void sayHello() { System.out.println("Hello, " + name); }
}

@Test
public void testSayHello() {
    UserService service = new UserService();
    // 通过 ReflectionTestUtils 设置私有字段
    ReflectionTestUtils.setField(service, "name", "Alice");
    
    // 验证行为（无需暴露私有字段）
    service.sayHello(); // 输出 "Hello, Alice"
}

---

2. 获取私有字段值

getField(Object targetObject, String name)

获取目标对象指定名称的字段值。

getField(Class<?> targetClass, String name)

获取类的静态字段值。

示例：验证私有字段的值

// 示例：验证私有字段的值
@Test
public void testPrivateField() {
    User user = new User("Bob", 30);
    String name = (String) ReflectionTestUtils.getField(user, "name");
    assertEquals("Bob", name); // 测试通过
}

---

3. 调用私有方法

invokeMethod(Object targetObject, String name, Object... args)

调用目标对象的指定方法（包括私有方法），参数可变。

invokeMethod(Class<?> targetClass, String name, Object... args)

调用类的静态方法。

示例：测试私有方法 calculateDiscount

public class Order {
    private int price;
    private int calculateDiscount(int rate) { return price * rate / 100; }
    
    public int getDiscountedPrice(int rate) {
        return price - calculateDiscount(rate);
    }
}

@Test
public void testGetDiscountedPrice() {
    Order order = new Order();
    ReflectionTestUtils.setField(order, "price", 100);
    
    // 直接调用私有方法 calculateDiscount
    int discount = (int) ReflectionTestUtils.invokeMethod(order, "calculateDiscount", 10);
    assertEquals(10, discount);
    
    // 验证主逻辑
    assertEquals(90, order.getDiscountedPrice(10));
}

---

注意事项

1. 字段名是String

setField 和 getField 通过字符串指定字段名，如果对其重命名，字符串不会自动更新，会导致测试失败。可以考虑将字段名定义为常量，或者尽量少用字段名的硬编码。

---

2. final字段的限制

对于 final 字段，Java 反射默认不允许修改。如果要对其进行测试，可以通过设置 setAccessible(true) 并借助 java.lang.reflect.Field 的 set 方法来修改。

---

3. 静态字段的影响

修改静态字段会影响到整个 JVM 范围内的所有实例，如果多个测试类共享同一个静态字段，可能会造成测试之间的相互干扰。因此，使用 setField 修改静态字段后，最好在 @AfterEach 或 @AfterAll 中将其还原。

---

4. 方法调用的返回值处理

invokeMethod 返回的是 Object 类型，需要强制转换为实际类型。如果被调用的方法是 void，则返回 null。

---