提升 Lombok Bean 类在 SonarQube 中的代码覆盖率

本文旨在解决使用 Lombok 的 `@Getter` 和 `@Builder` 注解的 Java Bean 类在 SonarQube 代码覆盖率报告中显示字段未被测试覆盖的问题。核心解决方案是通过在 `lombok.config` 文件中添加 `lombok.addLombokGeneratedAnnotation = true` 配置，使 Lombok 为其生成的代码自动添加 `@Generated` 注解，从而让 SonarQube 在统计覆盖率时忽略这些由 Lombok 产生的样板代码，确保覆盖率报告的准确性。

在现代 Java 开发中，Lombok 库因其能够大幅减少样板代码而广受欢迎，尤其是在数据传输对象（DTO）或实体类（Bean）的构建上。通过 @Getter、@Setter、@Builder 等注解，开发者可以简洁地定义类结构。然而，在使用 SonarQube 进行代码质量和覆盖率分析时，这些由 Lombok 生成的代码有时会带来困扰，导致即使业务逻辑已充分测试，报告中仍显示某些字段或方法“未被测试覆盖”，进而影响整体覆盖率指标。

背景与问题描述

考虑以下使用 Lombok 注解的 Java Bean 类示例，它们常用于构建 RESTful API 请求体：

// MyRequest.java (略)
// 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() 这样的方式构建对象，并在集成测试中验证其功能时，我们通常会认为这些 Bean 类是“被覆盖”的。然而，SonarQube 报告却可能指出 accountNumber、username 和 password 等字段“Not covered by tests”。

这种现象的根源在于 Lombok 在编译时会自动生成对应的 getter、setter、builder 方法以及构造函数等。SonarQube 在计算代码覆盖率时，会将这些由 Lombok 生成的字节码也纳入统计范围。如果测试用例没有直接或间接（例如通过反射）调用到这些生成的 getter 方法，或者构建器内部的特定逻辑，SonarQube 就会认为这部分代码未被执行，从而标记为未覆盖。特别是在需要 @Getter 注解以确保第三方 REST 端点能够正确解析对象属性时（例如，在某些序列化场景下，即使不显式调用 getter，其存在也是必需的），这个问题尤为突出。

代码小浣熊

代码小浣熊是基于商汤大语言模型的软件智能研发助手，覆盖软件需求分析、架构设计、代码编写、软件测试等环节

51

查看详情

解决方案：Lombok 配置与 @Generated 注解

解决此问题的核心思路是告知 SonarQube 忽略由 Lombok 自动生成的代码。Lombok 提供了一个配置选项，可以让它在生成代码时自动添加 javax.annotation.Generated 注解。大多数静态代码分析工具（包括 SonarQube）都默认配置为忽略带有此注解的代码，不将其计入覆盖率或质量分析范围。

要启用此功能，您需要在项目的 lombok.config 文件中添加以下配置：

lombok.addLombokGeneratedAnnotation = true

操作指南

1. 创建或编辑 lombok.config 文件： 在您的 Java 项目的根目录（通常是 pom.xml 或 build.gradle 所在的目录）下，创建一个名为 lombok.config 的文件。如果该文件已存在，则直接编辑它。

2. 添加配置属性： 将 lombok.addLombokGeneratedAnnotation = true 这行配置添加到 lombok.config 文件中。

   示例 lombok.config 文件内容：

   # 启用为Lombok生成的代码添加@Generated注解
   lombok.addLombokGeneratedAnnotation = true
   
   # 其他Lombok配置...
   # lombok.log.fieldName = LOG
   # lombok.equalsAndHashCode.callSuper = call

   登录后复制

3. 重新构建项目： 在修改 lombok.config 后，您需要重新构建您的项目，以确保 Lombok 重新处理您的源代码并生成带有 @Generated 注解的字节码。

4. 重新运行 SonarQube 分析： 执行您的 SonarQube 分析任务。此时，SonarQube 将会识别并忽略那些由 Lombok 生成的、带有 @Generated 注解的代码，从而更准确地反映您手动编写的业务逻辑代码的覆盖率。

重要提示

• javax.annotation.Generated 的可用性： Lombok 默认会尝试使用 javax.annotation.Generated 注解。在 Java 9 及更高版本中，这个注解位于 java.base 模块中，无需额外依赖。对于 Java 8 及更早版本，如果您的项目中没有引入 javax.annotation-api 或类似的库，Lombok 可能会使用其内部的 lombok.Generated 注解。通常情况下，SonarQube 都能识别并处理这两种情况。
• SonarQube 配置验证： 虽然 SonarQube 通常默认会忽略 @Generated 注解的代码，但最好还是确认您的 SonarQube 实例或项目配置中没有覆盖或禁用此行为。
• 关注核心业务逻辑： 此方法旨在清理因 Lombok 样板代码造成的覆盖率噪音。它并不能替代对核心业务逻辑的充分测试。确保您的测试用例仍然全面覆盖了所有非 Lombok 生成的、具有业务意义的代码。
• Lombok 配置的优先级： lombok.config 文件的配置具有优先级。Lombok 会从项目根目录开始向上查找 lombok.config 文件，并合并配置。确保您在正确的层级配置了此属性。

通过上述配置，您可以有效地解决 Lombok 生成代码在 SonarQube 覆盖率报告中的“未覆盖”问题，从而获得更精确、更有意义的代码覆盖率指标，专注于真正需要测试的业务逻辑。

以上就是提升 Lombok Bean 类在 SonarQube 中的代码覆盖率的详细内容，更多请关注php中文网其它相关文章！