从lcomment/development-recipes项目看JPA实体类为何要避免使用Setter方法
2025-06-25 17:30:19作者:戚魁泉Nursing
前言
在JPA实体类设计中,是否应该使用Setter方法一直是一个值得讨论的话题。本文将从实际开发角度出发,结合lcomment/development-recipes项目中的经验,深入分析为什么在JPA实体类中要避免使用Setter方法,以及如何更优雅地实现实体类的更新操作。
为什么应该避免在Entity中使用Setter
1. 代码意图不明确
考虑以下代码示例:
Board board = new Board();
board.setId(1L);
board.setTitle("Test Title");
board.setContent("This is sample Board");
这段代码存在几个问题:
- 我们无法从代码本身判断这是在创建一个新对象还是修改现有对象
- 每个属性的设置都是独立的,缺乏整体性
- 当实体类属性增多时,这种分散的设置方式会使代码可读性急剧下降
2. 破坏对象的一致性
public Board update(Long id) {
Board board = findById(id);
board.setTitle("set title");
board.setContent("set content");
return board;
}
这种实现方式的问题在于:
- 公共的Setter方法使得任何地方都可以修改实体状态
- 无法控制修改的逻辑和顺序
- 可能导致实体处于不一致的状态(比如只设置了部分属性)
- 业务规则难以集中维护
更优雅的实现方式
1. 使用专门的更新方法
@Entity
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Board {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(nullable = false)
private String title;
@Column(nullable = false)
private String content;
@Builder
public Board(String title, String content) {
this.title = title;
this.content = content;
}
public Board update(String title, String content) {
this.title = title;
this.content = content;
return this;
}
}
这种实现方式的优势:
- 更新逻辑集中在实体内部,便于维护
- 可以确保更新后的实体始终处于一致状态
- 方法命名明确表达了意图
- 配合JPA的Dirty Checking机制,能自动检测变更
2. 使用建造者模式
当实体属性较多时,建议使用建造者模式:
@Entity
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Board {
// 属性和注解
@Builder
public Board(String title, String content, String author,
LocalDateTime createTime, Integer viewCount) {
// 初始化逻辑
}
}
// 使用方式
Board board = Board.builder()
.title("Test Title")
.content("Sample Content")
.author("John Doe")
.build();
建造者模式的优点:
- 避免过长的构造器参数列表
- 可以灵活地设置部分属性
- 保持对象创建的一致性和完整性
最佳实践建议
-
尽量将修改逻辑封装在实体内部:为每个需要修改的场景提供专门的方法
-
使用有意义的命名:如
changeTitle()
、increaseViewCount()
等,明确表达方法意图 -
保护不变性:对于不应被修改的属性(如ID、创建时间等),不要提供任何修改方法
-
考虑值对象:对于复杂的属性,可以考虑使用值对象来封装相关属性和行为
-
验证逻辑集中化:在修改方法中加入必要的验证逻辑,确保实体始终处于有效状态
总结
在JPA实体设计中,避免使用公共Setter方法是一种值得提倡的实践。通过将修改逻辑封装在实体内部,我们能够:
- 提高代码的可读性和可维护性
- 确保实体状态的一致性
- 更清晰地表达业务意图
- 减少意外修改的风险
lcomment/development-recipes项目中的这一实践为我们提供了很好的参考,值得在JPA开发中推广应用。
登录后查看全文
热门项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0370Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0102AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
205
2.19 K

暂无简介
Dart
514
115

Ascend Extension for PyTorch
Python
62
95

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
86

React Native鸿蒙化仓库
C++
208
285

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
976
576

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

openGauss kernel ~ openGauss is an open source relational database management system
C++
146
193