如何显示方法是否可能返回 null

Question

发布后 这个问题并阅读那个 我意识到知道一个方法是否应该返回 null，或者这是否被认为是错误条件并且应该抛出异常是非常重要的。 还有一个很好的讨论何时返回“null”或抛出异常。

我正在编写一个方法，并且我已经知道是否要返回 null 或引发异常，表达我的决定（换句话说，记录我的合同）的最佳方式是什么？

可以想到：

• 将其写在规范/文档中（有人会读吗？）
• 将其作为方法名称的一部分（正如我建议的此处）
• 假设每个抛出异常的方法不会返回 null，而每个“不”抛出可能返回 null。

我主要讨论的是 java，但它也可能适用于其他语言：Why is there a permanent way to express if例外将被抛出（ throws keywords），但没有正式的方式来表达 if可能会返回null？

为什么没有这样的东西：

public notnull Object methodWhichCannotReturnNull(int i) throws Exception
{
    return null; // this would lead to a compiler error!
}

总结和结论

有很多方法可以表达契约：

• 如果您的 IDE 支持它（如 IntelliJ），最好使用像 @NotNull 这样的注释，因为它是对程序员可见，可用于自动编译时检查。 有一个Eclipse 插件来添加对这些的支持，但它没有为我工作。
• 如果这些不是一个选项，请使用自定义类型，例如 Option 或 NotNull，这会增加清晰度并至少增加运行时检查。
• 无论如何，在 JavaDoc 中记录契约从来没有坏处，有时甚至有帮助。
• 除了我之外，没有人提议使用方法名称来记录返回值的可空性，尽管它可能非常冗长且并不总是有用，但我仍然相信有时它也有其优点。

Answer 1

一个非常好的后续问题。 我认为 null 是一个真正特殊的值，如果一个方法可能返回 null，那么它必须在 Javadoc 中清楚地记录它的情况（@return some value ... ，或 null 如果...）。 在编码时，我是防御性的，并假设一个方法可能返回 null ，除非我确信它不能（例如，因为 Javadoc 是这么说的）。

人们意识到这是一个问题，并且建议的解决方案是使用注释以可以自动检查的方式来陈述意图。 请参阅JSR 305：软件缺陷检测注释、JSR 308：Java 类型注释 和 JetBrain 的可为空操作方法。

您的示例可能如下所示，并被 IDE、编译器或其他代码分析工具拒绝。

@NotNull
public Object methodWhichCannotReturnNull(int i) throws Exception
{
    return null; // this would lead to a compiler error!
}

Answer 2

您可以使用选项< /a> 类型，它非常类似于具有零个或一个元素的列表。 Option

示例：

public Option<Integer> parseInt(String s) {
   try {
      return Option.some(Integer.parseInt(s));
   }
   catch (Exception e) {
      return Option.none();
   }
}

如果您始终使用此选项，则可以打开 IDE null 警告，或者仅使用 grep 来处理 null，如果您使用 Option.none()，则该警告根本不应该出现在您的代码中 在通常使用 null 文字的地方。

Option 是 Scala 的标准配置，在 Haskell 中称为 Maybe。 上面的链接是一个名为 Functional Java 的库，其中包含它。 该版本实现了 Iterable 接口，并具有可让您很好地组合事物的一元方法。 例如，在 None 的情况下提供默认值 0：

int x = optionalInt.orSome(0);

您可以用此替换...

if (myString != null && !"".equals(myString))

如果您有 Option， ... >...

for (String s : myOptionString)

Answer 3

IntelliJ IDEA 中对 @Nullable 和 @NotNull 注释提供了一些支持。 还有一些关于将这些注释（或类似功能）添加到 Java 7 的讨论。不幸的是，我不知道这已经进展到什么程度，也不知道它是否仍然在正轨上。

Answer 4

事实上：在我们的框架中，我们有一个“非空”指针类型，它可以被返回以指示该方法将始终返回一个值。

我看到三个选项：

1. 等待语言支持来表达它（例如 C# ?! 东西）
2. 使用切面方向构建您自己的语言扩展来表达它
3. 使用自定义类型来表达它
4. （但建立在开发人员合作的基础上）使用命名方案来表达它

Answer 5

对于 Java，可以使用方法的 Javadoc 描述来记录返回值的含义，包括它是否可以为 null。 正如已经提到的，注释也可以在这里提供帮助。

另一方面，我承认我并不认为 null 是值得害怕的东西。 在某些情况下，“无人在家”是一个有意义的条件（尽管空对象技术在这里也具有实际价值）。

尝试对空值进行方法调用确实会导致异常。 但尝试除以零也是如此。 这并不意味着我们需要开展消除零的运动！ 这只是意味着我们需要理解方法上的约定，并利用它返回的值做正确的事情。

Answer 6

不惜一切代价，避免依赖 JavaDocs。 人们只有在签名看起来不琐碎且不言自明的情况下才会阅读它们（这从一开始就很糟糕），而那些真正费心阅读它们的人不太可能在空值上犯错误，因为他们目前更加小心。

Answer 7

您是否看过Spec#？

Answer 8

您可以编写自己的注释 (Java) 或属性 (C#) 来指示返回值可能为 null。 没有任何东西会自动检查它（尽管 .NET 4.0 将具有代码契约这类事情）但它至少可以充当文档。

Answer 9

也许您可以定义一个名为“NotNull”的泛型类，以便您的方法可能类似于：

public NotNull<Object> methodWhichCannotReturnNull(int i) throws Exception
{
   // the following would lead to a run-time error thown by the
   // NotNull constructor, if it's constructed with a null value
   return new NotNull<Object>(null);
}

这仍然是运行时（不是编译时）检查，但是：

• 它是在方法的实现中抛出的（它不是调用代码中的错误）
• 它是自记录的（调用者知道他将 NotNull 作为返回类型）

Answer 10

如果您使用的是 Java 5+，您可以使用自定义注释，例如 @MayReturnNull

UPDATE

抛开所有编码哲学（返回 null、使用异常、断言、yada yada），我希望以上回答您的问题问题。 除了具有默认值的基元之外，复杂类型可能为空，也可能不为空，并且您的代码需要处理它。

Answer 11

一般来说，我会假设默认情况下返回 null 值是违反 API 约定的。 几乎总是可以将代码设计为在“正常”执行流程期间永远不会从 API 返回空值。 （例如，检查 foo.contains(obj) 而不是调用 foo.get(obj) 并为 null 建立一个单独的分支。或者，使用 空对象模式。

如果您无法以这种方式设计 API，我会清楚地记录何时以及为何会抛出空值 - 至少在 Javadoc 中，也可能使用自定义 @annotation，如其他几个答案所建议的那样。