java编码规范

转自：http://www.jianshu.com//p/7e07e2d47bac

有精力的同学可以到 https://github.com/alibaba 寻找阿里巴巴的编程规范

给自己做一个备份

前言

阿里Java开发手册谈不上圣经，但确实是大量程序员踩坑踩出来的一部非常有价值的宝典。其从代码规范性、性能、健壮性、安全性等方面出发，对程序员提出了一系列简单直观的要求，对于人员流动性强，程序员技术水平参差不齐的团队来说，尤其具备价值。

阿里Java开发手册中，有一部分规约是针对阿里自己的工程环境特点设置的，其他团队可以用于借鉴，无需照搬，而大部分的规约，都是具备推广价值的。

然而这本手册中的规约众多，部分搭配了简短的说明，相当一部分规约则对原理说明的不够详细。本着“知道为什么要这样做”强于“知道应该这样做”的思想，本文在列出阿里Java开发手册的同时，对其中部分语焉不详的规约进行了比较详细的说明，并尽可能搭配代码样例。

本文中，在阿里Java开发手册基础上增加的说明内容全部以引用的形式出现，即

引用部分的文字是本文作者对阿里Java规约的附加说明

一、编程规约

(一) 命名规约

本节中的规约非常简单直白，故基本不做特殊说明

【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例： _name / __name / $Object / name_ / name$ / Object$
【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;
正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。
【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO等。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例： MAX_STOCK_COUNT 反例： MAX_COUNT
【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
【强制】中括号是数组类型的一部分，数组定义如下：String[] args;
反例：请勿使用String args[]的方式来定义
【强制】POJO类中的任何布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。
【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为com.alibaba.mpp.util、类名为MessageUtils（此规则参考spring的框架结构）
【强制】杜绝完全不规范的缩写，避免望文不知义。
反例：<某业务代码>AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;
【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名：void f(); 接口基础常量表示：String COMPANY = "alibaba";
反例：接口方法定义：public abstract void f();
说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。

最后这一句实际上隐含了另一条规约，即如果要对接口定义default方法（JDK8的新特性），那么要确保这个default方法是对该接口的所有实现类都有价值的。
如果某公共方法只针对该接口的一部分实现类有价值，那么应该定义一个抽象类实现该接口，在抽象类中定义该公共方法，需要用到该公共方法的实现类继承此抽象类并实现此接口。
接口和实现类的命名有两套规则：
1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：CacheServiceImpl实现CacheService接口。
2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。
正例：AbstractTranslator实现 Translatable。
【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。
【参考】各层命名规约：
A) Service/DAO层方法命名规约
1）获取单个对象的方法用get做前缀。
2）获取多个对象的方法用list做前缀。
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。

(二) 常量定义

【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。
反例：
```
String key = "Id#taobao_" + tradeId;
cache.put(key, value);
```
“魔法值”的意思是指“未经定义直接出现在代码中的常量值”。上例中的"Id#taobao"就是魔法值。所以这条规约用大家听得懂的大白话翻译过来就是：“不允许在代码中直接使用未经定义的常量字面量，所有在代码中使用的常量必须预先经过定义”，如：
```
public static final String CACHE_PREFIX = "Id#taobao_";
String key = CACHE_PREFIX + tradeId;
cache.put(key, value);
```
吐槽：阿里自己的规范里白纸黑字写着“任何运算符左右必须加一个空格”，结果上面这段代码样例里的+运算符左右都没有加空格。是强迫症发作的作者给补上的……
【强制】long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
说明：Long a = 2l; 写的是数字的21，还是Long型的2?
【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。
说明：大而全的常量类，非得ctrl+f才定位到修改的常量，不利于理解，也不利于维护。
【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1）跨应用共享常量：放置在二方库中，通常是client.jar中的const目录下。
2）应用内共享常量：放置在一方库的modules中的const目录下。
反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：
类A中：public static final String YES = "yes";
类B中：public static final String YES = "y";
A.YES.equals(B.YES)，预期是true，但实际返回为false，导致产生线上问题。
3）子工程内部共享常量：即在当前子工程的const目录下。
4）包内共享常量：即在当前包下单独的const目录下。
5）类内共享常量：直接在类内部private static final定义。

此规约中提到的“一方库”、“二方库”可能会引发一些疑惑。一方库是指同一工程内的模块打包成的库；二方库是指公司内的公共库；三方库就不用说了吧

【推荐】如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。
正例：

public Enum {MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

吐槽：谜之代码，神奇的意会式写法，这给的代码样例真的就是“懂的人不看就懂，不懂的人越看越糊涂”，请还糊涂着的读者看下面的代码样例吧：

public enum WeekDay {
   MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);

   private WeekDay(int dayNum) {
       this.dayNum = dayNum;
   }
   private int dayNum;
   public int getDayNum() {
       return this.dayNum;
   }

   public static void main(String[] args) {
       WeekDay weekDay = FRIDAY;
       System.out.println(weekDay.toString() + weekDay.getDayNum());
   }
}

(三) 格式规约

关于Java代码的格式，其实并没有严格的对错之分，if的大括号结束后else是在同行还是换行就能吵上一阵，这一章节完全是出于代码的整洁性考虑，所以参考即可

【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
1）左大括号前不换行。
2）左大括号后换行。
3）右大括号前换行。
4）右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。
【强制】左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。
【强制】if/for/while/switch/do等保留字与左右括号之间都必须加空格。
【强制】任何运算符左右必须加一个空格。
说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

【强制】代码块缩进4个空格，如果使用tab缩进，请设置成1个tab为4个空格。
正例：（涉及1-5点）

 public static void main(String args[]) {
     // 缩进4个空格
     String say = "hello";
     // 运算符的左右必须有一个空格
     int flag = 0;
     // 关键词if与括号之间必须有一个空格，括号内f与左括号，1与右括号不需要空格
     if (flag == 0) {
         System.out.println(say);
     }

     // 左大括号前加空格且不换行；左大括号后换行
     if (flag == 1) {
         System.out.println("world");
     // 右大括号前换行，右大括号后有else，不用换行
     } else {
         System.out.println("ok");
     // 右大括号做为结束，必须换行
     }
 }

【强制】单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：
1）换行时相对上一行缩进4个空格。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）在多个参数超长，逗号后进行换行。
5）在括号前不要换行，见反例。
正例：

 StringBuffer sb = new StringBuffer();
 //超过120个字符的情况下，换行缩进4个空格，并且方法前的点符号一起换行
 sb.append("zi").append("xin")...
     .append("huang");

反例：

 StringBuffer sb = new StringBuffer();
 //超过120个字符的情况下，不要在括号前换行
 sb.append("zi").append("xin")...append
     ("huang");
 //参数很多的方法调用也超过120个字符，逗号后才是换行处
 method(args1, args2, args3, ...
     , argsX);

【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");
【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。
正例：
```
 int a = 3;
 long b = 4L;
 float c = 5F;
 StringBuffer sb = new StringBuffer();
```
说明：增加sb这个变量，如果需要对齐，则给a、b、c都要增加几个空格，在变量比较多的情况下，是一种累赘的事情。
【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

这一规约中的两项要求都是为了在各种平台上提供统一的代码阅读体验
【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
说明：没有必要插入多行空格进行隔开。

(四) OOP规约

此章节的分类其实比较奇怪，其中有一些规约其实和OOP没啥关系，大家就逐条分开看吧

【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
也就是说，应该：
```
StringUtils.isEmpty(str);
```
而不要：
```
StringUtils stringUtils = new StringUtils();
stringUtils.isEmpty(str);
```
直观的好处是少一些代码，少创建一些对象。
原文中所说的“增加编译器解析成本”我不太理解，不知是指节省了把java代码编译成字节码时的成本，还是把字节码JIT编译成机器码时的成本。
【强制】所有的覆写方法，必须加@Override注解。
反例：getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
@Override注解本身其实不起任何作用，但使用它可以做到两件很有用的事：
1. 告诉代码的阅读者，这个方法是在覆盖父类的方法
2. 编写程序时，如果方法名、参数列表、异常等定义错误导致不能正确覆盖父类方法时，编译器会提示错误
【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。
说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）
正例：
```
 public User getUsers(String type, Integer... ids);
```
可变参数是J2SE 1.5的新特性，用起来很方便，但在工程中使用不当会严重影响代码的可读性和可维护性。所以对于庞大的、不好管控的开发团队来说，直接限制使用或许也是一种方法
【强制】对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

避免修改方法签名是因为你不清楚都有谁在什么场景下调用此方法，如果贸然修改方法签名，可能会引发问题
【强制】不能使用过时的类或方法。
说明：java.net.URLDecoder 中的方法decode(String encodeStr) 这个方法已经过时，应该使用双参数decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。
【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
正例： "test".equals(object);
反例： object.equals("test");
说明：推荐使用java.util.Objects#equals （JDK7引入的工具类）
通过常量来调用equals方法这一条大家应该都清楚。然而如果要比较的两个都是对象的话，似乎把哪一个放在前面都可能发生空指针，对此，使用J2SE 1.7中引入的Objects类是最佳的：
```
if(Objects.equals(a, b)) {
    //...
}
```
这样的话，无论如何都不会产生空指针异常，需要注意的是，如果比较的两个对象都为null的话，Objects.equals方法会返回true
【强制】所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
说明：对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。
包装类是指Byte/Boolean/Short/Integer/Long/Float/Double/Character等对Java基本类型进行封装的类。在使用包装类时，很容易把使用基本类型时的习惯带入，引用原文的说法，这是一个大坑。看下面的例子：
```
int a = 1000;
int b = 1000;
if(a == b) //true

Integer b1 = 1000;
if(a == b1) //true

Integer a1 = 1000;
if(a1 == b1) //false

Integer a2 = 10;
Integer b2 = 10;
if(a2 == b2) //true
```
对于不了解包装类机制的程序员来说，上面这段代码会造成不小的困惑。简单解释一下：
当包装类对象和基本类型变量进行==判断时，Java会把包装类对象转换成基本类型变量后进行比较，这和两个基本类型变量进行==操作是等价的
当两个包装类对象进行==判断时，Java比较的是两个对象的内存地址是否一致，即判断这两个变量引用的对象是否是同一个，所以上例中的a1 == b1结果是false
那么为什么a2 == b2结果是true呢？因为包装类Integer维护了一个对象缓冲池，池中有256个Integer对象，体现的是-128~127之间的数值。所以说a2和b2实际上都指向了缓冲池中的同一个对象，a2 == b2自然就是true了
包装类Byte/Short/Integer/Long/Character中都有这样的缓冲池机制，所以当我们对这些包装类进行比较时，使用equals方法是最稳妥的
【强制】关于基本数据类型与包装数据类型的使用标准如下：
1）所有的POJO类属性必须使用包装数据类型。
2） RPC方法的返回值和参数必须使用包装数据类型。
3）所有的局部变量推荐使用基本数据类型。
说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。
正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。
反例：某业务的交易报表上显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

一句话提示：基本数据类型变量是不能赋值为null的，但包装类对象可以
【强制】定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。
反例：某业务的DO的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
【强制】序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
说明：注意serialVersionUID不一致会抛出序列化运行时异常。

在进行反序列化时，JVM会判断待反序列化的字节流中的serialVersionUID和对应类的serialVersionUID是否一致，如果不一致，会产生InvalidCastException。
【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

在你向构造方法里加入业务逻辑时，你是不可能确保这段业务逻辑能够覆盖今后所有的需求的，万一哪一天出现“某场景下实例化此类时不可以执行这段业务逻辑”的情况，那就悲催了，只能重载一个构造方法。
【强制】POJO类必须写toString方法。使用工具类source > generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。
说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。
【推荐】使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
说明：
```
String str = "a,b,c,,";
String[] ary = str.split(","); //预期大于3，结果是3
System.out.println(ary.length);
```
String类的split(String regex)方法会丢弃最后一个分隔符后的空串
【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。
【推荐】类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。
说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为方法信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。
【推荐】setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题难度。
反例：
```
public Integer getData() {
    if(true) {
        return data + 100;
    } else {
        return data - 100;
    }
}
```
【推荐】循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展。
反例：
```
String str = "start";
for(int i = 0; i < 100; i++) {
    str = str + "hello";
}
```
说明：反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append操作，最后通过toString方法返回String对象，造成内存资源浪费。
使用"+"拼接字符串的代码，在编译成字节码时会被编译器自动转换为使用StringBuilder的append方法拼接，所以说单行代码中使用"+"拼接字符串是没有问题的，但如果这样的拼接频繁出现（不仅限于循环中），那么每次拼接时都会new一个新的StringBuffer对象，对性能产生很大影响。
所以，上面那段代码应该写成：
```
StringBuilder sb = new StringBuilder("start");
for(int i = 0; i < 100; i++) {
    sb.append("hello");
}
```
吐槽：代码样例里操作符两边又不加空格，写这个规范的大哥，真的没问题吗……
【推荐】下列情况，声明成final会更有提示性：
1）不需要重新赋值的变量，包括类属性、局部变量。
2）对象参数前加final，表示不允许修改引用的指向。
3）类方法确定不允许被重写。
这一条规约多废话几句，在前一版本的阿里Java开发手册中，这一条规约是：“【推荐】final可提高程序响应效率，声明成final的情况：”
这一说法是有问题的，在被吐槽之后，阿里也更新了此条规约。这里来解释一下为什么前一版里的说法有问题：

final修饰变量时对于性能是没有任何影响的。final修饰编译时常量时，会带来些许的性能提升。如：
```
static int foo() {
    int a = 2; // 声明常量a
    int b = 3; // 声明常量b
    return a + b; // 常量表达式
}
```
编译成字节码后是：
```
iconst_2
istore_0 // 设置a的值
iconst_3
istore_1 // 设置b的值
iload_0  // 读取a的值
iload_1  // 读取b的值
iadd
ireturn
```
而如果改成：
```
static int foo() {
  final int a = 2; // 声明常量a
  final int b = 3; // 声明常量b
  return a + b;    // 常量表达式
}
```
编译成字节码后则是：
```
iconst_5 // 常量折叠了，没有“访问局部变量”
ireturn
```
而final修饰的方法，则会在编译期省略掉方法调用，直接把被调用的方法内容编译过去，例如：
```
public void foo() {
    for(int i = 0; i < 1000; i++) {
        bar();
    }
}
private void bar() {
    System.out.println("bar");
}
```
在编译后等价于
```
public void foo() {
    for(int i = 0; i < 1000; i++) {
        System.out.println("bar");
    }
}
```
然而，无论是哪种情况下final带来的性能提升都是很小的，而且如果使用的是比较新的JVM，在经过JIT编译后的机器码也会屏蔽掉加不加final的性能区别。所以说final的主要价值还是在于其语义本身提供的不可变性检查特性，从提升性能的角度来制定final规约显得有点怪了。
【推荐】慎用Object的clone方法来拷贝对象。
说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。

浅拷贝，即仅拷贝对象中基本数据类型的成员属性，如果成员属性引用了其他对象，则拷贝出的对象副本中的这些成员属性引用的还是同一个对象。
深拷贝则是被拷贝对象的成员属性引用的其他对象也是拷贝出的副本
【推荐】类成员与方法访问控制从严：
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的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。

(五) 集合处理

【强制】Map/Set的key为自定义对象时，必须重写hashCode和equals。
正例：String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为key来使用。

除了IdentityHashMap之外，其余的Map和Set在判断key是否已存在时，使用的是作为key的对象的hashCode和equals方法。
HashMap的get(Object)方法源码节选：
 //如果入参key的hash和遍历到的k的hash一致，且key.equals(k)，则匹配成功
 if (e.hash == hash &&
     ((k = e.key) == key || (key != null && key.equals(k))))
     return e;
如果作为key的类没有重写hashCode和equals方法，则此处使用的就是Object类的hashCode和equals方法：
 public native int hashCode();
 public boolean equals(Object obj) {
     return (this == obj);
 }
Object类的hashCode是个native方法，不同的对象的hashCode一定不同，而Object类的equals方法则等同于==运算符，只要两个对象内存地址不同，就一定会返回false
所以，如果我们用作key的类没有重写hashCode和equals方法，那么两个属性完全一样的对象，会被Map/Set认为是不同的两个key。见下面的代码样例：
 public class Test {
     //没有重写hashCode和equals的Foo类
     public static class Foo {
         public Foo(int a) {
             this.a = a;
         }
         public int a;
     }

     public static void main(String[] args) {
         //两个一样的Foo对象f1和f2
         Foo f1 = new Foo(1);
         Foo f2 = new Foo(1);

         Map<Foo, String> map = new HashMap<Foo, String>();
         map.put(f1, "f1");
         map.put(f2, "f2");

         System.out.println(map.size()); //map的size为2，与预期不一致
         String s = map.get(new Foo(1)); //尝试通过key获取value
         System.out.println(s); //返回null，与预期不一致
     }
 }
而使用重写了hashCode和equals方法的String类作为key时，Map的运作就正常了：
  public static void main(String[] args) {
     String s1 = new String("abc");
     String s2 = new String("abc");
     System.out.println(s1 == s2); //false，s1和s2是两个不同的对象

     Map<String, String> map = new HashMap<String, String>();
     map.put(s1, "s1");
     map.put(s2, "s2");

     System.out.println(map.size()); //map的size为1
     String s = map.get(new String("abc"));
     System.out.println(s); //返回"s2"，与预期一致
 }
在重写hashCode与equals方法时，应确保：

如果k1和k2体现的数据是一样的，那么k1.equals(k2)

如果k1.equals(k2)，那么k2.equals(k1)

如果k1.equals(k2)，那么k1.hashCode() == k2.hashCode()

【强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常：java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ;
说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
【强制】在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException 异常。

ConcurrentModificationException（后文简称CME）是一个经常让初级Java程序员产生困惑的异常。
简单来说，Java的很多集合类都不是线程安全的（如ArrayList/LinkedList/HashMap等等），这些非线程安全的集合类如果存在并发访问，则会引发一系列的问题（如数据异常甚至死循环）。然而Java无法在编译期识别出对非线程安全集合的并发访问行为，所以只能在运行期加上CME这样一个保险措施。
CME会在使用iterator遍历集合类时产生，非线程安全的集合类的iterator会在遍历时随时检查集合对象是否在遍历开始后发生过变更，如果检测到变更，则会立刻抛出CME终止遍历。这样做是因为此时的集合对象很可能已经存在并发访问造成的数据混乱，再继续遍历下去可能会出现严重问题。遵循这种模式的iterator被称为fail-fast iterator。
在单线程环境下也有可能产生CME，如在遍历集合时在循环体内对集合进行增删操作。这是CME的一个副作用，规避方法在后面的第7条规约中有描述。
Hashtable和Vector是特例，这两个古早的集合类虽然是synchronized的，但仍然使用了fail-fast iterator，在遍历时发生并发访问一样会产生CME，除非在遍历时对对象加锁。
【强制】使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。
反例：直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将出现ClassCastException错误。
正例：
```
 List<String> list = new ArrayList<String>(2);
 list.add("guan");
 list.add("bao");
 String[] array = new String[list.size()];
 array = list.toArray(array);
```
说明：使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为[ list.size() ]的数组元素将被置为null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
【强制】使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。
说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。
```
String[] str = new String[] { "a", "b" };
List list = Arrays.asList(str);
```
第一种情况：list.add("c"); 运行时异常。
第二种情况：str[0]= "gujin"; 那么list.get(0)也会随之修改。
【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法。
说明：苹果装箱后返回一个<? extends Fruits>对象，此对象就不能往里加任何水果，包括苹果。

使用泛型通配符声明的集合对象是不能以任何方式装入对象的，不仅限于add方法。因为在编译期无法确定该集合对象内存储的对象类型。这一规约受编译器检查，所以也不用特别专门去注意。
【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。
反例：
```
 List<String> a = new ArrayList<String>();
 a.add("1");
 a.add("2");
 for (String temp : a) {
     if("1".equals(temp)) {
         a.remove(temp);
     }
 }
```
说明：这个例子的执行结果会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？
正例：
```
 Iterator<String> it = a.iterator();
 while(it.hasNext()) {
     String temp = it.next();
     if(删除元素的条件){
         it.remove();
     }
 }
```
这条规约给出的反例很“***钻”，又没有给出解释说明，非常容易引发困惑。
首先要明确的是，反例中的代码写法是错误的，其运行结果符合预期的原因仅仅是巧合。无论任何情况下，都不应该在使用增强for循环或iterator遍历集合时，使用集合类的remove()方法删除元素。
如笔者在第3条中所述，如果集合类使用了fail-fast的iterator，那么在iterator遍历时会检查集合对象是否在遍历开始后发生过变更，如果发生过变更，便会抛出CME异常。

使用fail-fast iterator的集合类都内置了一个计数器modCount，用来记录该集合对象发生过变更的次数，每次对集合对象执行写操作（增删改）时，modCount都会自增1。
iterator实例化时，会记录下当时集合对象的modCount：
```
int expectedModCount = modCount;
```
接下来在每一次调用next()方法时都要比较modCount和expectedModCount，如果不相等，则抛出CME异常：
```
 if (modCount != expectedModCount)
     throw new ConcurrentModificationException();
```
正确的做法是使用iterator自身提供的remove()方法来移除元素，就如上文正例中的代码。这是因为iterator自身的remove()方法会同时也修改expectedModCount。

那么，为什么反例中给出的代码不会抛出CME？为什么把"1"换成"2"之后又会抛出CME了？
是因为增强for循环中，iterator在调用next()方法前会先调用hasNext()方法，只有hasNext()返回true时才会继续调用next()。
```
 public boolean hasNext() {
     //如果当前遍历的index不等于集合size，则返回true
     return cursor != size;
 }
```
在本条规约给出的反例中，list的初始size是2，第1次循环中cursor为0，删除了"1"后，size变成了1，此时进入第2次循环，cursor为1，size也为1，于是hasNext()返回了false，循环压根就没有遍历到第2个元素就提前结束了。所以说，这是一个巧合，只会在集合内有2个元素，且第1次遍历时便删除了1个元素的情况下发生。
【强制】在JDK7版本以上，Comparator要满足自反性，传递性，对称性，不然Arrays.sort，Collections.sort会报IllegalArgumentException异常。
说明：
1）自反性：x，y的比较结果和y，x的比较结果相反。
2）传递性：x > y, y > z, 则x > z。
3）对称性：x == y,则x, z比较结果和y, z比较结果相同。
反例：下例中没有处理相等的情况，实际使用中可能会出现异常：
```
 new Comparator<Student>() {
     @Override
     public int compare(Student o1, Student o2) {
         return o1.getId() > o2.getId() ? 1 : -1;
     }
 }
```
JDK6及以下的版本，Arrays.sort和Collections.sort使用的是归并排序算法，而从JDK7开始就改为使用TimSort算法了，TimSort是归并排序的优化版，其对Comparator的自反性和传递性要求更加严格
【推荐】集合初始化时，尽量指定集合初始值大小。
说明：ArrayList尽量使用ArrayList(int initialCapacity) 初始化。

大部分集合类都有一个默认的初始大小（链表型的除外）。以ArrayList为例，默认初始大小是10，当向其中插入第11个元素时，ArrayList会自动扩容，扩到当前size的1.5倍。扩容动作会消耗一定的性能和内存空间（例如ArrayList在扩容时要拷贝数组，HashMap在扩容时要重排所有Entry的位置），所以应尽可能减少不必要的扩容操作。
假设我们要向一个ArrayList中存储100条数据，如果使用new ArrayList()实例化，那么存储的过程中ArrayList需要扩容6次。如果new ArrayList(100)，那么就一次扩容都不需要了。
如果我们在实例化集合时就能够估计出所需的空间，那么应在实例化时指定一个合适的大小，避免频繁扩容。
【推荐】使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。
说明：keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。
正例：values()返回的是V值集合，是一个list集合对象；keySet()返回的是K值集合，是一个Set集合对象；entrySet()返回的是K-V值组合集合。
【推荐】高度注意Map类集合K/V能不能存储null值的情况，如下表格：

图片.png

反例：很多同学认为ConcurrentHashMap是可以置入null值，而事实上，存储null值时会抛出NPE异常。
【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet是order/sort。

要熟知每种集合类的特性，请参考我的文章：JAVA集合框架中的常用集合及其特点、适用场景、实现原理简介
【参考】利用Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains方法进行遍历、对比、去重操作。

(六) 并发处理

【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明：资源驱动类、工具类、单例工厂类都需要注意。

可能因为偷懒没有给出正、反例，补充一下。
一个完全没有考虑线程安全的单例类：
 public class Singleton {
     private static Singleton instance = null;
     public static Singleton getInstance() {
         if(instance == null) {
             instance = new Singleton();
         }
         return instance;
     }
 }
多线程环境下，这个单例就一点也不单了

推荐的单例实现方式有两种：静态内部类和枚举，这两种写法都能够保证线程安全和懒加载，且性能够好。具体写法网上都能找到，这里给出比较容易理解的一种，静态内部类：
 public class Singleton {
     private Singleton() {}
     private static class SingletonInstance {
         private static final Singleton INSTANCE = new Singleton();
     }
     public static Singleton getInstance() {
         return SingletonInstance.INSTANCE;
     }
 }

【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
正例：

 public class TimerTaskThread extends Thread {
     public TimerTaskThread() {
         super.setName("TimerTaskThread"); ...
     }
 }

【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

手工创建线程时需要做严格检查才能保证不超量创建线程，生手或稍有不慎就容易出篓子，所以用线程池还是最保险的
【强制】线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写同学更加明确线程池运行规则，避资源耗尽风险。
说明： Executors返回的线程池对象的弊端如下：
1）FixedThreadPool 和 SingleThreadPoolPool:
　允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致OOM。
2）CachedThreadPool 和 ScheduledThreadPool:
　允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致OOM。

和上一条规约类似，Executors创建的线程池用不好容易出事，还是保险一点好
【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为static，必须加锁，或者使用DateUtils工具类。
正例：注意线程安全，使用DateUtils。亦推荐如下处理：
```
 private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
     @Override
     protected DateFormat initialValue() {
         return new SimpleDateFormat("yyyy-MM-dd");
     }
 };
```
说明：如果是JDK8的应用，可以使用Instant代替Date，LocalDateTime代替Calendar，DateTimeFormatter代替Simpledateformatter，官方给出的解释：simple beautiful strong immutable thread-safe。

SimpleDateFormat不是线程安全的，所以只能作为局部变量使用，但这样做会频繁实例化SimpleDateFormat对象，产生不少不必要的垃圾对象。
规约中给出的使用ThreadLocal的方法是一个好办法，让每个线程有一个自己专属的SimpleDateFormat对象，这样能够避免多线程访问同一个对象，同时也避免了频繁创建对象。当然，使用commons-lang3的DateUtils类更方便。
这里还要推荐一下joda-time库，可以用来替代Date/Calendar/SimpleDateFormat等，非常好用。https://github.com/JodaOrg/joda-time
【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

synchronized方法：该方法执行期间在对象上加锁。但很多情况下一个方法体内不是所有的代码都需要加锁，如果改为锁代码块，就能大幅提升并发性能。简单地说，synchronized范围越小，性能提升越大。
此外，ReentrantLock的表现也要优于synchronized，重入锁可以更加灵活的控制锁的获取和释放，同时也能用来实现读写锁（允许多个线程同时读，但只要有一个线程在写，那么所有其他线程的读写请求都会被阻塞）
【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。说明：线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。
【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。
说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。

比较微妙的一条规约，说得模模糊糊。毕竟这种场景不会交给初级程序员处理，所以看不懂也没关系。但话说回来，够格的程序员也用不着看这条规约吧-_-

唉，还是简单细化一下吧：
A请求要把数据库中一条记录的一个字段从10更新到11，B请求要把同一条记录同一个字段从10更新到12，A请求先到，B请求后到，预期的结果应该是12，但有可能会是B先完成更新，这样最终的结果是11，就发生了规约中所说的“更新丢失”。
在应用层加锁：语焉不详，分布式应用要怎么实现悲观锁？用zookeeper实现乐观锁？
在缓存加锁：语焉不详+1，缓存也没法实现悲观锁吧？用Redis的WATCH命令实现乐观锁？
在数据库层使用乐观锁，使用version作为更新依据：终于有一个说明白的了，把{当前version}作为更新的条件之一
UPDATE xxx = yyy, version = version + 1 WHERE id = ? and version = {当前version}
如果version被并发的另一个请求修改了，UPDATE会返回0，说明发生了兵法冲突，这个时候重查一次version，再重试。

乐观锁的意思是在更新前假定不会发生并发冲突，在更新动作完成后检查是否发生了并发冲突，如果是，则再重试若干次。
而悲观锁则是在更新前假定一定会发生并发冲突，所以要先把目标锁住（比如用MySQL的排它锁），再更新，更新后解锁。
【强制】多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。

用Quartz或者Spring scheduler也是OK的
【推荐】使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法可以执行，避免主线程无法执行至await方法，直到超时才返回结果。
说明：注意，子线程抛出异常堆栈，不能在主线程try-catch到。

CountDownLatch用在主线程需要等待所有子线程都执行完之后再执行一段逻辑的场景。例如主线程启动10个线程执行任务，待所有子线程的任务都执行完成后，主线程再输出最终结果。
这一规约的意思是要确保所有子线程在任何场景下都要调用countDown方法通知CountDownLatch自己已经执行完成，否则的话主线程可能会永远await下去。
所以说子线程最好在finally块中调用countDown。
【推荐】避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed导致的性能下降。
说明：Random实例包括java.util.Random 的实例或者 Math.random()的方式。
正例：在JDK7之后，可以直接使用API ThreadLocalRandom，而在 JDK7之前，需要编码保证每个线程持有一个实例。

和本章第5条规约其实是一个意思
【推荐】在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐问题解决方案中较为简单一种（适用于JDK5及以上版本），将目标属性声明为volatile型。
反例：
```
class Foo {
    private Helper helper = null;
    public Helper getHelper() {
        if (helper == null) synchronized(this) {
            if (helper == null)
                helper = new Helper();
        }
        return helper;
    }
    // other functions and members...
}
```
双重检查锁从理论上来说是OK的，但实际上会有低几率出现问题，具体的原因比较复杂，不在这里赘述，可以参考规约中提到的文章。
解决方案是把Helper对象声明为volatile的。如果是用双重检查锁来实现延迟初始化的单例模式的话，也可以改用本章第1条规约中笔者给出的静态内部类写法。
【参考】volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。如果是count++操作，使用如下类实现：AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。
volatile的语义是“易变”，用来解决可见性问题，即线程每次读取volatile变量时，都会从主存中读取，而不使用寄存器中的缓存。除此之外，volatile什么都不保证。
对volatile变量执行++操作时，会以如下几步进行
- 将主存中的值读入寄存器
- 将寄存器中的值+1
- 将寄存器中的值写回主存
所以在并发进行++操作时，是不能保证原子性的！两个线程可能从主存中读到同一个值，加1后又同时写回主存，最后主存中的值只增加了1.
【参考】 HashMap在容量不够进行resize时由于高并发可能出现死链，导致CPU飙升，在开发过程中注意规避此风险。

千万不要并发访问HashMap，死循环可不好玩，请用ConcurrentHashMap
并发访问HashMap引发死循环的原因，请见http://blog.csdn.net/xiaohui127/article/details/11928865
【参考】ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

ThreadLocal是用于在一个线程中共享对象的，不是用于多线程间共享对象的，明白这一点就够了

(七) 控制语句

【强制】在一个switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。

不加break的话，匹配到的case后的所有case都会被执行
【强制】在if/else/for/while/do语句中必须使用大括号。即使只有一行代码，避免使用单行的形式：if (condition) statements;

主要是为了避免以后把单行改成多行时忘了加大括号
【推荐】表达异常的分支时，少用if-else方式，这种方式可以改写成：
```
 if (condition) {
     ...
     return obj;
 }
 // 接着写else的业务逻辑代码;
```
说明：如果非得使用if()...else if()...else...方式表达逻辑，【强制】请勿超过3层，超过请使用状态设计模式。
正例：逻辑上超过3层的if-else代码可以使用卫语句，或者状态模式来实现。

估计很多人都迷惑卫语句是什么，实际上代码样例中给出的就是卫语句，也就是把if...else...结构拆成多个if来表现。
这样做的主要目的是避免复杂的if...else...条件嵌套让代码读起来太费力，使用状态模式也是为了达成同样的目的。
【推荐】除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
说明：很多if语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
正例：
```
 //伪代码如下
 boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
 if (existed) {
     ...
 }
```
反例：
```
 if ((file.open(fileName, "w") != null) && (...) || (...)) {
     ...
 }
```
【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。
【推荐】接口入参保护，这种场景常见的是用于做批量操作的接口。

有点晕，接口入参保护是啥？是指对接口的入参进行校验吧？特别是批量操作接口，如果不校验好入参的话，可能会出现部分失败？浪费性能还得回滚？是这个意思吗？说详细点能死吗？
【参考】下列情形，需要进行参数校验：
1）调用频次低的方法。
2）执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
3）需要极高稳定性和可用性的方法。
4）对外提供的开放接口，不管是RPC/API/HTTP接口。
5）敏感权限入口。
【参考】下列情形，不需要进行参数校验：
1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

7, 8两点总结的很好，非常好

(八) 注释规约

这一章不用过多解释了

【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不得使用//xxx方式。
说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
【强制】所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
【强制】所有的类都必须添加创建者和创建日期。
【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
【参考】合理处理注释掉的代码。尽量在目标代码上方详细说明，而不是简单的注释掉。如果无用，则直接删除。
说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
反例：
```
// put elephant into fridge
put(elephant, fridge);
```
方法名put，加上两个有意义的变量名elephant和fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

这一点笔者非常认同
【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1）待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是一个Javadoc的标签，目前的Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个Javadoc标签）。
2）错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。

(九) 其他

【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);

反复使用的正则表达式，提前进行预编译可以提升效率。然而如果在方法体内，只用一次的正则，就没必要预编译了
【强制】velocity调用POJO类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调用isXxx()方法。说明：注意如果是Boolean包装类对象，优先调用getXxx()的方法。
【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。
说明：如果var=null或者不存在，那么${var}会直接显示在页面上。

谁能给我解释一下这是在说哪个框架，velocity吗……放在Java开发规范里没关系吗……
【强制】注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
【强制】获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime();
说明：如果想获取更加精确的纳秒级时间值，使用System.nanoTime()的方式。在JDK8中，针对统计时间等场景，推荐使用Instant类。

如果仅要获取当前毫秒数，使用new Date().getTime()的效率低，且产生了垃圾对象
【推荐】不要在velocity模板中加入变量声明、逻辑运算符，更不要在模板中加入任何复杂的逻辑。
【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

容易引发误解的一条规约
大部分Java集合类在构造时指定的大小都是初始尺寸而不是尺寸上限
只有几种Queue除外，如ArrayBlockingQueue和LinkedBlockingQueue，其构造时可以指定队列的max size
【推荐】对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。

posted @ 2017-04-10 14:07 包远志阅读(324) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部