阿里Java开发手册节选（嵩山版）

Posted 2021-10-30 originalFZH

虚静出内功

---

代码规范（节选）

1. 代码命名均不能以下划线或者美元符号开始，也不能以下划线或美元符号结束
2. 所有编程相关命名都严禁使用拼音和英文混合方式，也不允许直接使用中文
3. 类名使用UpperCamelCase风格，但以下情形例外：DO/BO/DTO/VO/AO/PO/UID等，
   正确命名示例：ForceCode、UserDao、htmlDTO等
4. 方法名、参数名、成员变量、局部变量统一使用lowerCamelCase风格，
   正确命名示例: localValue、getHttpMessage()
5. 常量命名全部大写，单词间用下划线隔开，如：MAX_STOCK_COUNT、CACHE_EXPIRED_TIME
6. 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾，测试类命名以它要测试的类的名称开始，以Test结尾
7. 类型与中括号紧挨相连来表示数组，如：int[] arrayDemo
8. POJO类中的任何布尔类型变量，都不要加is前缀，否则部分框架解析会引起序列化错误
9. 包名统一使用小写，包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式
10. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名使可理解性降低
11. 杜绝完全不规范的缩写，避免望文不知义，反例：AbstractClass缩写成AbsClass; condition缩写成condi;Function缩写成Fu 。自定义编程元素在命名时，使用尽量完整的单词组合来表达
12. 常量与变量命名时，表示类型的名词放在词尾，以提升辨识度，如：startTime、nameList
13. 接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码简洁性，并加上有效的javadoc注释，尽量不要在接口中定义变量
14. 对于Service和DAO类，基于SOA理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别
15. 各层命名规约：
    1. Service/DTO层方法命名规约：
       • 获取单个对象的方法用get做前缀
       • 获取多个对象的方法用list做前缀，复数结尾，如listObjects
       • 获取统计值的方法用count做前缀
       • 插入的方法用save/insert做前缀
       • 删除的方法用remove/delete做前缀
       • 修改的方法用update做前缀
    2. 领域模型命名规约：
       • 数据对象：xxxDO, xxx即为数据表名
       • 数据传输对象：xxxDTO, xxx为业务领域相关的名称
       • 展示对象：xxxVO, xxx一般为网页名称
       • POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO

后续更新整理的其他部分…