java - 当 lambda 可能返回 null 时，如何使 IntelliJ IDEA 发出警告？

Question

IntelliJ IDEA 中有非常有用的代码检查恒定条件和异常以及返回“null”。当没有 @Nullable 注释的方法返回 null(@Nullable 方法、@Nullable 的结果)时，它们会显示警告可能评估为 null 的字段或变量。

不幸的是，这不适用于 lambda 表达式。 IntelliJ IDEA 只是忽略它们可能返回的 null 。但我非常确定有一种方法可以为结构搜索检查制作搜索模板，它将找到从 lambda 表达式返回的所有可能的null。

到目前为止，我已经成功制作了一个模板，该模板查找对 @Nullable 方法的引用，以及使用接受 @NotNull 泛型的方法包装单行 lambda 的模板参数并返回它，它不会改变代码语义，并且当 lambda 可能返回 null 时显示警告。

这是我的模板:

可空方法:

@Nullable
$MethodType$ $Method$($ParameterType$ $Parameter$);

可空方法引用

$Qualifier$::$Method$

//Filters for $Method$:
reference = Nullable methods

未检查结果的 Lambda 表达式:

($Parameter$) -> $Statement$

//Filters for $Statement$:
text = !warnIfNull
type = !void|Optional|int|boolean|long|char|short|byte

//Replace template for $Statement$:
WarnUtils.warnIfNull($Statement$)

警告实用程序:

@UtilityClass
public class WarnUtils {
    public <T> @NotNull T warnIfNull(@NotNull T t) {
        return t;
    }
}

我不知道如何为多行 lambda 表达式创建模板，而且我不喜欢用额外的方法包装所有单行 lambda 表达式。

我认为脚本过滤器可能会有所帮助，但我不知道如何使用 __context__ 来检查 lambda 是否可能返回 null。

Answer 1

只需使用具有 @NotNull 的功能接口(interface)即可解决此问题，无需额外的代码检查。对其抽象方法进行注释。

例如，如果您需要一个不得返回 null 的供应商，您可以使用此接口(interface):

@FunctionalInterface
public interface NotNullSupplier<T> {
    @NotNull
    T get();
}

如果您尝试从这种类型的 lambda 表达式返回 null，常量条件和异常 或 返回“null” 代码检查将检测到它:

NotNullSupplier<Integer> supplier = () -> null; // warning - 'null' is returned by the method declared as @NotNull

<小时/>

我想注意到使用Supplier<@NotNull T>可能会导致上述代码检查的错误行为(这一定是一个错误，可能会在稍后修复)。以下是此类行为的示例:

Supplier<@NonNull Integer> supplier = () -> null; // no warnings
Integer result = supplier.get();
if(result != null) // warning - Condition 'result != null' is always 'true'
    result++;

常量条件和异常代码检查建议“解开'if'语句”，在这种情况下遵循此建议将导致 NullPointerException .

为了避免此类错误，您可以将以下搜索模板添加到结构搜索检查:

//Search template:
Supplier<@NotNull $T$>
//Replace template:
NotNullSupplier<$T$>

//Search template:
Function<$T$, @NotNull $R$>
//Replace template:
NotNullFunction<$T$, $R$>

//Search template:
BiFunction<$T$, $U$, @NotNull $R$>
//Replace template:
NotNullBiFunction<$T$, $U$, $R$>