java - 单元测试中@Nonnull 注释的 Intellij IDEA 警告

Question

假设我有一个方法，其中一些参数使用 javax @Nonnull 注释进行注释。

public Something supply(@Nonnull SomeObject someObject) {
    (...)
    if (someObject == null) throw new ValidationException("Required parameter is null");
    (...)
}

当我尝试使用显式 null 参数调用此方法时，IDE 会正确地通知我，如下所示:

somethingSupplier.supply(null);

现在我想做的是创建单元测试，检查是否会抛出适当的异常，如果由于某种原因传递给此方法的参数恰好为 null(假设它是某种验证异常)。

如果我尝试像上面的示例一样调用此方法，IDE 将警告我将 null 传递给@Nonnull...但这正是我在这里想要做的。我可以使用 @SuppressWarnings("ConstantConditions") 注释调用或方法甚至测试类，但它会使代码困惑，而且我可能不会收到关于我在代码中犯的其他无意错误的警告。

所以问题是我是否可以以某种方式在测试类中禁用对@Nonnull 的检查？或者我根本不应该对这些案例进行单元测试？

Answer 1

如果要针对错误情况测试代码行为，是否不可避免地会创建关于被测代码规则错误的代码。如果这些规则可以由 IDE 检查，显然，这些检查将检测到并抑制这些警告是不可避免的。

与抑制警告一样，您应该尽量缩小应用抑制的代码范围。例如，您可以在测试代码中创建一个工厂方法，提供这样一个非法值，该值在基于类型系统的检查的雷达下飞行:

class IllegalValue {
    @SuppressWarnings("ConstantConditions")
    static @Nonnull <T> T sneakyNullReference() {
        return null;
    }
}

这样你就限制了对这个小的单一方法的抑制。在您的测试用例中，您可以使用 IllegalValue.sneakyNullReference() 来测试代码的 null 行为，而无需额外抑制，因此在使用 null 时正确地收到警告> 在测试代码中不合适的地方。我强烈建议永远不要将 sneakyNullReference() 的结果存储到变量中，而是始终在需要的地方直接引用，为清楚起见。

即在你的问题测试中，代码应该是这样的

somethingSupplier.supply(IllegalValue.sneakyNullReference());

所以读者可以立即理解这里测试的是什么......