日常码 Java 的时候经常会遇到几个常用的 annotations,经常要用到 @NonNull,@NotNull 以及 @Nonnull。每次用都要查,每次查完又会忘掉,这里特意来总结一下以后用来自查。英文比较全的解释可以参考 stackoverflow 。
lombok.NonNull
这个 annotation 是 lombok 提供的,根据官方的解释可以看出它是用来辅助生成代码的。如果使用在 parameter 前,lombok 将生成一段代码来检测 parameter 是否为 null
,如果是则 throw 一个 NullPointerException
。 如果使用在 field 前,lombok 会在这个 field 相应的生成代码中加入 null
检测。
public static void test(@NonNull String args){
System.out.println(args);
}
build的代码,反编译后查看是
public static void test(@NonNull String args) {
if (args == null) {
throw new NullPointerException("args is marked non-null but is null");
} else {
System.out.println(args);
}
}
javax.annotation.Nonnull
这个很容以和上一次混了,因为名字几乎一样。它实际上只是提供给 IDE 来辅助检测代码中是否非法的传递了 null
给一个 parameter。这是一个静态的检测,所以在运行时不会有任何提示。
【javax.annotation.Nonnull
是在spring-core的依赖中使用到了,此注解的定义在com.google.code.findbugs:jsr305:3.0.2中
】
javax.validation.constraints.NotNull
如果项目使用了 Bean 的 validation 框架,那么在定义一些 field 的时候可能会用到 @NotNull
。这个是用来帮助检测用户输入的,强制某些用户输入值不可以为 null
。作用和 @Max
和 @Min
类似。
个人感觉,实际作用并不大。最好的方式,还是在工程代码中自定义一个业务异常类,将这些空指针异常封装成业务异常中的一种,并且可以添加上更完善的错误提示。这样,最终在返回结果时候,可以更方便让用户理解。
参考文章:
1、https://yansu.org/15775214814688.html