java - Optional.isPresent 和 Optional.get 调用 "on different"级别时会出现警告？

Question

在下面的代码片段中，我有一个 Foo 类，它的方法总是返回 Optional 的相同实例。然后我有另一个使用 Foo 类的 OneMoreClass 类。

从源码中可以看出，在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

披露:我是 IntelliJ IDEA 开发人员，负责此功能。

---

从技术上讲，使用您的代码可能会导致 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 类和bar() 方法不是最终的，IDEA 不能确定它们是否稳定。但是，即使您将 Foo 声明为 final，IDEA 仍然会发出警告。我们实际上相信 bar() 结果可以是稳定的，以避免噪音警告。主要问题是 isPresent() 检查被移到了单独的方法中，我们的过程间分析不是那么聪明。当调用未知的用户方法时，当前的分析器实现只做几件事:

1. 我们推断结果可空性、结果可变性(在非常有限的意义上)、方法纯度和 contracts像 @Contract("null -> false") 研究方法实现。此分析非常有限，仅适用于不可覆盖的方法，因此不适用于此处。即使我们将 method2 声明为 final，此分析也不会产生任何结果。

2. 我们推断非空参数，研究方法实现。这适用于您的情况:如果您调用 method2(null)，您将收到警告。当然，这对解决你的问题没有帮助。

3. 在某些情况下，我们会内联非常小且简单的稳定方法。仅当要内联的方法稳定、没有参数、在同一类上调用、具有单个返回语句并且不调用任何其他方法(可能有更多限制)时，这才有效。它在这种情况下有帮助:

    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;
        }
    }

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

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

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