阿里巴巴代码规约整理（强制）

一、编程规约

（一）命名风格

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

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

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

        正例：ali / taobao / aliyun / youku (国际通用的名称，可视同英文）

        反例：pingJia(评价） DaZhe （打折） DianYing(电影）

3、代码和注释中避免使用任何语言的种族歧视性词语。

        反例：RIBENGUIZI / slave

4、类名使用UpperCamelCase风格，但以下情形除外：DO/BO/DTO/VO/AO/PO/UID等

        正例：ForceCode / UserDO /

        反例：forcecode / userdo

5、方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。

        反例：getAge / setAge / localValue

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

        正例：MAX_STOCK_COUNT / CACHE_EXPRIES_TIME

7、抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类

命名以它要测试的类的名称开始，以 Test 结尾

8、类型与中括号紧挨相连来表示数组。

        正例：int[] arrayDemo

9、POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列

化错误。

        说明：在本文MySQl规约中的建表约定第一条，表达是与否的变量采用is_xxx的命名方 式，        所以需要在<resultMap>设置从is_xxx到xxx的映射关系

        反例：Boolean isDeleted这个属性，它的方法也是isDeleted（），框架在反向解析的时候，      误以为对应属性名称是deleted，导致属性获取不到，进而抛出异常。

10、包名统一使用小写，点分隔符之间有且仅有个自然语义的英语单词。包名统一使用

单数形式，但是类名如果有复数含义，类名可以使用复数形式

        正例：com.qcby.user

11、避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，

使可理解性降低

        说明：子类、父类之间变量名相同，即使是public类型的变量也能通过编译，另外，局部变量    在同一方法内的不同代码块中同名也是合法的，这些情况我们都要避免，对于非setter/getter的      参数名称也要避免与成员变量名称相同。

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

13、对于service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用lmpl的后缀与接口区别。

        正例：cacheServicelmpl实现CacheService接口

14、各层命名规约：

     Service/DAO层方法命名规约

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

（二）常量定义

1、不允许使用魔法值（未经预先定义的常量）直接出现在代码当中

if (age < 18) { console.log(“未成年”); }
//此时18就是魔法值，将其变为下面形式，
const MINOR_AGE = 18; 
if (age <