如何为 Lombok 注解编写单元测试:正确实践与配置指南

夏瑶同学_5513

夏瑶同学_5513

2026-07-10

997人浏览

原创

如何为 Lombok 注解编写单元测试:正确实践与配置指南

lombok 生成的 getter、setter、构造器等代码无需手动编写单元测试;应通过排除 lombok 生成代码来提升覆盖率统计准确性,并聚焦于业务逻辑的真实验证。

lombok 生成的 getter、setter、构造器等代码无需手动编写单元测试;应通过排除 lombok 生成代码来提升覆盖率统计准确性,并聚焦于业务逻辑的真实验证。

Lombok 的核心价值在于消除样板代码(boilerplate),而非引入新的可测行为。当你在类上添加 @Data、@NoArgsConstructor 或 @AllArgsConstructor 等注解时,Lombok 在编译期自动生成字段访问器、构造方法和 toString()/equals()/hashCode() 等方法——这些是编译器插件行为,其正确性由 Lombok 官方团队负责保障与测试,正如你不会为 javac 编译出的字节码结构或 switch 语句的语义写测试一样。

因此,对如下类:

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ABC {
    private String status;
    private String errorCode;
    private String message;
    private String id;
    private Long orderNumber;
    private Long lineId;
}

✅ 推荐做法是:不为 Lombok 自动生成的方法编写测试用例
❌ 不应编写类似 testupdate_1() 这样仅调用 setter/getter 并断言默认值的测试——它既不验证业务逻辑,也无法提升软件质量,反而稀释测试维护成本与信号噪声比。

? 正确提升代码覆盖率的方案:配置覆盖率工具忽略 Lombok 生成代码

以主流工具为例:

Codiga
Codiga

Codiga是一款面向 IDE 和 CI/CD 的实时静态代码分析与自动代码审查工具。

下载
  • JaCoCo(Maven):在 pom.xml 中添加 excludes 规则:

    <plugin><groupid>org.jacoco</groupid><artifactid>jacoco-maven-plugin</artifactid><version>0.8.12</version><configuration><excludes><exclude>**/*$AjcClosure*.class</exclude><exclude>**/lombok/**</exclude><exclude>**/*Lombok*.class</exclude><!-- 排除所有 Lombok 增强类(关键) --><exclude>**/*$*.*</exclude></excludes></configuration></plugin>
  • IntelliJ IDEA / Gradle + JaCoCo:可在 jacocoTestReport 任务中配置 classDirectories 过滤,或使用 @Generated 注解配合 @Generated("lombok")(需启用 lombok.addLombokGeneratedAnnotation = true)并让 JaCoCo 忽略 @Generated 标记的类。

? 何时才需要“测试 Lombok 类”?
仅当该类参与有意义的业务交互时,才需测试其行为,例如:

  • 测试 equals() 和 hashCode() 是否满足业务一致性(如用于 HashSet 去重);
  • 测试 @Builder 构建的对象是否符合不变式;
  • 测试 @ToString(exclude = "password") 是否真正脱敏;
  • 验证 @RequiredArgsConstructor 下的不可空字段注入是否触发预期异常。

示例(验证 equals 行为):

@Test
void testEqualsAndHashCode() {
    ABC a = new ABC("OK", "ERR001", "Success", "id-1", 100L, 1L);
    ABC b = new ABC("OK", "ERR001", "Success", "id-1", 100L, 1L);
    assertEquals(a, b);
    assertEquals(a.hashCode(), b.hashCode());
}

? 总结建议:

  • ✅ 将测试资源聚焦于:业务逻辑、边界条件、异常流、集成行为;
  • ✅ 配置覆盖率工具跳过 Lombok 生成代码(非源码行),使覆盖率真实反映你的代码质量;
  • ✅ 如需验证 Lombok 行为(如 @Builder.Default、@Singular),优先使用编译期检查(如启用 lombok.anyConstructor.addConstructorProperties = true)或小范围契约测试;
  • ❌ 避免“为覆盖而覆盖”,尤其不要为 setXxx()/getXxx() 编写无业务语义的测试——这违背测试驱动开发(TDD)初衷,也损害长期可维护性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9437

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6602

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5872

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1024

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1236

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2489

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19831

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1115

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习