该笔记出自于<<阿里巴巴 JAVA 开发手册>>， 侵删
主要记录平时比较重要的而且又容易被忽视的规约, 方便速查
编程规约
(一) 命名风格
代码中的命名均不能以下划线或美元符号开始， 也不能以下划线或美元符号结束
代码中的命名禁止使用拼音与中文混合的方式， 应当使用正确的英文拼写，杜绝完全不规范的缩写，避免望文不知义, 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
注 : alibaba/taobao等国际通用的名称，可视同英文类名使用UpperCamelCase风格，但以下情形例外：DO/ BO / DTO/ VO/ AO/ PO/ UID等。
如UserDO方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
抽象类命名使用Abstract或Base开头
异常类命名使用Exception结尾
测试类命名以它要测试的类的名称开始，以Test结尾。
定义整形数组int[] arrayDemo
POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。（重要）
包名统一使用小写, 单数形式
类名如果有复数含义，类名可以使用复数形式
如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
如 public classOrder Factory；
public class LoginProxy；接口类的方法和属性不要添加任何的修饰符号(public 也不能添加), 以求保持代码的简洁性能，而且接口类的变量均为与接口方法相关的常量．
接口和实现类的命名有两套规则
对于Service和DAO类, 暴露出来的服务一定是接口，而其中的实现类命名以Impl为后缀
枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开
各层命名规约整合
Service/DAO层方法命名规约
获取单个对象的方法用get做前缀
获取多个对象的方法用list做前缀，复数形式结尾如：listObjects
获取统计值的方法用count做前缀
插入的方法用save/insert做前缀
删除的方法用remove/delete做前缀
修改的方法用update做前缀领域模型命名规约
数据对象：xxxDO，xxx即为数据表名
数据传输对象：xxxDTO，xxx为业务领域相关的名称
展示对象：xxxVO，xxx一般为网页名称
POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO
(二) 常量定义
不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
在long或者Long赋值时，数值后使用大写的L
如: public Long data = 2L;不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
子工程内部共享常量：即在当前子工程的constant目录下。
包内共享常量：即在当前包下单独的constant目录下。
类内共享常量：直接在类内部private static final定义。
- 如果变量值仅在一个固定范围内变化用enum类型来定义
注：注意区分常量类和枚举类的区别
(三) 代码格式
对于代码格式的规范，阿里巴巴给出了一个正例，这个例子基本囊括了所以基本的规范操作
public class Main {
public static void main(String[] args) {
// 注释的双斜线与注释内容之间有且仅有一个空格。
// 缩进四格
String say = "hello";
// 运算符左右必须有一个空格
int flag = 0;
// if语句与括号之间必须有一个空格, 左大括号前加空格不换行， 左大括号后换行
if (flag == 0) {
System.out.println(say);
//右大括号前换行，右大括号有else， 不用换行
} else {
System.out.println("ok");
//右大括号结束必须换行
}
}
}
补充
- 单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则
第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进
运算符与下文一起换行
方法调用的点符号与下文一起换行
方法调用中的多个参数需要换行时，在逗号后进行
在括号前不要换行
- 方法参数在定义和传入时，多个参数逗号后边必须加空格，如method(args1, args2, args3);
- IDE的textfileencoding设置为UTF-8;IDE中文件的换行符使用Unix格式，不要使用Windows格式。
- 单个方法的总行数不超过80行
- 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。
(四) OOP(面向对象程序设计)规约
- 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
- 所有的覆写方法，必须加@Override注解。
- 相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object
- 不能使用过时的类或方法, 接口过时必须加@Deprecated注解，作为调用方来说，有义务去考证过时方法的新实现是什么
- Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals，如"test".equals(object)
此处，阿里巴巴推荐使用java.util.Objects#equals（JDK7引入的工具类） - 所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
- 所有的POJO类属性必须使用包装数据类型
- 定义DO/DTO/VO等POJO类时，不要设定任何属性默认值
- POJO类必须写toString方法
- 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
- 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
- 禁止在POJO类中，同时存在对应属性xxx的isXxx()和getXxx()方法
- 使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
- 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于第16条规则
- 类内方法定义的顺序依次是：公有方法或保护方法> 私有方法> getter/setter方法
说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有Service和DAO的getter/setter方法放在类体最后 - setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。
- 循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展，避免资源浪费
- final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字
不允许被继承的类，如：String类。
不允许修改引用的域对象。
不允许被重写的方法，如：POJO类的setter方法。
不允许运行过程中重新赋值的局部变量。
避免上下文重复使用一个变量，使用final描述可以强制重新定义一个变量，方便更好地进行重构。
- 慎用Object的clone方法来拷贝对象，因为clone方法默认的是浅拷贝
- 类成员与方法访问控制从严
如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
工具类不允许有public或default构造方法
类非static成员变量并且与子类共享，必须是protected
类非static成员变量并且仅在本类使用，必须是private
类static成员变量如果仅在本类使用，必须是private
若是static成员变量，考虑是否为final
类成员方法只供类内部调用，必须是private
类成员方法只对继承类公开，那么限制为protected
注:任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。
