java编程规范

1.【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

　　正例:"test".equals(object);
　　反例:object.equals("test");
　　说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)

2.关于基本数据类型与包装数据类型的使用标准如下:

　　1) 【强制】所有的POJO类属性必须使用包装数据类型。
　　2) 【强制】RPC方法的返回值和参数必须使用包装数据类型。
　　3) 【推荐】所有的局部变量使用基本数据类型。
　　说明:POJO 类属性没有初值是 醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。

　　正例:数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

　　反例:比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装 数据类型的 null 值，能够表示额外的信息，如:远程调用失败，异常退出。

3.【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败;如 果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

　　说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

4.【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

　　说明:下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象， 然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

　　反例:

String str = "start";
for(inti=0;i<100;i++){
    str = str + "hello"; 
}

　　　　

5.【推荐】慎用 Object 的 clone 方法来拷贝对象。
　　说明:对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现域对象的 深度遍历式拷贝。

6.ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常，即java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

　　说明:subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。

7.【强制】在 subList 场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、 增加、删除产生ConcurrentModificationException 异常。

8.【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。

　　说明:使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址;如果数组元素个数大于实际所需，下标为[ list.size() ]的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。

　　正例:

List<String> list = new ArrayList<String>(2);
list.add("guan");
list.add("bao");
String[] array = new String[list.size()]; 
array = list.toArray(array);

　　反例:直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它 类型数组将出现 ClassCastException 错误。

9.【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

　　说明:asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

  String[] str = new String[] { "you", "wu" };

　　List list = Arrays.asList(str);

　　第一种情况:list.add("yangguanbao"); 运行时异常。

　　第二种情况:str[0] = "gujin"; 那么 list.get(0)也会随之修改。

10.【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方 法，而<? super T>不能使用 get 方法，作为接口调用赋值时易出错。
　　说明:扩展说一下 PECS(Producer Extends Consumer Super)原则:第一、频繁往外读取内 容的，适合用<? extends T>。第二、经常往里插入的，适合用<? super T>。

11.【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。

　　正例:

List<String> list = new ArrayList<>(); list.add("1");
list.add("2");
Iterator<String> iterator = list.iterator(); 
　　while (iterator.hasNext()) {
　　String item = iterator.next(); 
　　if (删除元素的条件) {
   　　iterator.remove();
　　}
}

　　反例:

for (String item : list) { 
　　if ("1".equals(item)) {
       list.remove(item);
   }
} 

　　说明:以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗?

12.【强制】 在 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; }

};

13.【推荐】集合初始化时，指定集合初始值大小。
　　说明:HashMap使用HashMap(int initialCapacity) 初始化。
　　正例:initialCapacity (需要存储的元素个数 / 负载因子) + 1负载因子(即 loader factor0.75，16(即默认值)。 HashMap 1024 7 resize hash

14. 【推荐】使用 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 值组合集合。

15. 【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现: AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推 荐使用 LongAdder 对象，比 AtomicLong 性能更好(减少乐观锁的重试次数)。

16. 【参考】 HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在 开发过程中可以使用其它数据结构或加锁来规避此风险。

17.【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。 说明:如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间 判断条件来代替。 反例:判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变 成了负数，这样的话，活动无法终止。

18.循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、

获取数据库连接，进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。

19.下列情形，需要进行参数校验: 1) 调用频次低的方法。 2) 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参 数错误导致中间执行回退，或者错误，那得不偿失。 3) 需要极高稳定性和可用性的方法。 4) 对外 供的开放接口，不管是RPC/API/HTTP接口。 5) 敏感权限入口。

 20.【参考】下列情形，不需要进行参数校验:

1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底
层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所 以 DAO 的参数校验，可以省略。
3) 被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参 数已经做过检查或者肯定不会有问题，此时可以不校验参数。

21.【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime(); 说明:如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中， 针对统计时间等场景，推荐使用 Instant 类。