栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

《Java 开发手册》嵩山版 (简洁总结版)

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

《Java 开发手册》嵩山版 (简洁总结版)

1.编程规约

【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
不能以 _ 或$ 开始命名和结束命名

【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
不要使用中文命名和尽量不使用拼音命名

【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。
不要种族歧视

【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID 等。
类名大多使用驼峰命名

【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
类内部成员使用小驼峰命名

【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
常量大写并用_分割

【强制】抽象类命名使用 Abstract 或 base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
抽象类、异常类、测试类命名

【强制】类型与中括号紧挨相连来表示数组。
int[] arr

【强制】POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。
数据库表示是与非字段加is,但是实体类中不加is前缀

【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
包名小写和单数,如有复数含义可以用复数

【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可理解性降低。
避免重复命名变量

【强制】杜绝完全不规范的缩写,避免望文不知义。
缩写要适当、不要怕长

【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达。
避免 int a 等类型

【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。
startTime / workQueue / nameList

【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
OrderFactory、LoginProxy、ResourceObserver

【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,确定与接口方法相关,并且是整个应用的基础常量。
去除修饰符号、加注释、尽量不在接口中定义变量

【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别。

【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)

【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
枚举成员名称大写并使用_分割

【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀,复数结尾,如:listObjects。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save/insert 做前缀。
5) 删除的方法用 remove/delete 做前缀。
6) 修改的方法用 update 做前缀。
B) 领域模型命名规约
1) 数据对象:xxxDO,xxx 即为数据表名。
2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
3) 展示对象:xxxVO,xxx 一般为网页名称。
4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/343092.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号