Java编程规约（阿里强制规约）

目录

一、命名规范        二、常量定义        三、代码格式        四、OOP规约

 五、集合处理        六、并发处理        七、控制语句        八、注释规约

九、其他

一、命名规范

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

        反例：_name / __name / $Object / name_ / name$ / Object$ 

2. 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

        正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
        反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

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

        正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
        反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

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

        正例： localValue / getHttpMessage() / inputUserId

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

        正例：MAX_STOCK_COUNT
        反例：MAX_COUNT

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

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

        反例：使用 String args[]的方式来定义。

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

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

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

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

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

        反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

11.  接口和实现类的命名有两套规则，下面只介绍强制规则：

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

二、常量定义

1. 不允许任何魔法值（即未经定义的常量）直接出现在代码中。

        反例：

String key = "Id#taobao_" + tradeId;
cache.put(key, value); 

 2. long 或者Long 初始赋值时，使用大写的 L