如何让IntelliJ IDEA理解我的空检查方法？

Question

我有一个方法，其中一个参数被标记为@Nonnull注释。调用该方法的代码必须检查该值是否为null。而不仅仅是直接的x！=nullcheck，它正在调用另一个类上的实用程序方法。（在实际代码中，实用程序方法还检查它是否为空字符串）。

我的问题是Intellij Idea在非null方法调用上显示了一个检查警告，说我的变量“可能为null”。我知道它不能为空，因为实用方法检查-我怎么能告诉检查员？

因为这有点抽象，这里有一个最小的例子来说明我的意思：

package org.ethelred.ideatest;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
 * tests annotations
 */
public class AnnotationChecker
{
    public static void main(String[] args)
    {
        String x = null;
        if(args.length > 0)
        {
            x = args[0];
        }

        if(!isNull(x))
        {
            useObject(x);
        }

        if(x != null)
        {
            useObject(x);
        }
    }

    public static boolean isNull(@CheckForNull Object o)
    {
        return o == null;
    }


    public static void useObject(@Nonnull Object o)
    {
        System.out.println(o);
    }
}

这使用了JSR305注释。

在本例中，在对useObjectIntellij的第一次调用中，在x参数上放置一条警告，表示“参数“x”可能为null”。在第二次呼叫中，没有任何警告。

Answer 1

我不相信有任何方法可以用编写的代码来解决警告。我希望发现IntelliJ支持@SuppressWarnings的值，您可以在useObject（x）语句中使用该值，但根据此来源，它不支持。您可能只需要咬紧牙关，将代码更改为以下内容：

if (x != null && !isBlank(x)) {
    useObject(x);
}

请注意，我将方法isNull重命名为isBlank，因为据我所知，检查null的实际方法也会检查其他条件。

Answer 2

使用IDEA 12，您可以配置NotNull检查方法：http://youtrack.jetbrains.com/issue/IDEA-35808#tab=Comments

Answer 3

在IDEA 13中增加了非常奇特的功能，称为方法契约。例如，您可以有一个方法，如果遇到null，该方法会引发验证异常：

@Contract("null -> fail")
public static void validateNull(@Nullable final Object object) {
    if (object == null) {
        throw new ValidationException();
    }
}

IDEA将分析注释，如果您在可能的NPE之前调用它，则不会显示警告：

validateNull(user);
user.setSomething("something"); // no warning

您在IDEA的设置中有完整的文档（只需搜索方法契约）。要实现这一点，您需要对jetbrain的annotations jar有额外的依赖：

<dependency>
    <groupId>org.jetbrains</groupId>
    <artifactId>annotations</artifactId>
    <version>13.0</version>
</dependency>