《阿里巴巴Java开发手册 1.4.0 》 码出高效，码出质量
一、编程规约
（一）命名风格
1、【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 不能以特殊符号开始和结束。
反例：_name / __name / $name / name_ / name$ / name__
2、【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中的方式。 命名要合理，纯英文的语义。
正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
3、 【强制】类名使用UpperCamelCase风格，但是以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。 类名要使用驼峰式命名规则，以大写字母开头。
正例：MarcoPolo
反例：macroPolo
4、【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。 类名要使用驼峰式命名规则，以小写字母开头。
正例：localVaule
5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清除，不要嫌名字常。 常量的命名需要清除，并全部都是大写。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
6、【强制】抽象类命名使用Abstract 或 Base 开头；异常类命名使用Exception 结尾；测试类命名以它要测试的类名称开始，以Test结尾。
7、【强制】类型与中括号紧挨相连来表示数组。
正例：定义整形数组int[] arrayDemo;
反例：在main参数中，使用String args[]来定义。
8、【强制】POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。 布尔类型不要加is 前缀。
反例：定义为基本数据类型Boolean isDeleted的属性，它的方式也是isDeleted() ， RPC框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进行抛出异常。
9、【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为 com.alibaba.ai.util 、类名为MessageUtils （此规则参考spring的框架结构）
10、【强制】杜绝完全不规范的缩写，避免望文不知义。 不要随意缩写来命名。
反例：AbstractClass “缩写”命名成AbsClass；condition “缩写”命名成condi，此类随意缩写严重降低了代码的可阅读性。
11、【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：在JDK中，表达原子更新的类名为：AtomicReferenceFieldUpdater
反例：变量int a的随意命名方式
12、【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
13、【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名 void commit();
接口基础常量String COMPANY = "alibaba"
反例：接口方法定义public abstract void f();
说明：JDK8 中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
14、接口是实现类的命名有两套规则：
1） 【强制】对于service和DAP类，基于SOA的理念。暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：CacheServiceImpl 与 CacheService接口。
2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able的形式）。
正例：AbstractTranslator 实现 Translatable接口。
15、【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。
正例：枚举名字为ProcessStatusEnum的成员名称：SUCCESS / UNKNOWN_REASON。
16、【参考】各层命名规约：
A） Service / DAO层方法命名规约
1） 获取单个对象的方法用get前缀
2）获取多个对象的方法用list 做前缀，复数形式结尾如：listObjects。
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。
五、MySQL数据库
（一）建表规约
1、【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsigned tinyint （1表示是，0表示否）。
说明：任何字段如果为非负数，必须是unsigned。
注意：POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在<resultMap>设置从is_xxx 到Xxx的映射关系。数据库表示是与否的值，使用tinyint类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
正例：表达逻辑删除的字段名is_deleted，1 表示删除， 0 表示未删除。
2、【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代码很大，因为无法进行预发布，所以字段名需要慎重考虑。
说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。因此，数据库名、表明、字段名，都不允许出现任何大写字母，避免节外生枝。
正例：aliyun_admin，rdc_config，level3_name
反例：AliyunAdmin，rdcConfig，level_3_name
3、【强制】表名不适用复数名词。
说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于DO类也是单数形式，符合表达习惯。