java - NonNull 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 方法(如 StepBuilders 甚至构造函数)来确保始终设置必填字段，但我对使用 Lombok 构建器实现此目的的方法很感兴趣。

此外，我知道设计类(如 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();

这似乎正在发生，因为 Delomboked 构建器看起来像，

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

我观察到:

• Lombok 不向其内部字段添加任何 @NonNull，也不向非空字段添加任何空检查。
• 它不调用任何 SomeObject.set* 方法，以便 FindBugs 捕获这些失败。

我有以下问题:

• 如果设置了 @NonNull 属性，是否有任何方式以导致构建时失败(在运行 FindBugs 或其他方式时)的方式使用 Lombok 构建器？
• 是否有任何自定义的 FindBugs 检测器可以检测到这些故障？

Answer 1

Lombok 在生成 @AllArgsConstructor 时会考虑这些 @NonNull 注释。这也适用于由 @Builder 生成的构造函数。这是您示例中构造函数的 delomboked 代码:

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.optionalField = optionalField;
}

因此，FindBugs 理论上可以找到问题，因为空检查存在于构造函数中，稍后在您的示例中使用 null 值调用它。但是，FindBugs 可能还不够强大(还没有？)，而且我不知道有任何自定义检测器能够做到这一点。

问题仍然存在，为什么 lombok 不将这些检查添加到构建器的 setter 方法中(这将使 FindBugs 更容易发现问题)。这是因为使用仍将 @NonNull 字段设置为 null 的构建器实例是完全合法的。考虑以下用例:

例如，您可以使用 toBuilder() 方法从一个实例创建一个新的构建器，然后通过调用 mandatoryField1(null) 删除其必填字段之一(可能是因为您想避免泄漏实例值)。然后您可以将它传递给其他一些方法，让它重新填写必填字段。因此，lombok 不会也不应该将那些 null 检查添加到生成的构建器的不同 setter 方法中。 (当然，可以扩展 lombok，以便用户可以“选择加入”以生成更多空检查；请参阅 this discussion at GitHub。但是，该决定取决于 lombok 维护者。)

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