Java开发代码规范之编程规约（一）——命名风格

文章通过学习《阿里巴巴Java开发手册》整理。

1. 代码中的命名禁止以下划线或美元符号开始或结束。
   反例：_name

2. 代码中的命名禁止使用拼音与英文混合的方式，禁止直接使用中文。
   说明：正确的英文拼写和语法易于理解，避免歧义，可视同英文。
   如 alibaba/taobao/youku/hangzhou 等国际通用的名称，可视同英文。

3. 类名使用 UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：DO/BO/DTO/VO/AO
   UpperCamelCase风格 ：“大骆驼拼写法”，第一个词的首字母以及之后的词的首字母都大写
   正例：MarcoPolo/UserDO/XmlService/TcpUdpDeal
   反例：marcoPolo/UserDo/XMLService/TCPUDPDeal

4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
   lowerCamelCase风格：第一个词的首字母小写，后面每个词的首字母大写。
   正例： localValue/getHttpMessage()/inputUserId

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

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

7. 中括号[] 是数组类型的一部分，数组定义：String[] args ;

8. POJO类中布尔类型的变量，不要加is，否则部分框架解析会引起序列化错误。
   反例：定义为基本数据类型Boolean isDeleted的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，“以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。

9. • 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，包名统一使用单数形式。但类名若有复数含义，类名可以使用复数形式。
     正例：应用工具类包名为com.alibaba.open.util、类名为MessageUtils

10. 杜绝完全不规范的缩写，避免望文不知义。
    反例：AbstractClass 缩写命名为 AbsClass，随意缩写降低了代码的可读性。

11. 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意义。
    正例：从远程仓库拉取代码的类命名为PullCodeFromRemoteRepository

12. • 如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
      说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
      正例：public class OrderFactory;
      public class LoginProxy;
      public class ResourceObserver;

13. 接口类中的方法和属性不要加任何修饰符号，public也不要加。保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
    正例：接口方法签名： void f();
    接口基础常量表示：String COMPANY = “alibaba”;
    反例：接口方法定义： public abstract void f();
    说明：JDK8中接口允许有默认实现，则这个default
    方法是对所有实现类都有价值的默认实现。

14. 接口和实现类的命名有两套规则：
    1)对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
    正例：CacheServiceImpl实现CacheService接口。
    注：SOA（面向服务的体系结构，Service-Oriented Architecture），是一个组件模型，它将应用程序的不同功能单元（服务）通过这些服务之间定义良好的接口和契约联系起来。接口是采用中立的方式进行定义的，它应该独立于实现服务的硬件平台、操作系统和编程语言。这使得构建在各种这样的系统中的服务可以以一种统一和通用的方式进行交互。【百科】
    2)如果是形容能力的接口名称，取对应的形容词做接口名（通常是-able的形式）
    正例：AbstractTranslator实现Translatable

15. 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
    说明：枚举 是特殊的常量类，且构造方法被默认强制是私有。
    正例：枚举名字为ProcessStatusEnumerate的成员名称：SUCCESS/ UNKNOWN_REASON

16. 各层命名规约：
    A)Service/DAO层方法命名规约
    1)获取单个对象的方法用get做前缀
    2)获取多个对象的方法用list做前缀
    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