NullPointerException 是导致 Java 程序故障的其中一个最常见的原因。
在最简单的方案中,出现类似以下代码时,编译器会直接向您发出警告:
Object o = null;
String s = o.toString();
因为出现分支/循环,并抛出异常,有必要退出复杂的流量分析,以便查出整个程序的某些或所有路径上是否已为取消引用的变量分配空/非空值。
由于固有的复杂性,所以可在小数据块中更好地执行流量分析。使用良好的工具性能一次可分析一个方法,而整个系统分析会超出 Eclipse Java 编译器的范围。优点是:分析速度较快,并可以增量的方式完成操作,这样在您输入内容时编译器可直接向你发出警告。缺点是:该分析无法“看到”哪些值(null 或非 null)正在方法之间流动(作为参数和返回值)。
此时 null 注释就开始起作用了。通过将方法参数指定为 @NonNull,可以告诉编译器在此位置您不想用 null 值。
String capitalize(@NonNull String in) {
return in.toUpperCase(); // no null check required
}
void caller(String s) {
if (s != null)
System.out.println(capitalize(s)); // preceding null check is required
}
在约定式设计状态中,存在两个方面:
capitalize 的实现者享有自变量 in 不应为 null 的保证,因此,此处可以是不为 null 检查的解除引用。对于方法返回值,该情况是相对的:
@NonNull String getString(String maybeString) {
if (maybeString != null)
return maybeString; // the above null check is required
else
return "<n/a>";
}
void caller(String s) {
System.out.println(getString(s).toUpperCase()); // no null check required
}
可配置 Eclipse Java 编译器以将三种不同的注释类型用于其增强的 null 分析(缺省情况下为禁用状态):
@NonNull:null 不是一个合法值@Nullable:允许使用 null 值,且必须是预期的值@NonNullByDefault:缺少 null 注释的方法特征符的类型被视为非 null。在以下位置支持注释 @NonNull 和 @Nullable:
@NonNullByDefault 受以下内容支持:
package-info.java 文件)- 影响程序包中的所有类型
注意:即使这些注释的实际限定名为可配置,但在缺省情况下,仍会(从程序包 org.eclipse.jdt.annotation)使用上面给出的限定名。
随 Eclipse 提供了一个具有缺省空注释的 JAR,它位于 eclipse/plugins/org.eclipse.jdt.annotation_*.jar。在编译时,此 JAR 需要位于构建路径上,但在运行时这并非必需(因此您无需将此 JAR 提供给您的已编译代码的用户)。
对于对 @NonNull、@Nullable 或 @NonNullByDefault 的未解析引用,提供了两个快速修订,它们会将该 JAR 添加至构建路径:


现在应该清楚,null 注释已将更多信息添加到您的 Java 程序(然后编译器可使用该程序提供更好的警告)。但是,我们真正想让这些注释说明什么?从实用的角度出发,我们至少要使用 null 注释表达三个级别:
对于 (1),您可使用 null 注释立即启动,且无需更进一步阅读,但不要期望时常获得更多提示。其他级别会获得更多说明。
看上去在“约定式设计”状态下使用 API 规范的 null 注释仅意味着应该全面注释所有 API 方法的特征符(诸如 int 的专用类型除外),实际每个参数和每个方法返回类型应标记为 @NonNull 或 @Nullable。因为这将意味着插入许多 null 注释,所以,应该很好地了解在设计良好的的代码(尤其是 API 方法)中,使用 @NonNull 的频率远远高于 @Nullable。这样,在程序包级别通过声明 @NonNull 为缺省值,使用 @NonNullByDefault 注释可减少注释的数量。
注意,@Nullable 与忽略 null 注释之间的巨大差别:此注释明确声明可以为 null 且必须为期望的注释。通过比较,没有任何注释仅仅意味着我们不知道其目的。这是以前的情况,其中有时两端(调用者和被调用者)会随机检查是否为 null,有时两端会错误地假定另一端将执行检查。这是 NullPointerExceptions 的来源。如果没有注释,那么编译器将不会提供特定的建议;但是,如果有 @Nullable 注释,那么将标志每个没有检查的取消引用。
有了这些基本知识,我们可以直接将所有参数注释影射到先决条件中,并将返回注释解释为该方法的后置条件。
在面向对象程序设计中,概念“约定式设计”需要解决另一个维:子分类和覆盖(在续集中,术语“覆盖”将以 Java 6 中 @Override 注释的意义使用:从超类型覆盖或执行另一方法的的方法)。调用方法的客户机如下所示:
@NonNull String checkedString(@Nullable String in)
应允许假定此方法的所有实现都符合该约定。因此,当在接口 I1 中找到该方法声明时,我们必须排除任何实现 I1 的类 Cn 都提供一个不兼容的实现。具体地说,如果任何 Cn 尝试使用声明参数为 @NonNull 的实现覆盖此方法,那么它将非法。如果我们要允许这一点,那么针对 I1 进行编程的客户机模块会将 null 作为自己变量进行传递,但该实现将假定允许方法实现中未检查的取消引用非空值,但该值在运行时会放大。因此,@Nullable 参数规范会强制所有覆盖以承认 null 为预期的合法值。
相反,@NonNull 返回规范会强制所有覆盖以确保将从不返回该 null。
因此,编译器必须检查任何覆盖都不会添加超类型不存在的 @NonNull 参数注释(或 @Nullable 返回注释)。
有趣的是,反向重定义也是合法的:添加 @Nullable 参数注释或 @NonNull 返回注释(您可以将这些视为该方法的“改善”,它接受更多的值,并产生更特定的返回值)。
当以“遗留”(即,未注释的)类型(它可能来自第三方库,因此无法更改)的子类型写入注释的代码时,以前的考虑事项会添加差异性。如果您认真阅读最后一部分,那么可能会注意到我们无法承认“遗留”方法由带有 @NonNull 参数的方法覆盖(因为使用超类型的客户机“看不到” @NonNull 责任)。
在这种情况下,将强制您忽略 null 注释(存在的计划支持事后将注释添加到库中,但当这样的功能可用时,不会做任何承诺)。
如果“遗留”类型的子类型驻留在已为其指定 @NonNullByDefault 的程序包中,那么情况会变得很复杂。现在具有未注释的超类型的类型需要将覆盖方法中的所有参数标记为 @Nullable:即使不允许忽略的参数注释也是如此,因为这会将此参数解析为类似 @NonNull 参数(该位置禁止此参数)。这就是 Eclipse Java 编译器为什么支持取消空缺省值的原因:通过使用 @NonNullByDefault(false) 注释某个方法或类型,将取消此元素的适用缺省值,并再将未注释的参数解释为未指定。现在,在没有添加不想要的 @Nullable 注释的情况下,子分类又会合法:
class LegacyClass {
String enhance (String in) { // clients are not forced to pass nonnull.
return in.toUpperCase();
}
}
@NonNullByDefault
class MyClass extends LegacyClass {
// ... methods with @NonNull default ...
@Override
@NonNullByDefault(false)
String enhance(String in) { // would not be valid if @NonNullByDefault were effective here
return super.enhance(in);
}
}
使用上面列出的约定式设计风格的 null 注释有助于用几个方法提高 Java 代码的质量:在方法之间的接口上这是明确的,即:哪些参数/返回 容忍一个 null 值,哪些不容忍。这会捕获设计决策,这与开发者高度相关,从另一方面说,也可由编译器检查。
另外,根据此接口规范,内部程序流分析可选择可用的信息,并提供更加准确的错误/警告。如果没有注释,那么流进某个方法或从其流出的任何值都具有空值,因此 null 分析仍为有关其用法的静默分析。如果具有 API 级别的 null 注释,那么大多数空值实际为已知值,且极少有 NPE 会被编译器忽视。但是,您应该知道仍存在某些漏洞,其中,未指定的值会注入该分析,从而阻止完整的声明,这与在运行时是否发生 NPE 无关。
已经以与进一步扩展相兼容的方式设计 null 注释的支持,因此,编译器将能够保证认证的项目在运行时从不抛出 NullPointerException(及有关无法检查的部件(如反射)的典型警告)。尽管没有针对这样的未来扩展做出承诺,但基本想法只是与我们已经拥有的解释完不同。
通过作为类型系统的一部分解释 null 注释,我们在给定程序中使类型加倍:对于任何给定的类 Cn,不会再将类本身视为合法类型,但只有“@NonNull Cn”和“@Nullable Cn”是有用的类型。因此,理想情况下,每个程序中有一个值,我们将知道它是否可以为 null(在取消引用前必须进行检查)。如果我们排除第三个选项(非注释类型),那么编译器可严格标志非常有用的用法。
当前实现针对此目标有两个主要限制:
到目前为止,尽管存在当前的限制,完全指定和全面检查的程序在视觉上已包含一些隐含条件,这些条件可覆盖当前的分析和编译器报告的错误/警告。通过解释编译器检查的规则及根据规则违例发出的消息从而提供相关的详细信息。
对于相应的首选项页,由编译器检查的各个规则基于下列标题:
对于规范违例,我们处理 null 注释做出实际实现违例的声明的任何情况。典型情况会从指定值(本地、自变量和方法返回)为 @NonNull 得出结果,因此,该实现实际提供可为空的值。如果静态已知将此处的表达式估算为 null 值或将其声明为 @Nullable 注释,那么将其视为可为空的值。
其次,本组还包含方法覆盖的规则(如上所述)。此处有个超级方法,建立了一个声明(即:null 为合法自变量),而覆盖将尝试避免此声明(通过假定 null 不是合法自变量)。如前所述,甚至将自变量从未注释具体化到 @NonNull 是一种规范违例,因为,它会引入约定,该约定应绑定客户机(不传递 null)但是使用超类型的客户机甚至看不到此约定,所以,甚至不知道他的期望。
此处提供了视为规范违例的情况的完全列表。了解绝不应该忽视此组中的错非常重要,否则整个 null 分析将基于错误的假设执行操作。具体地说,当编译者看到带有 @NonNull 注释的值时,会理所当然地认为在运行时不会发生 null。这是规范违例的规则,可确保此违例的合理性。因此,强烈建议保留将此类型的问题配置为错误。
另外,此组规则会监视对 null 规范的忠诚度。但是,在此我们将处理不将其声明为 @Nullable 的值(其本身也不是 null 值),但内部程序流分析推断 null 还可能在某些执行路径上发生的值除外。
这种情况源于一个针对未注释的局部变量的事实,编译器将推断 null 是否可以使用其流分析。假定此分析是正确的,如果发现问题,那么此问题与 null 规范的直接违例具有相同的严重性。因此,再次强烈建议将此问题配置为错误,且不要忽略这些消息。
为这些问题服务器创建单独的组有两个目的:记录提出给定的问题,以帮助流分析,及负责会造成流分析错误这一事实(由实施中的错误导致)。对于知识性实施错误,这是一种良好的异常情况,可抑制发生此类错误消息。
考虑到任何静态分析的性质,流分析可能无法看到执行路径和值的特定组合是不可能组合。例如,考虑变量相关性:
String flatten(String[] inputs1, String[] inputs2) {
StringBuffer sb1 = null, sb2 = null;
int len = Math.min(inputs1.length, inputs2.length);
for (int i=0; i<len; i++) {
if (sb1 == null) {
sb1 = new StringBuffer();
sb2 = new StringBuffer();
}
sb1.append(inputs1[i]);
sb2.append(inputs2[i]); // warning here
}
if (sb1 != null) return sb1.append(sb2).toString();
return "";
}
编译器将在调用 sb2.append(..) 时报告潜在的 null 指针访问。.
人工阅读器可以看到,不存在实际的危险,因为无论变量同时为 null 或同时为非 null,sb1 和 sb2 都具有实际的关联性。在有问题的行中,我们知道 sb1 不为 null,因此 sb2 也不为 null。没有深入了解为什么这样的相关性分析超出了 Eclipse Java 编译器的能力,请记住此分析不具有完整定理证明程序的功能,因此,悲观地报告了一些问题,从而可能将使更具能力的分析标识为错误警报。
如果您想从流分析中获得好处,建议您对编译器提供一点帮助,以便它能够“看到”您的结论。此帮助可很容易地将 if (sb1 == null) 分成两个单独的 if,可分别将其用于每个局部变量,它价格便宜,少量付费即可获得,从而使编译器现在可以完全看到发生的操作并可相应地检查代码。有关本主题的更多讨论,将遵循以下内容。
此组问题基于以下类比:在使用 Java 5 泛型的程序中,对 pre-Java-5 库的任何调用都可能暴露原始类型,即:通用类型的应用程序可能无法指定具体类型参数。要使这样的值适合某个程序,那么借助泛型,通过假定以代码的客户机部件预期的方式指定类型自变量,从而使编译器可添加一个隐式转换。编译器将发出一个关于使用这样的转换的警告,并假定该库“执行了正确的操作”来继续其类型检查。用完全相同的方法,库方法的未注释的返回类型可以被认为是一个“原始”类型或“遗留”类型。另外,隐式转换可以乐观地假定预期的规范。另外,又发出一个警告,且分析会继续假定该库“执行正确的操作”。
从理论上说,还需要这样的隐式转换指定某个规范违例。但是,在这种情况下,它可能是第三方代码,这违反了我们的代码预期的规范。或者(我们已深信)某些第三方代码可能确实符合该约定,但只是未能做此声明(因为它没有使用 null 注释)。在这种情况下,我们可能因组织原因而无法正确修复该问题。
@SuppressWarnings("null")
@NonNull Foo foo = Library.getFoo(); // implicit conversion
foo.bar();
以上代码片段假定 Library.getFoo() 返回 Foo,但不指定 null 注释。我们可通过将返回值分配到 @NonNull 局部变量从而将其集成到我们的注释的程序中,这会触发关于未检查转换的警告。通过将相应的 SuppressWarnings("null") 添加到此声明,我们了解到此内在危险,并接受验证该库是否按实际所需的方式工作的责任。
如果流分析无法看到某个值确实不是 null,那么最简单的策略始终是添加使用 @NonNull 注释的新作用域局部变量。那么,如果您深信分配到此本地的值在运行时永远不是 null,那么您可以使用帮助方法,如下所示:
static @NonNull <T> T assertNonNull(@Nullable T value, @Nullable String msg) {
if (value == null) throw new AssertionError(msg);
return value;
}
@NonNull MyType foo() {
if (isInitialized()) {
MyType couldBeNull = getObjectOrNull();
@NonNull MyType theValue = assertNonNull(couldBeNull,
"value should not be null because application " +
"is fully initialized at this point.");
return theValue;
}
return new MyTypeImpl();
}
注意,通过使用以上 assertNonNull() 方法,您将接受在运行时将始终保留此声明的职责。如果这不是你想要的,那么,对于流入某个位置的 null,注释的局部变量将仍有助于确定会在何处以及为何分析过程需要查看潜在变量。
在发布 JDT V3.8.0 时,收集采用 null 注释的建议仍在进行中。因此,当前可在 Eclipse wiki 中维护该信息。