0

0

如何定义一个标准的Java类_成员变量与方法的声明规范

P粉602998670

P粉602998670

发布时间:2026-03-15 13:52:31

|

129人浏览过

|

来源于php中文网

原创

成员变量绝大多数情况下应使用 private + final 修饰,以保障封装性和不可变性;仅在特定场景(如子类需修改、常量、临时缓存)可例外,但须严格遵循规范。

如何定义一个标准的java类_成员变量与方法的声明规范

成员变量必须用 private + final 修饰吗?

不是必须,但绝大多数情况下应该这样。public 或 package-private 成员变量会破坏封装,让外部代码直接读写状态,后续改逻辑时极易出错;protected 更危险,子类能随意篡改父类内部状态。

常见错误现象:NullPointerException 频发、单元测试难写、重构时发现几十个地方在直接改 user.name

  • 只在明确需要被子类继承且允许修改时才用 protected,且必须加 Javadoc 说明“此字段可被子类重写”
  • 常量用 public static final,但值必须是编译期常量(如 "API_V1"),不能是 new Date() 这类运行时对象
  • 如果变量只是临时缓存、且不参与业务逻辑(比如 private Map<String, Object> cache;),可以不加 final,但必须配 @SuppressWarnings("unused") 或明确初始化

方法命名和参数顺序怎么才算“标准”?

Java 标准不是靠记忆,而是靠 IDE 和静态检查工具强制落地。方法名必须是动宾结构(calculateTaxvalidateEmail),不能是名词(taxCalculator)或形容词(valid)。

参数顺序影响调用可读性。比如 copy(File src, File dest) 是标准顺序,反过来就反直觉;再比如 substring(int beginIndex, int endIndex) 的索引顺序,JDK 自己也踩过坑(早期 String.substring 在负数下行为不一致,现在已修复)。

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

  • 布尔参数绝不能单独出现:禁止 save(true),应拆成 saveWithValidation()saveWithoutValidation()
  • 多个同类型参数(如 int)必须用封装类替代,避免传错顺序:new Point(x, y) 容易写成 new Point(y, x),而 Point.of(x, y) 更安全
  • Builder 模式里,必填参数放构造函数,选填参数走 setter —— 否则 new Builder().build() 可能返回非法对象

什么时候该用 record 而不是 class?

record 是 Java 14 引入的不可变数据载体,它不是“简化 class”,而是语义完全不同:record 表达“这就是一组值”,class 表达“这是一个有行为的对象”。误用 record 最常见的坑是试图在 toString() 里加日志,或给 record 加 setter。

ChatDOC
ChatDOC

ChatDOC是一款基于chatgpt的文件阅读助手,可以快速从pdf中提取、定位和总结信息

下载

使用场景很窄:DTO、JSON 反序列化目标、函数返回值、Map 的 key —— 所有这些都不该有业务逻辑。

  • 只要字段需要校验(如 age > 0)、需要懒加载、需要监听变更,就别用 record,老实用 class + 私有字段 + 构造器校验
  • record 的 canonical constructor 不能省略参数,也不能加 throws,否则编译失败:public Person(String name) { if (name == null) throw new IllegalArgumentException(); } 是合法的,但 public Person(String name) throws IOException 不行
  • record 默认实现 equals/hashCode 基于所有字段,如果某个字段不该参与比较(比如 lastModifiedTime),就不能用 record

为什么 getter/setter 不是“标准规范”的一部分?

因为它们是封装的副产品,不是目的本身。JDK 从没规定“每个字段都要配 getter/setter”,Spring、Jackson 等框架也早就支持直接访问私有字段(通过反射或 VarHandle)。

真实项目里,90% 的 setXXX() 方法其实只是把值塞进字段,毫无逻辑;而真正需要控制写入时机的字段(如 status),往往要走 transitionTo(Status next) 这种带状态校验的方法。

  • 只读字段只暴露 getter,不要加无意义的 setter —— IDE 自动生成的 setXxx 很容易被误调用
  • 集合类字段(如 List<Item>)的 getter 必须返回不可变副本:Collections.unmodifiableList(items),否则外部能直接改内部状态
  • Lombok 的 @Data 会盲目生成所有 getter/setter,上线前务必 grep 检查有没有 setPassword 这类危险方法漏网

最常被忽略的一点:字段初始化时机和构造器顺序。比如 private final List<String> tags = new ArrayList<>(); 看似安全,但如果父类构造器里调用了被子类重写的 init(),而该方法又访问了 tags,就会触发 NullPointerException —— 因为子类字段还没初始化完。这种 bug 往往只在特定继承链下复现,很难测出来。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

161

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

89

2026.01.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

83

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1051

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.4万人学习

Java 教程
Java 教程

共578课时 | 82.3万人学习

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

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