0

0

在Java里getter和setter方法如何规范编写_Java属性封装实践说明

P粉602998670

P粉602998670

发布时间:2026-01-25 03:35:16

|

447人浏览过

|

来源于php中文网

原创

JavaBeans规范要求getter/setter严格遵循命名约定,如boolean字段用isXxx()、多单词字段驼峰大写、URL字段用getURL(),禁止在其中添加业务逻辑或副作用,并注意Lombok兼容性与继承陷阱。

在java里getter和setter方法如何规范编写_java属性封装实践说明

Java里getter和setter方法不是随便起名或加逻辑就能算“规范”的——IDE自动生成的只是语法合法,不等于符合JavaBeans规范、不影响序列化、不破坏Lombok兼容性,更不一定适合实际业务场景。

getter/setter必须严格遵循JavaBeans命名约定

这是反序列化(如Jackson、XML解析)、反射框架(Spring BeanUtils)、IDE自动识别字段绑定的前提。违反会导致PropertyNotFoundException或静默失败。

  • 布尔类型字段推荐用isXxx()而非getXxx():比如private boolean enabled;public boolean isEnabled()public void setEnabled(boolean enabled)
  • 首字母小写的多单词字段,驼峰后首字母必须大写:比如private String userName;getUserName(),不是getusername()getUserName()拼错成getUsernName()
  • 字段名为URL时,标准写法是getURL(),不是getUrl();但setUrl()会被部分工具误判,稳妥做法是统一用getURL()/setURL(URL url)

不要在getter/setter里写业务逻辑或副作用

看似“方便”,实则埋下严重隐患:Hibernate懒加载触发、Jackson序列化死循环、单元测试难Mock、Lombok@Data生成冲突。

  • 禁止在getCreateTime()里自动调用new Date() —— 这会让每次访问都返回新时间,且破坏不可变性假设
  • 禁止在setName(String name)里做trim()或校验并抛异常 —— setter应只赋值,校验应放在构造函数或专门的validate()方法中
  • 避免getter中调用Objects.requireNonNull()或懒初始化集合:这会让Jackson在序列化时意外触发NPE或改变对象状态

使用Lombok时注意与手动getter/setter共存的陷阱

Lombok的@Getter/@Setter不会覆盖已存在的同签名方法,但会跳过生成 —— 表面无报错,实则行为不一致。

AItools.fyi
AItools.fyi

找到让生活变得更轻松的最佳AI工具!

下载

立即学习Java免费学习笔记(深入)”;

  • 如果类里已有getName(),再加@Getter,Lombok不会警告,但getName()逻辑不会被增强(比如你忘了同步加@NonNull校验)
  • @Data默认包含@Getter/@Setter,但如果某个字段加了transient,Lombok仍会为它生成setter —— 可能导致反序列化时意外覆盖瞬态字段
  • 继承关系中,父类用@Getter,子类手动写getAge(),IDE可能提示“method hides another method”,但运行时JVM按重写规则调用,容易误判行为来源

需要定制行为时,优先用组合而非重写getter/setter

比如字段需加密存储、单位转换、缓存计算结果,硬改getter/setter会让职责混乱,且难以复用。

  • 敏感字段如password,用单独的encryptPassword(String raw)matchesPassword(String input),而不是在setPassword()里加密
  • 时间字段如createTime(数据库存秒级时间戳),暴露为LocalDateTime时,用getCreateTimeAsLocalDateTime()显式命名,不覆盖getCreateTime()(保持原始long语义)
  • 计算属性如fullName,不声明字段,直接提供getFullName(),并加上@JsonIgnore(防JSON序列化)和@Transient(防JPA持久化)
public class User {
    private Long id;
    private String firstName;
    private String lastName;
    private int age;

    // 计算属性,不对应数据库字段
    public String getFullName() {
        return firstName + " " + lastName;
    }

    // 显式转换方法,避免歧义
    public LocalDateTime getBirthDateAsLocalDateTime() {
        return Instant.ofEpochSecond(birthTimestamp).atZone(ZoneId.systemDefault()).toLocalDateTime();
    }
}

真正麻烦的从来不是“怎么写”,而是“为什么不能那样写”——比如getURL()少一个U,可能让OpenAPI文档生成器彻底丢掉这个字段;setEnabled(true)里悄悄记录日志,会让批量更新性能骤降却难以排查。规范不是约束,是降低协作熵值的最小公约数。

相关专题

更多
java
java

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

845

2023.06.15

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

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

743

2023.07.05

java自学难吗
java自学难吗

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

740

2023.07.31

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

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

397

2023.08.01

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

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

400

2023.08.02

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

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

447

2023.08.02

java有什么用
java有什么用

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

431

2023.08.02

java在线网站
java在线网站

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

16947

2023.08.03

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

25

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.8万人学习

C# 教程
C# 教程

共94课时 | 7.5万人学习

Java 教程
Java 教程

共578课时 | 50.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号