Android 中 Object.requireNonNull 和 @NonNull：深入解析

2023-09-06 20:43:09

NPE 的克星：利用 Object.requireNonNull() 和 @NonNull 注解构建健壮的 Android 应用

NPE 的痛点

在 Android 开发中，NullPointerException (NPE) 就像一颗定时炸弹，随时可能在你的代码中爆炸，导致令人头疼的调试和维护问题。然而，Java 为我们提供了两大利器：Object.requireNonNull() 方法和 @NonNull 注解，它们联手为我们打造了防御 NPE 的坚实盾牌。

Object.requireNonNull()：在运行时筑起第一道防线

Object.requireNonNull() 是一个简单但强大的方法，它接受一个对象引用作为参数，然后检查该对象是否为 null。如果不幸碰上一个 null 值，它会毫不犹豫地抛出一个 NPE，让你在运行时就能发现问题。

代码示例：

String name = Object.requireNonNull(getIntent().getStringExtra("name"));

这行代码检查 getIntent().getStringExtra("name") 是否为 null。如果它敢于返回 null，Object.requireNonNull() 就会立马抛出一个 NPE，阻止你的代码在无意识中继续执行。

@NonNull：在编译时发出警告

@NonNull 是一个元注解，它可以给方法的参数和返回值贴上 "不为 null" 的标签。当一个被 @NonNull 标记的参数接收到一个 null 值，编译器会发出警告。这样，你就能在代码部署之前发现潜在的 NPE。

代码示例：

public void setName(@NonNull String name) {
  // ...
}

如果有人试图用一个 null 值调用 setName() 方法，编译器会立即发出警告。这给了你一个机会，让你在代码进入生产环境之前修复这个漏洞。

协同工作：双剑合璧，威力倍增

Object.requireNonNull() 和 @NonNull 注解并不是独立作战的，它们可以协同工作，为你的代码提供全方位的 NPE 防护。Object.requireNonNull() 在运行时检查对象是否为 null，而 @NonNull 则在编译时强制执行 "不为 null" 约束。

代码示例：

public void setName(@NonNull String name) {
  Object.requireNonNull(name);
  // ...
}

这段代码可谓 NPE 防御的终极组合技，它不仅能在编译时发出警告，还能在运行时抛出 NPE。这样，你就可以在代码的任何阶段发现和修复 NPE。

优点：NPE 的终结者

使用 Object.requireNonNull() 和 @NonNull 注解，你可以享受以下好处：

减少 NPE：这些机制能有效减少 NPE 的发生，让你安心开发。
提高代码质量：通过强制执行 "不为 null" 约束，你的代码将变得更加健壮，错误也会随之减少。
提升可读性：@NonNull 注解能清楚地表明参数或返回值保证不为 null，让你的代码一目了然。
编译时检查：@NonNull 注解允许编译器在编译时检测潜在的 NPE，帮你提前发现并修复错误。

局限性：没有银弹

尽管 Object.requireNonNull() 和 @NonNull 注解非常强大，但它们也有一些局限性：

性能开销：Object.requireNonNull() 在运行时使用，会带来轻微的性能开销。
不能解决所有 NPE：这些机制无法解决所有类型的 NPE，例如通过反射或反序列化引入的 NPE。
可空性注解更全面：Java 8 引入了可空性注解（@Nullable 和 @NotNull），它们提供了更全面且类型安全的空值处理方案。

最佳实践：NPE 预防之道

为了充分利用 Object.requireNonNull() 和 @NonNull 注解，牢记以下最佳实践：

明智使用：不要过度使用这些机制，因为它们可能会降低性能或导致不必要的代码复杂性。
与可空性注解结合使用：对于 Android API 级别 26 及以上版本，建议与可空性注解结合使用，以获得更全面的空值处理。
考虑性能影响：在性能关键路径中谨慎使用 Object.requireNonNull()，因为它会带来轻微的性能开销。
始终使用 null 值检查：不要依赖 @NonNull 注解来保证非 null 值。始终使用 null 值检查作为最后的防线。

结论：无 NPE，代码无忧

Object.requireNonNull() 方法和 @NonNull 注解是 Android 开发人员对抗 NPE 的有力武器。通过在运行时检查对象是否为 null 以及在编译时强制执行 "不为 null" 约束，这些机制可以显着减少 NPE 的发生，提高代码质量和可读性。通过理解它们的优点、局限性和最佳实践，你可以构建健壮可靠的 Android 应用，让 NPE 成为过去。

常见问题解答

1. 如何在 Android Studio 中使用 @NonNull 注解？

在方法或参数声明上使用 @NonNull 注解，然后在项目中启用 "NonNull API" 检查即可。

2. Object.requireNonNull() 会影响性能吗？

是的，Object.requireNonNull() 在运行时使用，会带来轻微的性能开销。

3. @NonNull 注解与可空性注解有什么区别？

@NonNull 注解只强制执行 "不为 null" 约束，而可空性注解（@Nullable 和 @NotNull）提供了更全面的空值处理方案。

4. 为什么在使用 @NonNull 注解时仍然需要进行 null 值检查？

@NonNull 注解不能保证非 null 值。始终使用 null 值检查作为最后的防线。

5. 我可以禁用 @NonNull 注解检查吗？

可以，但在大多数情况下不建议禁用此检查。