阿里java开发手册阅读- 编程规约[命名风格]

编程规约
(一)命名风格
【强制项目】代码命名不能{下划线/美元符号}开始或者结束
【强制项目】代码命名严禁使用拼音和英语混合的方式,更不允许直接使用中文的方法、
【强制项目】类名使用UpperCamelCase风格,例外的形况DO/BO/DTO/VO/AO/PO/UID等
介绍DO等含义:
https://blog.csdn.net/uestcyms/article/details/80244407
【强制项目】方法名,参数名,成员变量,局部变量都统一使用lowerCamelCase风格,必须遵从驼峰格式
【强制项目】常量命名全部大写,单词之间用下划线隔开,力求语义表达完成清晰,不要嫌名字长
【强制项目】抽象类命名使用Abstract活着Base开头;异常的命名使用Exception结尾;测试类命名以他要测试的类的名称开始,以Test结尾。
【强制项目】类型与中括号紧挨相连来表示数组
例如:int[] arrayDemo; 反例String args[]
【强制项目】POJO类中的布尔值变量都不要加is前缀,否则部分框架解析会引起序列化错误。
【强制项目】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统 一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
例如包名:com.alibaba.ai.util 类名MessageUtils
【强制项目】避免在子父类的成员变量之间,或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低。
在这里插入图片描述
【强制项目】杜绝不规范的缩写,避免望文不知意。
【推荐项目】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完成的单词组合来表达其意
【推荐项目】在常量与变量的命名时,表示类型的名词放在词尾,以提高辨识度。
【推荐项目】如果模块,接口,类,方法使用了设计模式,在命名时需要体现出具体模式。
【推荐项目】接口类中的方法和属性不要加任何修饰符(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

发布了35 篇原创文章 · 获赞 1 · 访问量 615

猜你喜欢

转载自blog.csdn.net/weixin_39232166/article/details/105235863