学习嵩山版《Java 开发手册》:编程规约 - 命名风格(P3 ~ P4)
概述
-
《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,他旨在提升开发效率和代码质量
-
《Java 开发手册》是一本极具价值的 Java 开发规范指南,对于提升开发者的综合素质和代码质量具有重要意义
-
学习《Java 开发手册》是一个提升 Java 编程技能、了解行业最佳实践和规范的好方法
编程规约 - 命名风格 P3
- 【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。
// 正例
日本人
印度人
blockList
allowList
secondary
// 反例
RIBENGUIZI
Asan
blackList
whiteList
slave
编程规约 - 命名风格 P4
1、基本介绍
- 【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO /
PO / UID 等
// 正例
ForceCode
UserDO
HtmlDTO
XmlService
TcpUdpDeal
TaPromotion
// 反例
forcecode
UserDo
HTMLDto
XMLService
TCPUDPDeal
TAPromotion
2、学习补充
(1)UpperCamelCase 风格
-
UpperCamelCase 是指每个单词的首字母都大写(包括第一个单词),中间不使用任何分隔符
-
在 Java 中,通常建议类名、接口名、枚举名等使用 UpperCamelCase 风格
// 例如
MyClass
UserService
(2)特定情形的类名
类名 | 说明 |
---|---|
【xxx】DO(Data Object) | 数据对象,通常用于表示数据库中的一行数据 |
【xxx】BO(Business Object) | 业务对象,通常用于业务逻辑层,表示业务实体 |
【xxx】DTO(Data Transfer Object) | 数据传输对象,用于服务之间或层之间传递数据 |
【xxx】VO(View Object) | 视图对象,通常用于表示层,用于展示数据 |
【xxx】AO(Application Object) | 应用对象,可能用于特定于应用层的业务逻辑 |
【xxx】PO(Persistent Object) | 持久化对象,与数据库表结构对应,有时与 DO 混用 |