空检查错误消息为“is null”或“为空”

Question

在 Java 代码中进行 null 检查时，如果您为 null 值抛出 IllegalArgumentExceptions，您使用哪种消息模板？

我们倾向于使用这样的东西

public User getUser(String username){
   if (username == null){
     throw new IllegalArgumentException("username is null");   
   }
   // ...
}

：“is null”或“was null”哪个更好，为什么？

对我来说“为空”感觉更自然。

Answer 1

由于 Exception 是由于前置条件检查失败而引发的，我认为您应该声明所违反的要求，而不是简单地陈述事实。

也就是说，不要说“用户名为空”，而是说“用户名不应该为空”。

---

关于使用库进行前置条件检查

作为提示，您可以使用旨在促进前置条件检查的众多库之一。 Guava 中的许多代码都使用 <代码>com.google.common.base.Preconditions

在您自己的方法开始时调用简单的静态方法，以验证正确的参数和状态。这允许诸如

之类的构造

 if (count <= 0) {
   throw new IllegalArgumentException("必须为正数：" + count);
 }

更换为更紧凑的

 checkArgument(count > 0, "必须为正数：%s", count);

结构，这里更直接相关的是它具有

  checkNotNull(username, "username should not be null");

/base/Preconditions.html#checkNotNull(T)" rel="nofollow noreferrer">checkNotNull，它允许您简单地 消息明确指出所违反的要求。

陈述事实的替代方案更加尴尬：

 // Awkward!
 checkArgument(count > 0, "is negative or zero: %s", count);
 checkNotNull(username, "username is null");

此外，这也可能不太有用，因为客户可能已经意识到这一事实，并且异常并不能帮助他们弄清楚实际的需求。是。

---

On IllegalArgumentException 与 NullPointerException

虽然原始代码在 null 参数上抛出 IllegalArgumentException，但 Guava 的 Preconditions.checkNotNull< /code> 会抛出 NullPointerException 。

这符合 API 设定的指南：

NullPointerException< /a>：应用程序应抛出此类的实例以指示 null 对象的其他非法使用。

此外，这里引用了《Effective Java 第二版：第 60 条：支持使用标准异常》：

可以说，所有错误的方法调用都可以归结为非法参数或非法状态，但其他异常通常用于某些类型非法参数和状态。如果调用者在某些禁止使用 null 值的参数中传递 null，则约定将抛出 NullPointerException 而不是 IllegalArgumentException。

Answer 2

为 null，因为参数仍然为 null。

但是，为什么不简单地抛出一个 NullPointerException 而没有消息呢？

Answer 3

我建议说，

  if (userName == null) {
     throw new IllegalArgumentException("username == null");
   }

因为这太致命了，程序员无论如何都必须看看它。在异常消息中引用有问题的代码片段是我能想象的最简洁的事情。

Answer 4

我更愿意这样写：

public User getUser(String username) {
   if (username.length() == 0) {
       throw new IllegalArgumentException("username is empty");   
   }
   // ...
}

一石二鸟。首先，它检测用户名是空字符串的情况，（为了论证）我假设这是一个错误。其次，如果参数为 null，则尝试分派 length 调用将给出 NullPointerException。

根据记录，意外 null 引发的预期异常是 NullPointerException。如果您不使用它的主要原因是 NPE 通常没有消息，请按如下方式编码：

public User getUser(String username){
   if (username == null){
       throw new NullPointerException("username is null");   
   }
   if (username.length() == 0) {
       throw new IllegalArgumentException("username is empty");   
   }
   // ...
}

为什么在这里使用 NPE？因为 NPE 几乎总是表明与其他类型的参数验证错误不同类型的问题；例如，尚未初始化的字段或数组单元格或未正确处理的“可选”值。

最后回答问题：

哪个更好：“is null” 或 “was null”，为什么？

这是一个见仁见智的问题，但我会写“is null”。

• 因为该消息报告的是抛出异常时的状态。
• 因为这样做是惯例。