java - 什么时候在 Java 中将某些东西注释为 @NotNull 是合适的？

Question

这是我在这里的第一个问题，我是 Java 的新手，所以如果这是一个愚蠢的问题，请原谅我。

我正在使用 JavaDocs 和注释从内部“记录”我的应用程序的预期行为，但我只是好奇在一个方法上使用 @NotNull 是否合适或好的做法永远不应返回 null，但可能是由于 future 的开发人员错误。

谢谢。

Answer 1

这实际上取决于您使用的工具。 @NotNull 注释实际上不做任何事情。实际上，there are several different @NotNull annotations由不同的图书馆提供。除了发出程序员的意图信号外，它们都不会自己做任何事情。

要使注解执行任何操作，您需要将其与将处理注解(在编译时或运行时)的工具结合使用，并对您的代码或数据应用一些验证。例如:

• IntelliJ IDEA contains tools which will check您的代码遵守您包含的可空性注释。
• Bean validation可以在运行时用于检查，例如，用户输入不违反可空性约束。

即使没有工具，我也会说是的，这些注释对于表明意图很有用。如果注释变得不真实，您可以随时将其删除。

在您的情况下，让代码库的所有贡献者使用一个工具(如 IntelliJ IDEA)似乎是个好主意，该工具将在编译时检查是否符合这些注释。这将帮助您避免您描述的开发人员错误类型。