阿里巴巴开发手册总结——编程规约（1）

绪论

1，缩进采用空格，用4个空格代替tab键

2，if/for单语句必须加大括号（局部变量作用域）

3，左大括号不换行

第一章

1.1 命名风格

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

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

3，类名使用UpperCamelCase风格，但DO/BO/DTO//VO/AO/PO等情况例外

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

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

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

7，类型与中括号之间无空格相连定义数组；

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

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

10，避免在子类的成员变量之间或者不同代码块的局部变量之间采用完全相同的命名方式，使可读性降低

11，杜绝完全不规范的缩写，避免词不达义

12，为了达到代码自然解释的目标，任何自定义编程元素在命名时，使用尽可能完整的单词组合来表达其义

13，在常量与变量的命名时，表达类型的名词放在词尾，以提升标识度

14，如果模块、接口、类、方法使用了设计模式，应在命名时体现出具体模式

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

16，接口中和实现类的命名有两套规则：

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

    2）如果是形容能力的接口名称，去对应的形容词为接口名（通常是-table的形式）

17，美剧类名建议带上Enum后缀，美剧成员名称需要全大写，单词间用下划线隔开

18，各层命名规约：

   1）Service/DAO层方法命名规约如下。

• 获取单个对象的方法用get作为前缀
• 获取多个对象的方法用list作为前缀，复数结尾，如：listObjects
• 获取统计值的方法用count作为前缀
• 插入的方法用save/insert作为前缀
• 删除的方法用remove/delete作为前缀
• 修改的方法用update作为前缀

2）领域模型命名规约如下。

• 数据对象：xxxDO，xxx为数据表名
• 数据传输对象：xxxDTO，xxx为业务领域相关的名称
• 展示对象：xxxVO,xxx一般为网页名称
• POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO