Java编程规范（摘录自《阿里巴巴Java开发手册》）
一、命名规则
1.1 通用规则
【强制】使用完整单词组合来表达其意，杜绝完全不规范的缩写，达到代码自解释的目标。
例：AbstractClass 不要缩写命名成 AbsClass
如果模块、接口、类、方法使用了设计模式，在命名时体现，利于阅读者理解架构设计理念
例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver
1.2 包名
包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。
包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
例：应用工具类包名为com.alibaba.ai.util、类名为MessageUtils（此规则参考spring框架）
1.3 接口
通常不以I开头命名，java强调面向interface编程，很多代码都是抽象类与接口。
抽象类型接口：List，Collection
能力接口：Iterable
监听接口：OnClickListener，OnScaleGestureListener
回调接口：ResultPointCallback
服务：UserService，UserServiceImpl实现UserService接口
【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁
性，并加上有效的 Javadoc 注释。
1.4 类
【强制】类名使用UpperCamelCase风格，但DO / BO / DTO / VO / AO / PO等例外。
【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类名开始，以Test结尾。
领域模型命名规约：
1） 数据对象：XxxDO，Xxx即为数据表名；
2） 数据传输对象：XxxDTO，Xxx为业务领域相关的名称；
3） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。
1.5 方法、参数、成员变量、局部变量
方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。
【强制】POJO类中布尔类型的变量，都不要加is前缀，避免框架解析引起序列化错误。
Service/DAO层方法命名规约
1） 获取单个对象的方法用get作前缀。
2） 获取多个对象的方法用list作前缀。
3） 获取统计值的方法用count作前缀。
4） 插入的方法用insert/save作前缀。
5） 删除的方法用remove/delete作前缀。
6） 修改的方法用update作前缀。
1.6 常量
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT
【强制】不允许任何魔法值（即未经定义的常量）直接出现在代码中。
反例：String key = "Id#taobao_" + tradeId
【强制】long 或者 Long 初始赋值，使用大写 L而不是小写 l，以免与数字 1 混淆。
【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。
【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1） 类内共享常量：直接在类内部 private static final 定义。
2） 包内共享常量：即在当前包下单独的 constant 目录下。
3） 子工程内部共享常量：即在当前子工程的 constant 目录下。
4） 应用内共享常量：放置在一方库中，通常是 modules 中的 constant 目录下。
5） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。
正例：public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}
二、代码格式
2.1 集成开发工具设置格式
IDEA应导入统一的settings.jar文件来规范格式。
【强制】IDE 的 text file encoding 设置为 UTF-8;
【强制】IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；
而在 eclipse 中，必须勾选 insert spaces for tabs
【强制】IDE 中文件的换行符使用 Unix 格式（\n），不要使用 Windows 格式（\r\n）
【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行。
如果是非空代码块则：
1）左大括号前不换行，左大括号后换行。
2）右大括号前换行，右大括号后还有 else 等代码则不换行；
2.2 编写代码遵循格式
1. 【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
2. 【强制】采用4个空格缩进，禁止使用tab字符。
3. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
4. 【强制】单行字符数限制不超过 120 个，超出需要换行
第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进；
运算符与下文一起换行；
方法调用的点符号与下文一起换行；
方法调用时，有多个参数，需要换行时，在逗号后进行；
在括号前不要换行。
5.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
6.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。没有必要插入多个空行进行隔开。
三、OOP规约
面向对象设计规约：
3.1访问修饰符
类成员和方法访问控制从严：
1） 不允许外部直接通过 new 来创建对象，那么构造方法必须是 private；
2） 工具类不允许有 public 或 default 构造方法；
3） 类非 static 成员变量并且仅在本类使用，必须是 private；
4） 类非 static 成员变量并且与子类共享，必须是 protected；
5） 类 static 成员变量如果仅在本类使用，必须是 private；
6） 若是 static 成员变量，必须考虑是否为 final；
7） 类成员方法只供类内部调用，必须是 private；
8） 类成员方法只对继承类公开，那么限制为 protected。
3.2 final使用场景
【推荐】final可以声明类、成员变量、方法以及本地变量，下列情况使用final关键字：
1） 不允许被继承的类，如：String 类。
2） 不允许修改引用的字段对象，如：POJO 类的字段变量。
3） 不允许被重写的方法，如：POJO 类的 setter 方法。
4） 不允许运行过程中重新赋值的局部变量。
5） 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量。
3.3 强制规约
1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，直接用类名访问。
2.【强制】所有的覆写方法，必须加@Override 注解。
反例：getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
3.【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。
说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）
正例：public User getUsers(String type, Integer... ids)
4.【强制】外部正在调用或依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。
接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
5.【强制】不能使用过时的类或方法，开发者有义务知晓并使用新的方法。
例：java.net.URLDecoder 的方法 decode(String encodeStr) 已经过时，应使用decode(String source, String encode)。
6.【强制】Object的equals方法易抛空指针异常，应使用常量或确定有值的对象调用equals。
正例： "test".equals(object);
反例： object.equals("test");
说明：推荐使用java.util.Objects#equals （JDK7引入的工具类）
7.【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。
对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。
8. 关于基本数据类型与包装数据类型的使用标准如下：
1） 所有的POJO类属性必须使用包装数据类型。
2） RPC方法的返回值和参数必须使用包装数据类型。
3） 所有的局部变量【推荐】使用基本数据类型。
9.【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例：POJO类的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
10. 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
说明：注意serialVersionUID不一致会抛出序列化运行时异常。
11.【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
12. POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。
说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。
13. 使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
说明：
String str = "a,b,c,,";
String[] ary = str.split(",");
//预期大于3，结果是3
System.out.println(ary.length);
14. 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。
15. 类内方法定义顺序依次是：
公有方法或保护方法 > 私有方法 > getter/setter方法。
说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；
保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；
而私有方法外部一般不需要特别关心，是一个黑盒实现；
因为方法信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。
16. setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题的难度。
反例：
public Integer getData() {
if (true) {
return data + 100;
} else {
return data - 100;
}
}
17. 循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展。
反例：
String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}
说明：反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append操作，最后通过toString方法返回String对象，造成内存资源浪费。
18. final可提高程序响应效率，声明成final的情况：
1） 不需要重新赋值的变量，包括类属性、局部变量。
2） 对象参数前加final，表示不允许修改引用的指向。
3） 类方法确定不允许被重写。
19. 慎用Object的clone方法来拷贝对象。
说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。
20. 类成员与方法访问控制从严：
1） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2） 工具类不允许有public或default构造方法。
3） 类非static成员变量并且与子类共享，必须是protected。
4） 类非static成员变量并且仅在本类使用，必须是private。
5） 类static成员变量如果仅在本类使用，必须是private。
6） 若是static成员变量，必须考虑是否为final。
7） 类成员方法只供类内部调用，必须是private。
8） 类成员方法只对继承类公开，那么限制为protected。
说明：任何类、方法、参数、变量，严控访问范围。过宽泛的访问范围，不利于模块解耦。
思考：如果是一个private的方法，想删除就删除，可是一个public的Service方法，或者一个public的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。
3.4 推荐规约
1.【推荐】类内方法定义顺序：公有或保护方法 > 私有方法 > getter/setter方法。
说明：私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最后。
2.【推荐】当一个类有多个构造方法，或者多个同名方法，应按顺序放置在一起，便于阅读。
3.【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。
在getter/setter 方法中，尽量不要增加业务逻辑，增加排查问题的难度。
4. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展
5. 【推荐】慎用 Object 的 clone 方法来拷贝对象。默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现属性对象的拷贝。
3.5 其他
1. 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);
2.注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
3. 获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime();
说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime()。在JDK8中，针对统计时间等场景，推荐使用Instant类。
5. 对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。
四、控制语句
1. 在一个switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；
在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
如果switch里的变量类型是枚举类型，不要加default分支。如果漏掉了针对某个枚举值的分支，在没有default分支的情况下，会有编译告警。
2. 在if/else/for/while/do语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：if (condition) statements;
3.推荐尽量少用else， if-else的方式可以改写成：
if(condition){
......
return obj;
}
// 接着写else的业务逻辑代码;
说明：如果非得使用if()...else if()...else...方式表达逻辑，请勿超过3层，超过请使用状态设计模式。
正例：逻辑上超过3层的if-else代码可以使用卫语句，或者状态模式来实现。
4. 除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
说明：很多if语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
正例：
//伪代码如下
boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
......
}
反例：
if ((file.open(fileName, "w") != null) && (...) || (...)) {
...
}
5. 循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。
6. 接口入参保护，这种场景常见的是用于做批量操作的接口。
7.方法中需要进行参数校验的场景：
1） 调用频次低的方法。
2） 执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
3） 需要极高稳定性和可用性的方法。
4） 对外提供的开放接口，不管是RPC/API/HTTP接口。
5） 敏感权限入口。
8.方法中不需要参数校验的场景：
1） 极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参数检查。
2） 底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
3） 被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。