alibaba-Java开发手册心得-一编程规约-1命名风格

标签：序列化   工具   风格   sla   方法   命名   class   factor   之间   

1.【强制】不能以 _ $开始 或结束

2.【强制】严禁使用 拼音和英文混合，或中文。即使是纯拼音也要避免使用。除非是国际通用的例如taobao youku 等。

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. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。

正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;

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

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

反例：接口方法定义：public abstract void f(); 说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。

13. 接口和实现类的命名有两套规则： 1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。 正例：CacheServiceImpl实现CacheService接口。 2） 【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。 正例：AbstractTranslator实现 Translatable。

alibaba-Java开发手册心得-一编程规约-1命名风格

标签：序列化   工具   风格   sla   方法   命名   class   factor   之间   

原文地址：http://www.cnblogs.com/mmd233/p/7069454.html