规范alibaba编码规范阅读

Posted 2020-10-17 霓裳梦竹

一、编程规范

（一）命名规范

1、代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

2、代码中的命名严禁使用评语与英文混合的方式，更不允许直接使用中文的方式

3、类名使用UpperCamelCase风格，必须遵从驼峰形式，但是：DO BO DTO VO AO除外

4、方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰格式

5、常量名全部大写，单词间用下划线隔开，力求词义表达清楚，不要嫌名字长

6、抽象类命名使用Abstract或Base开头：异常类命名使用Exception结尾：测试类命名以它要测试的类的名称开始，以Test结尾。

7、中括号是数组类型的一部分，使用String[] args 不要使用String args[]的方式

8、POJO类中布尔类型的变量，都不要加is,否则部分框架解析会引起序列化错误。

     定义基本类型Boolean isDeleted的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，以为对应的属性名称是deleted,导致属性获取不到，进而抛出异常。

9、包名统一使用小写，点分隔符有且仅有一个自然语义的英文单词，包名统一使用单数形式。但是类名如果有复数含义，类名可以使用复数形式。

10、杜绝完全不规范的缩写，避免望文生义。

11、为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达词义 eg:PullCodeFromRemoteRepository

12、如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式eg:public class OrderFactory ; public calss LoginProxy ; public class ResourceObserver

13、接口类中的方法和属性不要加任何修饰符号，保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口中定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

14、接口和实现类的命名有两套规则

①、对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类是用Impl的后缀和接口区别

②、如果是形容能力的接口名称，取对应的额形容词做接口名（通常是-able的形式）

15、枚举类名建议加上Enum后缀，枚举成员名称需要大写