同时使用@Nonnull和Preconditions.checkNotNull(.)

Question

用@Nonnull注释一个参数，然后用Preconditions.checkNotNull()检查这个参数是否有意义？

他们之间有什么区别？据我所知，使用@Nonnull只会指定一个契约，但除非在IDE中告诉它，否则不会进行进一步检查。这是正确的吗？

Answer 1

区别在于规范和实现之间的区别。@NonNull给出了例程的规范，Preconditions.checkNotNull()给出了验证例程的一种方法。

@NonNull指定了一个形式参数的契约:不应该用null作为相应的实际参数来调用该方法。

有多种方法来验证这样的规范。

• 您可以使用assert语句执行运行时检查，或者等效地使用Preconditions.checkNotNull()执行运行时检查.这将动态地发现在运行时违反合同的情况，并使程序崩溃。这使得您的代码更容易调试，因为它提供了早期的警告消息，但它并没有提高代码质量。
• 您可以使用IDE或其他工具在编译时执行静态检查。如果您使用一个健全的工具，您将得到一个保证，任何可能的执行都不会违反规范并使程序崩溃。

您需要对您的方法进行规范，以记录应该如何使用它。您最好使用@NonNull注释，而不是用英语编写Javadoc，因为@NonNull是简洁的和机器可读的。因此，您应该编写@NonNull注释。

验证规范的正确性是可选的，但很有用。使用运行时检查和静态检查进行验证是一种带吊杆的方法.它使用两种不同的技术来验证规范。如果使用不健全的静态检查工具(如FindBugs )，那么执行运行时检查是个好主意，因为即使FindBugs没有发出任何警告，代码中仍然可能存在空错误。如果使用声音工具(如零度检查器 of 检查框架 )，则运行时检查是无关的。不过，它们并不会造成太大的伤害:只是一点代码混乱和一些运行时开销。

(请注意，如果将空值作为参数传递，规范可以要求抛出特定的异常。这将要求方法主体包含代码(如Preconditions.checkNotNull() )，即使您已经证明您的程序从未传递空。指示抛出的确切异常的规范对客户端代码并不特别有用。客户端只想知道在什么情况下调用会成功，而客户机不太可能有专门针对NullPointerException的NullPointerException块。因此，客户端在规范中需要的主要信息是null是一个非法值。