非空Lombok生成器属性的FindBugs检测器

Question

我有很多使用Lombok生成器的@nonnull字段的类。

@Builder
class SomeObject {
    @NonNull String mandatoryField1;
    @NonNull String mandatoryField2;
    Integer optionalField;
    ...
}

但是，这为调用方提供了在不设置mandatoryfield的情况下创建对象的选项，如果使用该选项，将导致运行时失败。

SomeObject.builder()
          .mandatoryField1("...")
          // Not setting mandatoryField2
          .build();

我正在寻找在构建时捕捉这些错误的方法。

有一些非Lombok的方法，比如StepBuilder，甚至是构造函数来确保总是设置强制字段，但我对使用Lombok Builder实现这一点的方法感兴趣。

此外，我理解为了进行编译时检查而设计类（如step-builder或@allargsconstructor)会创建大量笨拙的代码--这就是为什么我要构建一个检测这些问题的编译后FindBugs步骤的原因。

现在，当我将@nonnull字段显式设置为null时，FindBugs确实会失败：

FindBugs检测到此故障,

new SomeObject().setMandatoryField1(null);

但它没有检测到这一点：

SomeObject.builder()
          .mandatoryField1(null)
          .build();

SomeObject.builder()
          .mandatoryField1("...")
          //.mandatoryField2("...") Not setting it at all.
          .build();

public static class SomeObjectBuilder {
    private String mandatoryField1;
    private String mandatoryField2;
    private Integer optionalField;

    SomeObjectBuilder() {}

    public SomeObjectBuilder mandatoryField1(final String mandatoryField1) {
        this.mandatoryField1 = mandatoryField1;
        return this;
    }

    // ... other chained setters.

    public SomeObject build() {
        return new SomeObject(mandatoryField1, mandatoryField2, optionalField);
    }
}

null

我有以下几个问题：

• 如果设置了@nonnull属性，是否有任何方法可以使用Lombok生成器导致生成时失败（在运行FindBugs时或其他情况下）？
• 是否有任何自定义FindBugs检测器来检测这些故障？

Answer 1

Lombok在生成@allargsconstructor时会考虑这些@nonnull注释。这也适用于由@builder生成的构造函数。这是示例中构造函数的解拼写代码：

SomeObject(@NonNull final String mandatoryField1, @NonNull final String mandatoryField2, final Integer optionalField) {
    if (mandatoryField1 == null) {
        throw new java.lang.NullPointerException("mandatoryField1 is marked @NonNull but is null");
    }
    if (mandatoryField2 == null) {
        throw new java.lang.NullPointerException("mandatoryField2 is marked @NonNull but is null");
    }
    this.mandatoryField1 = mandatoryField1;
    this.mandatoryField2 = mandatoryField2;
    this.html" target="_blank">optionalField = optionalField;
}

因此，FindBugs理论上可以发现问题，因为null检查存在于构造函数中，稍后在示例中使用null值调用该构造函数。然而，FindBugs可能还不够强大（到现在为止？），而且我不知道有任何定制检测器能够做到这一点。

问题仍然是，为什么lombok没有将这些检查添加到构建器的setter方法中（这将使FindBugs更容易发现问题）。这是因为使用仍然将@nonnull字段设置为null的构建器实例是完全合法的。请考虑以下用例：

TLDR：理论上可以找到这个问题，但是FindBugs还不够强大。另一方面，lombok不应该添加进一步的空检查，因为这会破坏合法的用例。