我希望使我的代码更具可读性，以及使用工具，如IDE代码检查和/或静态代码分析(FindBugs和Sonar)，以避免nullpointerexception。许多工具似乎与彼此的@NotNull/@NonNull/ @NonNull注释不兼容，在我的代码中列出所有这些工具会让人难以阅读。有没有什么建议，哪一个是“最好的”?下面是我找到的等价注释列表:
javax.validation.constraints.NotNull
Created for runtime validation, not static analysis.
documentation
edu.umd.cs.findbugs.annotations.NonNull
Used by FindBugs (dead project) and its successor SpotBugs static analysis and therefore Sonar (now Sonarqube)
FindBugs documentation, SpotBugs documentation
javax.annotation.Nonnull
This might work with FindBugs too, but JSR-305 is inactive. (See also: What is the status of JSR 305?)
source
org.jetbrains.annotations.NotNull
Used by IntelliJ IDEA IDE for static analysis.
documentation
lombok.NonNull
Used to control code generation in Project Lombok.
Placeholder annotation since there is no standard.
source,
documentation
androidx.annotation.NonNull
Marker annotation available in Android, provided by annotation package
documentation
org.eclipse.jdt.annotation.NonNull
Used by Eclipse for static code analysis
documentation
JSR305和FindBugs是由同一个人编写的。两者的维护都很差，但都是标准的，并且得到所有主要ide的支持。好消息是，他们工作得很好。
下面是如何在默认情况下将@Nonnull应用到所有类、方法和字段。
参见https://stackoverflow.com/a/13319541/14731和https://stackoverflow.com/a/9256595/14731
定义@NotNullByDefault
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import javax.annotation.Nonnull;
import javax.annotation.meta.TypeQualifierDefault;
/**
* This annotation can be applied to a package, class or method to indicate that the class fields,
* method return types and parameters in that element are not null by default unless there is: <ul>
* <li>An explicit nullness annotation <li>The method overrides a method in a superclass (in which
* case the annotation of the corresponding parameter in the superclass applies) <li> there is a
* default parameter annotation applied to a more tightly nested element. </ul>
* <p/>
* @see https://stackoverflow.com/a/9256595/14731
*/
@Documented
@Nonnull
@TypeQualifierDefault(
{
ElementType.ANNOTATION_TYPE,
ElementType.CONSTRUCTOR,
ElementType.FIELD,
ElementType.LOCAL_VARIABLE,
ElementType.METHOD,
ElementType.PACKAGE,
ElementType.PARAMETER,
ElementType.TYPE
})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotNullByDefault
{
}
2. 将注释添加到每个包:package-info.java
@NotNullByDefault
package com.example.foo;
更新:截至2012年12月12日，JSR 305被列为“休眠”。根据文档:
被执行委员会投票为“休眠”的JSR，或者已经达到自然生命周期的JSR。
看起来JSR 308正在加入JDK 8，尽管JSR没有定义@NotNull，但是附带的Checkers框架定义了。在撰写本文时，由于这个错误，Maven插件无法使用:https://github.com/typetools/checker-framework/issues/183
在等待上游(Java 8?)整理这些注释时，您还可以定义自己的项目本地@NotNull和@Nullable注释。这在使用Java SE时也很有用，因为默认情况下javax.validation.constraints是不可用的。
import java.lang.annotation.*;
/**
* Designates that a field, return value, argument, or variable is
* guaranteed to be non-null.
*/
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE})
@Documented
@Retention(RetentionPolicy.CLASS)
public @interface NotNull {}
/**
* Designates that a field, return value, argument, or variable may be null.
*/
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE})
@Documented
@Retention(RetentionPolicy.CLASS)
public @interface Nullable {}
不可否认，这主要是为了装饰或未来的目的，因为上面显然没有为这些注释的静态分析增加任何支持。
根据Java 7的特性列表，JSR-308类型注释被推迟到Java 8。甚至没有提到JSR-305注释。
在最新的JSR-308草案的附录中有一些关于JSR-305状态的信息。这包括观察到JSR-305注释似乎被抛弃了。JSR-305页面还将其显示为“inactive”。
同时，实用的答案是使用最广泛使用的工具所支持的注释类型……如果情况发生变化，也要做好改变的准备。
事实上，JSR-308没有定义任何注释类型/类，而且看起来他们认为这超出了范围。(考虑到JSR-305的存在，他们是正确的)。
然而，如果JSR-308真的想要加入Java 8，那么如果人们对JSR-305重新产生兴趣，我也不会感到惊讶。AFAIK, JSR-305团队还没有正式放弃他们的工作。他们已经沉默了2年多了。
有趣的是，Bill Pugh (JSR-305的技术主管)是FindBugs背后的人之一。
如果您正在使用Spring 5。2.执行以下命令:你应该使用Spring注释(org.springframework.lang)，因为它们通过@NonNullFields和@NonNullApi注解为你提供了默认的包范围的null检查。当你使用@NonNullFields/@NonNullApi时，你甚至不会与来自其他依赖的其他NotNull/NonNull注释发生冲突。注释必须用在一个名为package-info.java的文件中，该文件位于包的根目录下:
@NonNullFields
@NonNullApi
package org.company.test;
要排除null检查中的某些字段、参数或返回值，只需显式地使用@Nullable注释。而不是使用@NonNullFields/@NonNullApi，你也可以在任何地方设置@NonNull，但可能更好的是在默认情况下使用@NonNullFields/@NonNullApi激活null检查，并且只使用@Nullable执行特定的异常。
IDE (Intellij)将突出显示违反null条件的代码。如果设置正确，每个开发人员都可以假设字段、参数和返回值必须不是空，除非有@Nullable注释。要了解更多信息，请查看这篇文章。
