如何在Java中利用Lombok插件简化实体类的冗余代码

陌墨君_1066

陌墨君_1066

2026-04-16

847人浏览

原创

lombok需启用ide注解处理并配置构建工具依赖才能生效:intellij须安装lombok插件并开启enable annotation processing,maven中lombok scope必须为provided,gradle需同时声明compileonly和annotationprocessor;@data虽便捷但默认生成所有字段setter、全量equals/hashcode,易引发id误修改、敏感信息泄露或jackson序列化失败,应按需拆分使用@getter/@setter等细粒度注解并显式控制访问级别与字段范围。

如何在java中利用lombok插件简化实体类的冗余代码

不用手写 getter、setter、toString、equals 和 hashCode —— Lombok 能在编译期自动生成,但必须配对启用注解和编译器支持,否则 IDE 报红、运行时报 NoClassDefFoundError 或字段访问失败。

为什么加了 @Data 但 IDE 里字段标红、提示“cannot resolve symbol”

这是最常见卡点:Lombok 注解本身不生成字节码,依赖 IDE 插件和编译器插件协同工作。

  • IntelliJ 用户必须安装并启用 Lombok Plugin(Settings → Plugins → 搜索 “Lombok”,勾选启用)
  • 项目需在构建工具中声明 Lombok 依赖,且 lombok 的 scope 必须是 provided(Maven)或 annotationProcessor(Gradle),否则编译时找不到注解处理器
  • Maven 示例:
    <dependency><groupid>org.projectlombok</groupid><artifactid>lombok</artifactid><scope>provided</scope></dependency>
  • Gradle 示例:
    compileOnly 'org.projectlombok:lombok:1.18.32'
    annotationProcessor 'org.projectlombok:lombok:1.18.32'

@Data 看似省事,但哪些场景下它反而埋雷

@Data 是 @Getter + @Setter + @RequiredArgsConstructor + @ToString + @EqualsAndHashCode 的组合,但默认行为未必符合业务约束。

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
  • 所有字段都生成 setter —— 如果某个字段应只读(如 ID、创建时间),用 @Data 就破坏了封装;改用 @Getter + @Setter(access = AccessLevel.NONE) 单独控制
  • @EqualsAndHashCode 默认包含所有非静态非瞬态字段,若实体含 List 或嵌套对象,可能引发递归比较或 NPE;建议显式指定 include 或 exclude 字段
  • @ToString 打印敏感字段(如密码)—— 可加 @ToString.Exclude 标记对应字段

如何让 Lombok 生成的构造函数真正符合初始化需求

@Data 只生成无参构造 + 全参构造(如果用了 @RequiredArgsConstructor),但多数场景需要的是“仅含必填字段”的构造函数。

  • 用 @RequiredArgsConstructor 替代 @Data,再配合 final 或 @NonNull 字段:Lombok 会为所有 final 字段和带 @NonNull 的字段生成参数构造函数
  • 若字段可为空但逻辑上必填,用 @NonNull 触发空检查(运行时抛 NullPointerException),比全参构造更安全
  • 避免混用 @AllArgsConstructor 和 @RequiredArgsConstructor —— 后者会被前者覆盖,导致必填校验失效

序列化/反序列化时 @Data 与 Jackson 的冲突怎么破

Lombok 生成的 setter 和 getter 方法名符合 JavaBean 规范,但 Jackson 默认依赖这些方法;一旦字段命名不规范(如 userId 对应 setUserID),或用了 @Accessors(fluent = true),Jackson 就会找不到访问器。

  • 确认字段命名使用标准驼峰(userName,不是 USERNAME 或 user_name)
  • 禁用 @Accessors 类注解,除非你同时配置 Jackson 的 PropertyNamingStrategies
  • 若需忽略某字段序列化,优先用 @JsonIgnore(Jackson)而非 @ToString.Exclude(Lombok),二者作用域不同
  • 反序列化报错 Cannot construct instance of X:大概率是缺少无参构造函数 —— 加 @NoArgsConstructor,别依赖 @Data 自带的(它可能被其他注解抑制)

最易被忽略的一点:Lombok 的注解处理发生在编译期,但 IDE 的语法检查和代码补全是实时的。两者不同步时,表面看代码“没报错”,实际编译失败。遇到奇怪的红标或运行异常,先关掉 IDE 的 “Build project automatically”,手动 mvn compile 看真实错误,再回头查插件和注解配置是否对齐。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

9457

6

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

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

2023.07.05

6622

9

java自学难吗
java自学难吗

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

2023.07.31

5892

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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习