我希望使我的代码更具可读性，以及使用工具，如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
在等待上游(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 {}
不可否认，这主要是为了装饰或未来的目的，因为上面显然没有为这些注释的静态分析增加任何支持。
如果你在做一个大项目，你最好创建自己的@Nullable和/或@NotNull注解。
例如:
@java.lang.annotation.Documented
@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.CLASS)
@java.lang.annotation.Target({java.lang.annotation.ElementType.FIELD,
java.lang.annotation.ElementType.METHOD,
java.lang.annotation.ElementType.PARAMETER,
java.lang.annotation.ElementType.LOCAL_VARIABLE})
public @interface Nullable
{
}
如果您使用了正确的保留策略，那么注释在运行时将不可用。从这个角度来看，它只是一种内在的东西。
尽管这不是一门严格的科学，但我认为使用内部类是最有意义的。
这是一个内在的东西。(没有功能或技术影响)
有很多很多的用法。
像IntelliJ这样的IDE支持自定义的@Nullable/@NotNull注释。
大多数框架也喜欢使用自己的内部版本。
其他问题(见评论):
如何在IntelliJ中配置这个?
点击IntelliJ状态栏右下角的“警官”。在弹出窗口中单击“配置巡检”。下一个……
如果你正在为android开发，那么你在某种程度上与Eclipse(编辑:在撰写本文时，不再)有一定的联系，它有自己的注释。它包含在Eclipse 3.8+ (Juno)中，但默认禁用。
您可以在首选项> Java >编译器>错误/警告>空分析(底部可折叠部分)中启用它。
勾选“启用基于注释的空分析”
http://wiki.eclipse.org/JDT_Core/Null_Analysis#Usage有关于设置的建议。然而，如果你的工作空间中有外部项目(如facebook SDK)，它们可能不满足这些建议，你可能不想在每次SDK更新时修复它们;-)
我使用:
空指针访问:错误
违反空规范:错误(链接到第1点)
潜在的空指针访问:警告(否则facebook SDK将有警告)
空注释和空推断之间的冲突:警告(链接到第3点)
