java - NonNull Lombok 构建器属性的 FindBugs 检测器

coder 2023-08-31 原文

我有很多使用 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 检测器可以检测到这些故障？

最佳答案

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 不应该添加进一步的空检查，因为它会破坏合法的用例。

关于java - NonNull Lombok 构建器属性的 FindBugs 检测器，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/51324922/

有关java - NonNull Lombok 构建器属性的 FindBugs 检测器的更多相关文章

ruby-on-rails - 如果为空或不验证数值，则使属性默认为 0 - 2
我希望我的UserPrice模型的属性在它们为空或不验证数值时默认为0。这些属性是tax_rate、shipping_cost和price。classCreateUserPrices8,:scale=>2t.decimal:tax_rate,:precision=>8,:scale=>2t.decimal:shipping_cost,:precision=>8,:scale=>2endendend起初，我将所有3列的:default=>0放在表格中，但我不想要这样，因为它已经填充了字段，我想使用占位符。这是我的UserPrice模型:classUserPrice回答before_val
ruby-on-rails - 在混合/模块中覆盖模型的属性访问器 - 2
我有一个包含模块的模型。我想在模块中覆盖模型的访问器方法。例如:classBlah这显然行不通。有什么想法可以实现吗？最佳答案您的代码看起来是正确的。我们正在毫无困难地使用这个确切的模式。如果我没记错的话，Rails使用#method_missing作为属性setter，因此您的模块将优先，阻止ActiveRecord的setter。如果您正在使用ActiveSupport::Concern(参见thisblogpost)，那么您的实例方法需要进入一个特殊的模块:classBlah
ruby - 多个属性的 update_column 方法 - 2
我有一个具有一些属性的模型:attr1、attr2和attr3。我需要在不执行回调和验证的情况下更新此属性。我找到了update_column方法，但我想同时更新三个属性。我需要这样的东西:update_columns({attr1:val1,attr2:val2,attr3:val3})代替update_column(attr1,val1)update_column(attr2,val2)update_column(attr3,val3) 最佳答案您可以使用update_columns(attr1:val1,attr2:val2
java - 等价于 Java 中的 Ruby Hash - 2
我真的很习惯使用Ruby编写以下代码:my_hash={}my_hash['test']=1Java中对应的数据结构是什么？最佳答案 HashMapmap=newHashMap();map.put("test",1);我假设？关于java-等价于Java中的RubyHash，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/22737685/
ruby - RuntimeError(自动加载常量 Apps 多线程时检测到循环依赖 - 2
我收到这个错误:RuntimeError(自动加载常量Apps时检测到循环依赖当我使用多线程时。下面是我的代码。为什么会这样？我尝试多线程的原因是因为我正在编写一个HTML抓取应用程序。对Nokogiri::HTML(open())的调用是一个同步阻塞调用，需要1秒才能返回，我有100,000多个页面要访问，所以我试图运行多个线程来解决这个问题。有更好的方法吗？classToolsController0)app.website=array.join(',')putsapp.websiteelseapp.website="NONE"endapp.saveapps=Apps.order("
ruby - Nokogiri 剥离所有属性 - 2
我有这个html标记:我想得到这个:我如何使用Nokogiri做到这一点？最佳答案 require'nokogiri'doc=Nokogiri::HTML('')您可以通过xpath删除所有属性:doc.xpath('//@*').remove或者，如果您需要做一些更复杂的事情，有时使用以下方法遍历所有元素会更容易:doc.traversedo|node|node.keys.eachdo|attribute|node.deleteattributeendend 关于ruby-Nokog
ruby-on-rails - Rails 模型——非持久类成员或属性？ - 2
对于Rails模型，是否可以/建议让一个类的成员不持久保存到数据库中？我想将用户最后选择的类型存储在session变量中。由于我无法从我的模型中设置session变量，我想将值存储在一个“虚拟”类成员中，该成员只是将值传递回Controller。你能有这样的类(class)成员吗？最佳答案将非持久属性添加到Rails模型就像任何其他Ruby类一样:classUser扩展解释:在Ruby中，所有实例变量都是私有(private)的，不需要在赋值前定义。attr_accessor创建一个setter和getter方法:classUs
java - 从 JRuby 调用 Java 类的问题 - 2
我正在尝试使用boilerpipe来自JRuby。我看过guide从JRuby调用Java，并成功地将它与另一个Java包一起使用，但无法弄清楚为什么同样的东西不能用于boilerpipe。我正在尝试基本上从JRuby中执行与此Java等效的操作:URLurl=newURL("http://www.example.com/some-location/index.html");Stringtext=ArticleExtractor.INSTANCE.getText(url);在JRuby中试过这个:require'java'url=java.net.URL.new("http://www
java - 我的模型类或其他类中应该有逻辑吗 - 2
我只想对我一直在思考的这个问题有其他意见，例如我有classuser_controller和classuserclassUserattr_accessor:name,:usernameendclassUserController//dosomethingaboutanythingaboutusersend问题是我的User类中是否应该有逻辑user=User.newuser.do_something(user1)oritshouldbeuser_controller=UserController.newuser_controller.do_something(user1,user2)我
java - 什么相当于 ruby 的 rack 或 python 的 Java wsgi？ - 2
什么是ruby的rack或python的Java的wsgi？还有一个路由库。最佳答案来自Python标准PEP333:Bycontrast,althoughJavahasjustasmanywebapplicationframeworksavailable,Java's"servlet"APImakesitpossibleforapplicationswrittenwithanyJavawebapplicationframeworktoruninanywebserverthatsupportstheservletAPI.ht

java - NonNull Lombok 构建器属性的 FindBugs 检测器

有关java - NonNull Lombok 构建器属性的 FindBugs 检测器的更多相关文章

随机推荐