首页 / JAVA / 我应该使用哪个@NotNull Java注释？

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

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了我应该使用哪个@NotNull Java注释？，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含7320字，纯文字阅读大概需要11分钟。

内容图文

我希望使我的代码更具可读性,并使用IDE代码检查和/或静态代码分析(FindBugs和Sonar)等工具来避免NullPointerExceptions.许多工具似乎与彼此不兼容的@NotNull / @NonNull / @Nonnull注释并列出我的代码中的所有这些工具都很难阅读.有什么建议是“最好的”吗？这是我发现的等效注释列表：

> javax.validation.constraints.NotNull
创建用于运行时验证,而不是静态分析.
documentation
> edu.umd.cs.findbugs.annotations.NonNull
由Findbugs静态分析使用,因此声纳(现在Sonarqube)
documentation
> javax.annotation.Nonnull
这可能也适用于Findbugs,但JSR-305处于非活动状态. (另见：What is the status of JSR 305?)
source
> org.jetbrains.annotations.NotNull
由IntelliJ IDEA IDE用于静态分析.
documentation
> lombok.NonNull
用于控制Project Lombok中的代码生成.
占位符注释,因为没有标准.
source,
documentation
> android.support.annotation.NonNull
Android中提供的标记注释,由support-annotations包提供
documentation
> org.eclipse.jdt.annotation.NonNull
由Eclipse用于静态代码分析
documentation

解决方法:

自JSR 305(其目标是标准化@NonNull和@Nullable)以来已经蛰伏了几年,我担心没有好的答案.我们所能做的就是找到一个实用的解决方案,我的如下：

句法

从纯粹的风格角度来看,我想避免任何对IDE,框架或除Java本身之外的任何工具包的引用.

这排除了：

> android.support.annotation
> edu.umd.cs.findbugs.annotations
> org.eclipse.jdt.annotation
> org.jetbrains.annotations
> org.checkerframework.checker.nullness.qual
> lombok.NonNull

这给我们留下了javax.validation.constraints或javax.annotation.
前者配有JEE.如果这比javax.annotation更好,这可能最终会出现在JSE中,或者从来没有出现过,这是一个有争议的问题.
我个人更喜欢javax.annotation,因为我不喜欢JEE依赖.

这让我们失望了

javax.annotation中

这也是最短的一个.

只有一种语法更好：java.annotation.Nullable.随着其他包的毕业
从javax到java过去,javax.annotation会
迈出正确方向的一步.

履行

我希望他们都有基本相同的琐碎实现,
但详细的分析表明,事实并非如此.

首先是相似之处：

@NonNull注释都有这一行

public @interface NonNull {}

除了

> org.jetbrains.annotations,它将其称为@NotNull,并且具有简单的实现
> javax.annotation具有更长的实现
> javax.validation.constraints也称它为@NotNull并具有实现

@Nullable注释都有这一行

public @interface Nullable {}

除了(再次)org.jetbrains.annotations及其简单的实现.

对于差异：

一个引人注目的是

> javax.annotation
> javax.validation.constraints
> org.checkerframework.checker.nullness.qual

都有运行时注释(@Retention(RUNTIME),而

> android.support.annotation
> edu.umd.cs.findbugs.annotations
> org.eclipse.jdt.annotation
> org.jetbrains.annotations

只是编译时间(@Retention(CLASS)).

如this SO answer所述,运行时注释的影响
比人们想象的要小,但它们有好处
启用运行时检查的工具除了
编译时间.

另一个重要的区别是在代码中可以使用注释.
有两种不同的方法.某些包使用JLS 9.6.4.1样式上下文.下表给出了概述：


                                FIELD   METHOD  PARAMETER LOCAL_VARIABLE 
android.support.annotation      X       X       X   
edu.umd.cs.findbugs.annotations X       X       X         X
org.jetbrains.annotation        X       X       X         X
lombok                          X       X       X         X
javax.validation.constraints    X       X       X

org.eclipse.jdt.annotation,javax.annotation和org.checkerframework.checker.nullness.qual使用在中定义的上下文
JLS 4.11,在我看来是正确的方法.

这让我们失望了

> javax.annotation
> org.checkerframework.checker.nullness.qual

在这一轮.

码

为了帮助您自己比较更多详细信息,我列出了下面每个注释的代码.
为了便于比较,我删除了注释,导入和@Documented注释.
(他们都有@Documented,除了Android包中的类).
我重新排序了行和@Target字段并对资格进行了规范化.

package android.support.annotation;
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER})
public @interface NonNull {}

package edu.umd.cs.findbugs.annotations;
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
public @interface NonNull {}

package org.eclipse.jdt.annotation;
@Retention(CLASS)
@Target({ TYPE_USE })
public @interface NonNull {}

package org.jetbrains.annotations;
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
public @interface NotNull {String value() default "";}

package javax.annotation;
@TypeQualifier
@Retention(RUNTIME)
public @interface Nonnull {
    When when() default When.ALWAYS;
    static class Checker implements TypeQualifierValidator<Nonnull> {
        public When forConstantValue(Nonnull qualifierqualifierArgument,
                Object value) {
            if (value == null)
                return When.NEVER;
            return When.ALWAYS;
        }
    }
}

package org.checkerframework.checker.nullness.qual;
@Retention(RUNTIME)
@Target({TYPE_USE, TYPE_PARAMETER})
@SubtypeOf(MonotonicNonNull.class)
@ImplicitFor(
    types = {
        TypeKind.PACKAGE,
        TypeKind.INT,
        TypeKind.BOOLEAN,
        TypeKind.CHAR,
        TypeKind.DOUBLE,
        TypeKind.FLOAT,
        TypeKind.LONG,
        TypeKind.SHORT,
        TypeKind.BYTE
    },
    literals = {LiteralKind.STRING}
)
@DefaultQualifierInHierarchy
@DefaultFor({TypeUseLocation.EXCEPTION_PARAMETER})
@DefaultInUncheckedCodeFor({TypeUseLocation.PARAMETER, TypeUseLocation.LOWER_BOUND})
public @interface NonNull {}

为了完整性,这里是@Nullable实现：

package android.support.annotation;
@Retention(CLASS)
@Target({METHOD, PARAMETER, FIELD})
public @interface Nullable {}

package edu.umd.cs.findbugs.annotations;
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
@Retention(CLASS)
public @interface Nullable {}

package org.eclipse.jdt.annotation;
@Retention(CLASS)
@Target({ TYPE_USE })
public @interface Nullable {}

package org.jetbrains.annotations;
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
public @interface Nullable {String value() default "";}

package javax.annotation;
@TypeQualifierNickname
@Nonnull(when = When.UNKNOWN)
@Retention(RUNTIME)
public @interface Nullable {}

package org.checkerframework.checker.nullness.qual;
@Retention(RUNTIME)
@Target({TYPE_USE, TYPE_PARAMETER})
@SubtypeOf({})
@ImplicitFor(
    literals = {LiteralKind.NULL},
    typeNames = {java.lang.Void.class}
)
@DefaultInUncheckedCodeFor({TypeUseLocation.RETURN, TypeUseLocation.UPPER_BOUND})
public @interface Nullable {}

以下两个包没有@Nullable,所以我单独列出它们
Lombok有一个非常无聊的@NonNull.
在javax.validation.constraints中,@ NonNull实际上是@NotNull
它实施起来很长.

package lombok;
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
public @interface NonNull {}

package javax.validation.constraints;
@Retention(RUNTIME)
@Target({ FIELD, METHOD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Constraint(validatedBy = {})
public @interface NotNull {
    String message() default "{javax.validation.constraints.NotNull.message}";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default {};
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        NotNull[] value();
    }
}

支持

从我的经验来看,javax.annotation至少得到Eclipse和Checker Framework的支持.

摘要

我理想的注释是带有Checker Framework实现的java.annotation语法.

如果您不打算使用Checker Framework,那么javax.annotation(JSR-305)仍然是您最好的选择.

如果您愿意购买Checker Framework,请使用
他们的org.checkerframework.checker.nullness.qual.

来源

> android-5.1.1_r1.jar中的android.support.annotation
>来自findbugs-annotations-1.0.0.jar的edu.umd.cs.findbugs.annotations
> org.eclipse.jdt.annotation_2.1.0.v20160418-1457.jar中的org.eclipse.jdt.annotation
>来自jetbrains-annotations-13.0.jar的org.jetbrains.annotations
>来自gwt-dev-2.5.1-sources.jar的javax.annotation
> checker-framework-2.1.9.zip中的org.checkerframework.checker.nullness.qual
>来自lombok的lombok提交f6da35e4c4f3305ecd1b415e2ab1b9ef8a9120b4
>来自validation-api-1.0.0.GA-sources.jar的javax.validation.constraints

内容总结

以上是互联网集市为您收集整理的我应该使用哪个@NotNull Java注释？全部内容，希望文章能够帮你解决我应该使用哪个@NotNull Java注释？所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/716568.html

来源：【匿名】

【上一篇】获取当前在Java中运行的所有线程的列表【下一篇】JAVA/JSP学习系列之五

更多 ►

【我应该使用哪个@NotNull Java注释？】教程文章相关的互联网学习教程文章

java中null和""的区别

问题一：null和""的区别String s=null;s.trim()就会抛出为空的exception String s=""; s.trim()就不会抛,为什么?答：NULL代表声明了一个空对象，根本就不是一个字符串。 ""代表声明了一个对象实例，这个对象实例的值是一个长度为0的空字符串。NULL代表声明了一个空对象,对空对象做任何操作都不行的,除了=和==;""是一个字符串了,只是这个字符串里面没有内容了。String s=null;只是定义了一个句柄，也就是说你有了个引用，但是这个...

Java中有关Null的9件事【代码】

对于Java程序员来说，null是令人头痛的东西。时常会受到空指针异常（NPE）的骚扰。连Java的发明者都承认这是他的一项巨大失误。Java为什么要保留null呢？null出现有一段时间了，并且我认为Java发明者知道null与它解决的问题相比带来了更多的麻烦，但是null仍然陪伴着Java。我越发感到惊奇，因为java的设计原理是为了简化事情，那就是为什么没有浪费时间在指针、操作符重载、多继承实现的原因，null却与此正好相反。好吧，我真的不知...

空指针异常Caused by: java.lang.NullPointerException: null【图】

Caused by: java.lang.NullPointerException: null在写测试文件时遇到这个问题，看了一晚上都没找到哪里错误，虽然最后的问题很简单，但是写下来自己解决问题的思路。1，首先debug 查看断点，看数据是否传进来。发现没问题。2，然后查看日志发现40行的空指针异常，说明是mockthis()的问题，数据都传进去了哪里异常这里可以排除思路没问题，那就去看代码，后来发现，数据传错参数了，哈哈哈哈有点虎，以后要记得看日志，自己检...

Java8（5）：使用 Optional 处理 null【代码】【图】

Java8（5）：使用 Optional 处理 null MiZhou 关注2017.03.16 17:17* 字数 1548 阅读 12069评论 5喜欢 36写过 Java 程序的同学，一般都遇到过 NullPointerException :) —— 为了不抛出这个异常，我们便会写如下的代码：User user = getUserById(id); if (user != null) {String username = user.getUsername();System.out.println("Username is: " + username); // 使用 username } 但是很多时候，我们可能会忘记写 if (user != n...

java web项目服务端返回json结果时过滤字段为null的属性【代码】

import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary; import org.springframework.http.converter.jso...

JavaScript中判断null、undefined与NaN的方法

1.判断undefined:?1234vartmp = undefined; if(typeof(tmp) == "undefined"){ alert("undefined"); }说明：typeof 返回的是字符串，有六种可能："number"、"string"、"boolean"、"object"、"function"、"undefined" 2.判断null:?1234vartmp = null; if(!tmp && typeof(tmp)!="undefined"&& tmp!=0){ alert("null"); }3.判断NaN: （NAN not a number）?1234vartmp = 0/0; if(isNaN(tmp)){ alert("NaN"); }说明：如果把 NaN 与任何值...

javascript Null、Undefined 、NaN的联系与区别【代码】

相信许多初学 javascript 都会有这种想法：为什么 javascript 有 null 又有 undefined ，相对 C ， C++ ，Java ，他们都是只有 null 而已，为什么 javascript 就不同一、历史原因通过网络搜索得知，1995年JavaScript诞生时，最初像Java一样，只设置了null作为表示"无"的值。根据C语言的传统，null被设计成可以自动转为0。但是，JavaScript的设计者Brendan Eich，觉得这样做还不够，有两个原因。首先，null像在Java里一样，...

返回零长度的数组或者集合，而不是null——Effective Java 读书笔记【代码】

/*** 返回零长度的数组或者集合，而不是null* * @author 刘向峰* */publicclassShop {private List<Object> objectList;// 零长度数组常量被传递给toArray方法，以指明所期望的返回类型privatefinalstatic Object[] EMPTY_OBJECT_ARRAY = new Object[0];publicShop(List<Object> objectList) {super();this.objectList = objectList;}/*** * @return an array containing all of the object in the shop*/public Object[] getObjec...

javascript高级程序设计--浅析undefined与null的区别

浅析undefined与null的区别相似处：1、undefined 和 null 都是javascript 的基本数据类型。其实两者没有太大区别。定义：var a=undefined; var a=null; null==undefined;//true2、null是一个表示"无"的对象，转为数值时为0；undefined是一个表示"无"的原始值，转为数值时为NaN。Number(undefined)//NaN 5 + undefined //NaN而对于nullNumber(null) // 0 5 + null // 5区别1、null表示"没有对象"，即该处不应该有值。典型用法是：（...

Java千百问_06数据结构（008）_null属于哪种数据类型【代码】

点击进入_更多_Java千百问1、null属于哪种数据类型首先，在java中，null本身不是对象，也不是Objcet的实例。那么他属于哪种数据类型呢？了解数据类型看这里：java中数据类型是什么 java基本数据类型看这里：[java有哪8种基本数据类型3 具体看下面这个例子：if (null instanceof java.lang.Object) {System.out.println("null属于java.lang.Object类型"); } else {System.out.println("null不属于java.lang.Object类型"); }结果：...

Java 空对象设计模式(Null Object Pattern) 讲解【代码】【图】

转自：http://www.cnblogs.com/haodawang/articles/5962531.html有时候我们的代码中为避免 NullPointerException 会出现很多的对Null的判断语句，而这些语句一旦多起来，我们的代码就会变的惨不忍睹，因此我们引入了空对象模式（null object pattern）以此来使我们的代码变的更优雅一点。下面来看一下空对象模式的大概视图为了方便我这里就直接用手写的了，大家谅解一下:），凑合着看吧假如我们需要查询某个学生的信息，我们输入学...

JAVA8之妙用Optional解决判断Null为空的问题【代码】

直接上实战 //以前写法 public String getCity(User user) throws Exception{if(user!=null){if(user.getAddress()!=null){Address address = user.getAddress();if(address.getCity()!=null){return address.getCity();}}}throw new Excpetion("取值错误"); }//java8写法 public String getCity(User user) throws Exception{return Optional.ofNullable(user).map(u-> u.getAddress()).map(a->a.getCity()).orElseThrow(()->n...

java-普通类文件@Autowired自动注入为null【代码】

@Autowired注解在非Controller中注入为null1、配置文件（类文件所在的包）<context:component-scan base-package="net.nblh.utils.common"/>2、类文件关于@PostConstruct：被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器调用一次，类似于Serclet的inti()方法。被@PostConstruct修饰的方法会在构造函数之后，init()方法之前运行。@Component //申明为spring组件publicclass GetSpeechRecognitionInf...

Null作为参数的时候，Java编译器如何调用函数？【代码】【图】

1publicclass TestNull {2publicvoid method(Object o){3 System.out.println("Object Version");4 }5 6publicvoid method(String s){7 System.out.println("String Version");8 }910publicstaticvoid main(String[] args) { 11 TestNull tn= new TestNull(); 12 tn.method(null); 13 } 1415 }　　　编译可以通过，运行结果如下：　　那么，Null作为参数的时候究竟如何调用函数？回答这个...

oracle10g登录em后,提示“java.lang.Exception: Exception in sending Request :: null”【图】

出现错误时登录企业管理器时出现的界面出现这种错误一般是因为没有设置时区，一般默认的是agentTZRegion=GMT，也就是GMT。所以大家只要设置了这个东西，然后重新启动dbconsole就可以了。下面是设置以及重新启动dbconsole的全过程。第一步，在Oracle安装目录中找打这个文件emd.properties（以往大家都是找不到这个文件在哪里），D:\oracle\product\10.2.0\db_1\PC-20111014FOHC_orcl\sysman\config，我的这个文件就是在这个路径下。...

首页 / JAVA / 我应该使用哪个@NotNull Java注释？

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

内容导读

内容图文

内容总结

内容备注

内容手机端

【我应该使用哪个@NotNull Java注释？】教程文章相关的互联网学习教程文章

java中null和""的区别

Java中有关Null的9件事【代码】

空指针异常Caused by: java.lang.NullPointerException: null【图】

Java8（5）：使用 Optional 处理 null【代码】【图】

java web项目服务端返回json结果时过滤字段为null的属性【代码】

JavaScript中判断null、undefined与NaN的方法

javascript Null、Undefined 、NaN的联系与区别【代码】

返回零长度的数组或者集合，而不是null——Effective Java 读书笔记【代码】

javascript高级程序设计--浅析undefined与null的区别

Java千百问_06数据结构（008）_null属于哪种数据类型【代码】

Java 空对象设计模式(Null Object Pattern) 讲解【代码】【图】

JAVA8之妙用Optional解决判断Null为空的问题【代码】

java-普通类文件@Autowired自动注入为null【代码】

Null作为参数的时候，Java编译器如何调用函数？【代码】【图】

oracle10g登录em后,提示“java.lang.Exception: Exception in sending Request :: null”【图】

JAVA - 相关标签

注释 - 相关标签

JAVA - 技术教程分类

JAVA - 最新教程

JAVA - 最热教程