如何告诉 lombok 生成的 getter 是 @Override

Question

我在我的项目中使用 lombok 并且我有一个界面：

public interface MyInterface{

    Object getA()
}

还有一个班

@Getter
public class MyClass implements MyInterface{

      private Object a;

      private Object b

}

而且我检查了生成的类，类中生成的方法不是@Override

我想知道如何添加此注释？ 缺少@Override的后果是什么？

这可能是另一个问题，但此代码由声纳分析，声纳说从未使用过私有字段 a。

我已经看过关于sonarqube + lombok = 误报的主题

但在我的情况下， b 不会产生误报。 所以我不认为这有直接关系

您是否看到无需重新实现 getA() 即可避免此问题的解决方案？

Answer 1

您可以使用注释的onMethod属性将您想要的任何注释添加到生成的方法中。

@Getter
public class MyClass implements MyInterface{
    @Getter(onMethod = @__(@Override))
    private Object a;
    private Object b
}

在这种情况下，作为风格问题，我可能会将类级别的@Getter移动到另一个字段。 如果有c ， d ， e都应该使用正常（无注释）@Getter 逻辑，我会保留如上。

public class MyClass implements MyInterface{
    @Getter(onMethod = @__(@Override))
    private Object a;
    @Getter
    private Object b
}

您可能还想启用 Lombok 的生成注释。 它将防止某些工具（覆盖、静态分析等）打扰检查 Lombok 的方法。 不确定在这种情况下它是否会有所帮助，但我几乎在所有项目中都启用了它。

lombok.addLombokGeneratedAnnotation = true

Answer 2

您可以添加@Override通过使用一个特定的领域@Getter的onMethod 。

例如

@Getter(onMethod = @__(@Override))
private Object a;

@Override 对代码本身没有影响。 它只是通知编译器该方法正在覆盖其超类中的方法。 如果该方法没有覆盖超类中的方法，编译器将导致构建失败。

Answer 3

防止通过Error Prone （或类似工具）对缺少 @Override 进行误报检测的更通用方法是配置 Lombok 以使用@lombok.Generated注释其生成的代码。 这可以通过将以下条目添加到 Lombok 的lombok.config来全局完成：

lombok.addLombokGeneratedAnnotation = true

请注意，这不是一个通用的解决方案 - 相关工具需要尊重@lombol.Generated （或者更好，任何@*.Generated ）注释。

Jacoco和Error Prone （最近）等工具已经支持它。