避免在 Java 中使用 NullPointerException

2022-08-31 01:22:40

我用来避免NullPointerException。有替代方案吗?x != null

if (x != null) {
    // ...
}

答案 1

对我来说,这听起来像是一个相当普遍的问题,初级到中级开发人员在某些时候往往会面临这个问题:他们要么不知道,要么不信任他们正在参与的合同,并防御性地过度检查空值。此外,在编写自己的代码时,它们倾向于依靠返回 null 来指示某些内容,从而要求调用方检查 null。

换句话说,有两个实例会出现空值检查:

  1. 如果 null 是合同意义上的有效响应;和

  2. 如果它不是有效的响应。

(2)容易。从Java 1.7开始,你可以使用Objects.requireNonNull(foo)。。(如果您坚持使用以前的版本,那么断言离子可能是一个不错的选择。

此方法的“正确”用法如下所示。该方法返回传递给它的对象,如果对象为 null,则抛出一个。这意味着返回值始终为非空值。该方法主要用于验证参数。NullPointerException

public Foo(Bar bar) {
    this.bar = Objects.requireNonNull(bar);
}

它也可以像离子一样使用,因为如果对象为空,它会引发异常。在这两种用法中,都可以添加一条消息,该消息将显示在异常中。下面像断言一样使用它并提供一条消息。assert

Objects.requireNonNull(someobject, "if someobject is null then something is wrong");
someobject.doCalc();

通常,当值为 null 但不应该是 null 时,引发特定的异常有利于引发更常规的异常,例如 .这是Java库采用的方法;当参数不允许为 null 时,赞成。NullPointerExceptionAssertionErrorNullPointerExceptionIllegalArgumentException

(1)有点难。如果您无法控制要调用的代码,那么您就卡住了。如果 null 是有效的响应,则必须检查它。

但是,如果它确实是您控制的代码(通常情况就是这样),那么情况就不同了。避免使用空值作为响应。使用返回集合的方法,这很容易:返回空集合(或数组),而不是几乎总是返回空值。

对于非集合,可能会更难。以此为例:如果您有以下接口:

public interface Action {
  void doSomething();
}

public interface Parser {
  Action findAction(String userInput);
}

其中,Parser接受原始用户输入并找到要执行的操作,也许如果您正在为某些内容实现命令行界面。现在,如果没有适当的操作,您可以使协定返回 null。这导致了您正在谈论的空检查。

另一种解决方案是永远不返回 null,而是使用 Null Object 模式

public class MyParser implements Parser {
  private static Action DO_NOTHING = new Action() {
    public void doSomething() { /* do nothing */ }
  };

  public Action findAction(String userInput) {
    // ...
    if ( /* we can't find any actions */ ) {
      return DO_NOTHING;
    }
  }
}

比较:

Parser parser = ParserFactory.getParser();
if (parser == null) {
  // now what?
  // this would be an example of where null isn't (or shouldn't be) a valid response
}
Action action = parser.findAction(someInput);
if (action == null) {
  // do nothing
} else {
  action.doSomething();
}

ParserFactory.getParser().findAction(someInput).doSomething();

这是一个更好的设计,因为它导致更简洁的代码。

也就是说,也许 findAction() 方法完全适合抛出带有有意义的错误消息的 Exception -- 尤其是在您依赖用户输入的情况下。对于 findAction 方法来说,抛出一个异常要比调用方法用一个简单的 NullPointerException 爆炸而不做任何解释要好得多。

try {
    ParserFactory.getParser().findAction(someInput).doSomething();
} catch(ActionNotFoundException anfe) {
    userConsole.err(anfe.getMessage());
}

或者,如果您认为 try/catch 机制太难看,而不是“不执行任何操作”,则默认操作应向用户提供反馈。

public Action findAction(final String userInput) {
    /* Code to return requested Action if found */
    return new Action() {
        public void doSomething() {
            userConsole.err("Action not found: " + userInput);
        }
    }
}

答案 2

如果您使用(或计划使用)像JetBrains IntelliJ IDEAEclipseNetbeans这样的Java IDE,或者像findbugs这样的工具,那么你可以使用注释来解决这个问题。

基本上,您已经拥有 和 .@Nullable@NotNull

您可以使用 in 方法和参数,如下所示:

@NotNull public static String helloWorld() {
    return "Hello World";
}

@Nullable public static String helloWorld() {
    return "Hello World";
}

第二个示例不会编译(在 IntelliJ IDEA 中)。

在另一段代码中使用第一个函数时:helloWorld()

public static void main(String[] args)
{
    String result = helloWorld();
    if(result != null) {
        System.out.println(result);
    }
}

现在,IntelliJ IDEA编译器会告诉你,检查是无用的,因为该函数永远不会返回。helloWorld()null

使用参数

void someMethod(@NotNull someParameter) { }

如果你写这样的东西:

someMethod(null);

这不会编译。

最后一个示例使用@Nullable

@Nullable iWantToDestroyEverything() { return null; }

执行此操作

iWantToDestroyEverything().something();

你可以肯定这不会发生。:)

这是让编译器检查比平时更多的东西并强制你的契约更强大的好方法。不幸的是,并非所有编译器都支持它。

在IntelliJ IDEA 10.5及更高版本中,他们添加了对任何其他实现的支持。@Nullable@NotNull

请参阅博客文章更灵活和可配置的@Nullable/@NotNull注释