本文探讨了在使用lombok的`@getter`和`@builder`注解时，java bean类在sonarqube中出现代码覆盖率不足的问题。核心解决方案是通过在`lombok.config`文件中设置`lombok.addlombokgeneratedannotation = true`，使lombok为生成的代码添加`@generated`注解。sonarqube将默认忽略这些注解的代码，从而准确反映开发者编写逻辑的覆盖率，达到100%覆盖目标。
理解Lombok与SonarQube代码覆盖率挑战
在Java项目中，Lombok通过注解极大地简化了样板代码的编写，例如使用@Getter自动生成getter方法，使用@Builder生成构建器模式。然而，当项目集成SonarQube进行代码质量分析时，我们可能会遇到一个常见问题：即使业务逻辑功能正常，那些仅包含Lombok注解的Java Bean类（如数据传输对象DTO）在SonarQube报告中却显示代码覆盖率不足，甚至对生成的getter方法报告“Not covered by tests”。
这通常发生在像以下示例这样的Bean类中：
// MyBody.java
@Getter
@Builder
public class MyBody {
private String accountNumber;
}
// MyHeader.java
@Getter
@Builder
public class MyHeader {
private String username;
private String password;
}尽管这些类通过MyBody.builder().accountNumber("12345").build()等方式被正确实例化和使用，并且在运行时，@Getter注解确保了字段值能够被正确访问（例如，传递给第三方REST服务时字段值不为null），SonarQube仍然可能将Lombok生成的getter方法标记为未覆盖。这是因为SonarQube的覆盖率工具默认会检查所有可执行代码行，而Lombok在编译时生成的代码对于覆盖率工具来说是“真实”存在的代码，如果这些生成的代码没有被显式地“调用”或“执行”到测试中，就会被标记为未覆盖。
解决方案：利用Lombok的@Generated注解
解决Lombok生成代码的SonarQube覆盖率问题，最优雅且推荐的方式是配置Lombok，使其为所有生成的代码添加@lombok.Generated注解。大多数现代代码覆盖率工具（包括SonarQube使用的JaCoCo）都默认配置为忽略带有@Generated注解的代码，不将其计入覆盖率报告。这样，SonarQube将只关注开发者实际编写的业务逻辑代码的覆盖率，从而实现更准确、更有意义的覆盖率统计。
要启用此功能，您需要在项目的lombok.config文件中添加以下配置：
lombok.addLombokGeneratedAnnotation = true
配置步骤
-
创建或编辑lombok.config文件： 在Maven或Gradle项目的根目录（即pom.xml或build.gradle所在的目录）下创建或编辑一个名为lombok.config的文件。这是Lombok查找项目级配置的默认位置。
- 对于Maven项目，通常位于项目的basedir。
- 关于lombok.config的更多信息和可选位置，可以参考Lombok官方文档。
-
添加配置属性： 将lombok.addLombokGeneratedAnnotation = true这行内容添加到lombok.config文件中。
# lombok.config lombok.addLombokGeneratedAnnotation = true
重新编译并运行SonarQube分析： 在修改lombok.config文件后，请确保重新编译您的项目，以便Lombok能够应用新的配置。然后，再次运行您的单元测试和SonarQube分析。您会发现之前被标记为未覆盖的Lombok生成代码（如getter方法）将不再计入覆盖率计算，从而使您的Java Bean类达到100%的覆盖率（针对非生成代码部分）。
注意事项与总结
- @Generated注解的作用： javax.annotation.Generated（或lombok.Generated）注解是一个标准注解，用于标识由代码生成器生成的代码。它的主要目的是帮助静态分析工具（如代码覆盖率工具、代码质量工具）区分人工编写的代码和自动生成的代码，以便它们可以根据需要进行不同的处理。
- SonarQube的默认行为： SonarQube及其底层覆盖率工具（如JaCoCo）通常默认会忽略带有@Generated注解的代码行。这意味着这些行不会影响您的代码覆盖率百分比。
- 关注核心业务逻辑： 采用此方法后，您的代码覆盖率报告将更准确地反映您手动编写的业务逻辑代码的测试覆盖情况，而不是被Lombok生成的样板代码所干扰。这有助于团队更有效地识别和测试真正需要关注的业务逻辑。
- Lombok版本兼容性： 确保您使用的Lombok版本支持lombok.addLombokGeneratedAnnotation配置。通常，较新版本的Lombok都支持此特性。
通过简单地在lombok.config中添加一行配置，我们能够优雅地解决Lombok与SonarQube代码覆盖率报告之间的冲突，使覆盖率数据更加精确和有意义，从而更好地指导测试工作和代码质量提升。
