intellij-idea - 谷歌 Guava checkNotNull 和 IntelliJ IDEA 的 "may produce java.lang.NullPointerException"

Question

有什么办法可以抑制这个警告:

MyClass object = null;

/*Some code that 'might' set this object but I know it will*/      


Preconditions.checkNotNull(object); 
//when "assert object != null" is used here no warning is shown

merged.setName(dRElement.getName());
//"May produce 'java.lang.NullPointerException'" warning here 

我正在使用 IntelliJ IDEA 10.5，我知道这个警告是不必要的，但是我想在这里抑制它并避免关闭检查。

Answer 1

通过@Contract的组合注释和外部注释功能，您现在可以注释 Preconditions方法，以便 IntelliJ 将正确的静态分析应用于对这些方法的调用。

假设我们有这个例子

public void doSomething(Object someArg) {
    Preconditions.checkArgument(someArg != null);
    someArg.doSomethingElse();  //currently gives NPE warning

    if (someArg != null) {
        //no warning that this is always true
    }
}

在 IntelliJ 中(我使用的是 13):

导航至 Preconditions.checkArgument(boolean) .

将光标放在方法名称上，然后按 Alt-Enter 调出意图弹出窗口。

选择“添加方法契约(Contract)”。

使用契约(Contract)文本 false -> fail .

出现提示时，提供外部注释文件的位置。

现在警告在 someArg.doSomethingElse()消失了，实际上 IDEA 会标记 if分支一如既往的真实!

其他契约(Contract)文本:

Preconditions.checkArgument(boolean, String)应该是 false, _ -> fail

Preconditions.checkNotNull(Object, String)应该是 null, _ -> fail ,

等等

这是我的全部annotations.xml文件为 Preconditions :

<root>
    <item name='com.google.common.base.Preconditions T checkNotNull(T)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;null -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions T checkNotNull(T, java.lang.Object)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;null, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions T checkNotNull(T, java.lang.String, java.lang.Object...)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;null, _, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkArgument(boolean)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkArgument(boolean, java.lang.Object)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkArgument(boolean, java.lang.String, java.lang.Object...)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false, _, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkState(boolean)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkState(boolean, java.lang.Object)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
    <item name='com.google.common.base.Preconditions void checkState(boolean, java.lang.String, java.lang.Object...)'>
        <annotation name='org.jetbrains.annotations.Contract'>
            <val val="&quot;false, _, _ -&gt; fail&quot;"/>
        </annotation>
    </item>
</root>

也可以看看

IDEA-113391: Edit Method Contract intention for library methods

IDEA-93372: Implement something similar to ReSharper contract annotations for Java

IDEA-60343: False positive NPE warning when using guava Preconditions - Constant conditions & Expectations