命名规范及部分书写规范----参照阿里巴巴java开发手册

Posted 2020-10-11

只列一些我能看懂的....

1类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO 

　　正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

　　反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

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

　　正例： localValue / getHttpMessage() / inputUserId 

3常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
　　正例：MAX_STOCK_COUNT 反例：MAX_COUNT

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

5 中括号是数组类型的一部分，

　　数组定义如下：String[] args; 反例：使用 String args[]的方式来定义

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

　　正例：     应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

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

　　正例：接口方法签名：void f();       接口基础常量表示：String COMPANY = "alibaba";

　   反例：接口方法定义：public abstract void f(); 

8接口和实现类的命名有两套规则：

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

　　2）【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。 正例：AbstractTranslator 实现 Translatable。