Optional.isPresent 和 Optional.get 调用 "on different" 级别时显示警告？

Question

在下面的代码片段中，我有 Foo class 和一个始终 returns Optional 相同实例的方法。然后我有另一个使用 Foo class 的 OneMoreClass class。

从源代码可以看出，在method1中调用get()方法是安全的，因为它总是在method2中被检查。

IntelliJ IDEA 仍然显示警告的问题（您可以将此片段复制到 IDEA 中，您会看到问题）。

public class Example {

    public static class Foo {

        private final Optional<String> value = Optional.empty();

        public Optional<String> bar() {
            return value;
        }
    }

    public static class OneMoreClass {
        void method1(final Foo foo) {
            method2(foo);
            System.out.println(foo.bar().get()); // here the warning is shown in IntelliJ IDEA: 
                                                 // "Optional.get()" without "isPresent()" check
        }

        void method2(final Foo foo) {
            if (!foo.bar().isPresent()) {
                throw new IllegalArgumentException("No value");
            }
        }
    }
}

问题是：如何修复警告？有什么技巧可以避免这个警告吗？

Answer 1

optional是避免NPE的意思。如果你检查 Optional.get() 你会看到这个方法在 Optional.isPresent() 为假时抛出异常。因此，如果您在没有初步检查 "isPresent" 的情况下使用 "get"，则没有任何好处。要修复它，请在 "get" 之前检查 "isPresent"。但我建议考虑 "getOrElse"、"ifPresent" 等

Answer 2

在这种情况下，您将无法摆脱警告。生成警告的代码检查不够健壮，无法完全分析所有代码路径并理解 method2.

背后的意图

不过，您可以这样做来获得相同的结果：

 void method1(final Foo foo) {
    String bar = getBar(foo);
    System.out.println(bar);
}

String getBar(final Foo foo) {
    return foo.bar().orElseThrow(() -> new IllegalArgumentException("No value"));
}

老实说，现在我已经想起了 .orElseThrow 方法，将其简化为：

可能更容易

void method1(final Foo foo) {
    String bar = foo.bar().orElseThrow(() -> new IllegalArgumentException("No value"));
    System.out.println(bar);
}

您还可以通用化一些功能。在这种情况下，它不会给你带来太多好处，但如果你想要运行由可选为空触发的更多代码，这可能是有意义的。 IntelliJ 也会在此处发出警告，您可以取消警告：

@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
<T> T unwrapOrThrow(Optional<T> optional) {
    return optional.orElseThrow(() -> new IllegalArgumentException("No value"));
}

Answer 3

披露：我是一名 IntelliJ IDE开发人员，负责此功能。

从技术上讲，使用您的代码可能会导致 get() 失败：

public static void main(String[] args) {
    new Example.OneMoreClass().method1(new Example.Foo() {
        int x;

        @Override
        public Optional<String> bar() {
            return x++ % 2 == 0 ? Optional.of("foo") : Optional.empty();
        }
    });
}

由于您的 Foo class 和 bar() 方法不是最终的，IDEA 不能确定它们是否稳定。但是，即使您将 Foo 声明为最终的，IDEA 仍然会发出警告。我们实际上相信 bar() 结果可以是稳定的，以避免噪音警告。主要问题是 isPresent() 检查被移到单独的方法中，我们的过程间分析不是那么聪明。当调用未知的用户方法时，当前的分析器实现只做几件事：

我们推断结果可空性、结果可变性（在非常有限的意义上）、方法纯度和 contracts 就像 @Contract("null -> false") 研究方法实现一样。此分析非常有限，仅适用于不可覆盖的方法，因此不适用于此处。即使我们将 method2 声明为最终的，此分析也不会产生任何结果。
我们推断非空参数，查看方法实现。这适用于您的情况：如果您调用 method2(null)，您将收到警告。当然对解决你的问题没有帮助。
在某些情况下，我们会内联非常小且简单的稳定方法。仅当要内联的方法稳定、没有参数、在同一个 class 上调用、具有单个 return 语句并且不调用任何其他方法（可能有更多限制）时，这才有效。它在这种情况下有帮助：

    public static final class OneMoreClass {
        @Nullable String foo;

        void test() {
            if (isValid()) {
                System.out.println(foo.trim()); // no possible NPE warning
            }
        }

        boolean isValid() {
            return foo != null;
        }
    }

None 这些方法涵盖了您的情况。我们偶尔会改进分析使其更智能，但我们的 CPU 资源非常有限。别忘了我们是在线分析代码，不断修改代码使之前的分析结果失效。深度过程间分析需要更多 CPU 时间，我们不希望 IDEA 显着变慢。

我必须说您的代码也可能会混淆 reader。我认为您的示例是更大代码的简化版本，reader 可能不确定可选代码是否实际上始终存在于给定的代码点。有一个很好的旧机制来协助代码 readers 以及保护自己免受意外错误（如果有人修改 method2 之后删除 isPresent() 检查而没有适当调整调用站点怎么办？）。该机制称为断言。所以答案：添加一个断言，代码对于IDE和readers:

都会更清晰

    void method1(final Foo foo) {
        method2(foo);
        assert foo.bar().isPresent();
        System.out.println(foo.bar().get()); // the warning is gone
    }

Optional.isPresent 和 Optional.get 调用 "on different" 级别时显示警告？

A warning is shown when Optional.isPresent and Optional.get are called "on different" levels?

java

intellij-idea

optional

java-8