为什么 JUnit4 要求 @Test 注解的测试方法必须为 public ？

明明如月学长

发布于 2023-05-03 11:45:19

4610

发布于 2023-05-03 11:45:19

在使用 JUnit4 进行单元测试时，我们常常需要为待测方法编写对应的测试方法，并使用 @Test 注解进行标注。然而，在实际使用中，有时我们可能会忘记将测试方法设置为 public，从而导致测试失败。

一个典型的错误信息如下：

org.junit.runners.model.InvalidTestClassError: Invalid test class 'org.example.third.corenlp.CoreNlpDemo':
  1. Method givenSampleText_whenTokenize_thenExpectedTokensReturned() should be public

那么，为什么 JUnit4 要求 @Test 注解方法必须为 public 呢？本文将对这个问题进行深入探讨。

二、原因：JUnit4 和测试方法的访问控制

在 Java 中，访问修饰符（如 public、private、protected 和默认（package-private））定义了类、方法和字段的可见性范围。public 修饰符表示该方法对所有类可见，而其他修饰符则限制了方法的可见范围。 JUnit4 要求测试方法必须为 public，这与测试框架的设计和 Java 语言的访问控制机制有关。

2.1 测试框架设计

JUnit 是一个自动化测试框架，其目的是让我们能够方便地测试我们的代码。为了实现这个目标，JUnit 需要能够找到并执行我们标记为 @Test 的方法。如果这些方法不是 public 的，JUnit 将无法在运行时访问和执行它们，从而无法完成其预期功能。

2.2 Java 访问控制机制

Java 的访问控制机制确保了类、方法和字段在适当的范围内可见。如果我们将测试方法声明为 private、protected 或 package-private，那么 JUnit 可能无法访问这些方法，从而导致测试失败。将测试方法声明为 public 可以确保 JUnit 在运行时可以访问和执行它们。

三、解决方案

3.1 使用时的解决方案

针对开头提到的错误信息，解决方案是将测试方法的访问修饰符设置为 public。请检查并更新该方法的访问修饰符，示例如下：

import org.junit.Test;
import static org.junit.Assert.*;
import org.example.third.corenlp.CoreNlpDemo;

public class CoreNlpDemoTest {
    @Test
    public void givenSampleText_whenTokenize_thenExpectedTokensReturned() {
        // Your test code here
    }
}

请注意，@Test 注解前的方法应该是 public。更新访问修饰符后，重新运行测试，错误应该会消失。

3.2 框架层可能的解决方案：使用反射调用非公有的 @Test 方法

在设计测试框架时，我们可以考虑通过反射机制来调用非公有的 @Test 方法。这样，即使测试方法不是 public，JUnit 也能够找到并执行它们。实际上，JUnit 5 已经实现了类似的功能，允许测试方法具有 package-private 访问级别。然而，这种做法可能会带来一些潜在问题：

可读性和一致性：将测试方法声明为 public 是一种约定，这有助于其他开发者更容易地理解和维护测试代码。如果测试方法可以具有任意的访问修饰符，那么这可能会导致不一致的代码风格和降低代码可读性。
反射性能：使用反射调用方法通常比直接调用方法要慢，尽管这种性能差异在大多数情况下可以忽略不计。然而，对于大型项目和大量的测试用例，这种性能损失可能会累积，导致测试执行速度降低。
访问控制：对于 private 和 protected 方法，它们的访问级别限制是有意义的，因为它们可能包含敏感的实现细节或内部状态，不应该被外部类访问。强制执行公共访问级别有助于确保测试方法遵循良好的设计原则。