番石榴检查的意义何在

2022-08-31 13:40:17

我对番石榴很陌生(说实话,我不是“很新”,我是这个主题的一个完全的新手),所以我决定浏览一些文档,并在阅读本文时感到非常惊讶:

com.google.common.base.Preconditions.checkNotNull(...)

我不明白这种方法的意义。这意味着不要做:

myObject.getAnything();

(如果 myObject 为 null,这可能会导致 NullPointerException

我应该使用

checkNotNull(myObject).getAnything();

这将抛出一个 if 为空,如果它不是空,则返回。NullPointerExceptionmyObjectmyObject

我很困惑,这可能是有史以来最愚蠢的问题,但是......

这有什么意义呢?这两行与我能想到的任何情况的结果完全相同。

我甚至不认为后者更具可读性。

所以我一定错过了什么。这是什么?


答案 1

我们的想法是快速失败。例如,考虑这个愚蠢的类:

public class Foo {
    private final String s;

    public Foo(String s) {
        this.s = s;
    }

    public int getStringLength() {
        return s.length();
    }
}

假设您不希望允许 的空值。(否则将抛出NPE)。按照原样上课,当你发现它的时候,已经太晚了 - 很难找出是谁把它放在那里的。罪魁祸首很可能属于一个完全不同的阶级,而这个实例可能是很久以前构建的。现在,您必须梳理代码库,以找出谁可能在那里放置值。sgetStringLengthnullFoonull

相反,想象一下这个构造函数:

public Foo(String s) {
    this.s = checkNotNull(s);
}

现在,如果有人在那里放了一个,你会上发现 - 并且你会看到堆栈跟踪准确地指向出错的调用。null


另一个有用的时间是,如果您想在执行可以修改状态的操作之前检查参数。例如,考虑这样一个类,它计算它得到的所有字符串长度的平均值:

public class StringLengthAverager {
    private int stringsSeen;
    private int totalLengthSeen;

    public void accept(String s) {
        stringsSeen++;
        totalLengthSeen += s.length();
    }

    public double getAverageLength() {
        return ((double)totalLengthSeen) / stringsSeen;
    }
}

调用将导致 NPE 被抛出 -- 但不是之前已递增。这可能不是你想要的;作为该类的用户,我可能期望如果它不接受nulls,那么如果你传递一个null,它的状态应该保持不变(换句话说:调用应该失败,但它不应该使对象无效)。显然,在此示例中,您也可以通过在递增之前获取来修复它,但是您可以看到对于更长且更复杂的方法,首先检查所有参数是否有效,然后才修改状态可能很有用:accept(null)stringsSeens.length()stringsSeen

    public void accept(String s) {
        checkNotNull(s); // that is, s != null is a precondition of the method

        stringsSeen++;
        totalLengthSeen += s.length();
    }

答案 2

myObject.getAnything();(如果 myObject 为 null,这可能会导致 NullPointerException)

不。。。它会在任何时候抛出NPE。在Java中,没有机会使用接收器调用方法(理论上的例外是静态方法,但它们可以并且应该始终在没有任何对象的情况下调用)。myObject == nullnull


我应该使用checkNotNull(myObject).getAnything();

不,你不应该。这将是相当多余的(更新)。

您应该使用,以便快速失败。没有它,您可能会将非法传递到另一个方法,该方法进一步传递它,依此类推,最终失败。然后,您可能需要一些好运气才能发现实际上第一种方法应该拒绝 。checkNotNullnullnull


yshavit的答案提到了一个重要的观点:传递非法值是不好的,但是存储它并在以后传递它甚至更糟。

更新

实际上

 checkNotNull(myObject).getAnything()

也是有道理的,因为你清楚地表明了你不接受任何空值的意图。没有它,有人可能会认为你忘记了支票并将其转换为类似的东西

 myObject != null ? myObject.getAnything() : somethingElse

哦,我不认为支票值得冗长。在更好的语言中,类型系统会考虑可空性,并给我们一些语义糖,比如

 myObject!!.getAnything()                    // checkNotNull
 myObject?.getAnything()                     // safe call else null
 myObject?.getAnything() ?: somethingElse    // safe call else somethingElse

对于可以为空的,而标准的点语法只有在已知为非空时才被允许。myObjectmyObject