我应该使用哪个@NotNull Java注释?

我希望使我的代码更具可读性，以及使用工具，如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

当前回答

Spring 5在包级别上有@NonNullApi。对于已经具有Spring依赖项的项目来说，这似乎是一个方便的选择。所有字段、参数和返回值默认为@NonNull和@Nullable，可以应用在少数不同的地方。

文件package-info.java:

@org.springframework.lang.NonNullApi
package com.acme;

https://docs.spring.io/spring-data/commons/docs/current/reference/html/#repositories.nullability.annotations

2020-05-11 08:39:44

其他回答

安卓

这个答案是Android特有的。Android有一个支持包叫做support-annotations。它提供了几十个Android特定的注释，也提供了常见的注释，如NonNull, Nullable等。

要添加support-annotations包，在build.gradle中添加以下依赖项:

compile 'com.android.support:support-annotations:23.1.1'

然后使用:

import android.support.annotation.NonNull;

void foobar(@NonNull Foo bar) {}

2015-10-10 19:57:03

在等待上游(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 {}

不可否认，这主要是为了装饰或未来的目的，因为上面显然没有为这些注释的静态分析增加任何支持。

2011-07-26 10:47:38

较新的项目可能应该使用jakarta。annotation-api(雅加达。注释包)。它从现在的只读javax链接。注释回购和适应新的Jakarta生态系统，旨在将社区从所有与javax相关的头痛中解放出来。

2021-10-15 07:02:53

太阳现在没有自己的了吗?这是什么: http://www.java2s.com/Open-Source/Java-Document/6.0-JDK-Modules-com.sun/istack/com.sun.istack.internal.htm

这似乎与我在过去几年中使用过的所有Java版本都打包在一起。

编辑:正如下面评论中提到的，你可能不想使用这些。在这种情况下，我的投票是IntelliJ jetbrains注释!

2011-02-10 22:41:51

不幸的是，JSR 308将不会添加比这个项目本地非空建议更多的值

Java 8将不会提供单一的默认注释或自己的Checker框架。类似于Find-bugs或JSR 305，这个JSR由一小群主要是学术团队维护得很差。

它背后没有商业力量，因此JSR 308现在发布EDR 3 (JCP的早期草案审查)，而Java 8应该在不到6个月内发布:-O 顺便说一句，类似于310。但与308不同的是，Oracle现在已经从其创始人手中接管了这一业务，以最大限度地减少它对Java平台的伤害。

每个项目、供应商和学术类，比如检查器框架和JSR 308背后的那些，都将创建自己的专有检查器注释。