阿里编码规范（二）OOP规约，集合处理，并发处理

最近阿里出了一个Java开发手册，里面涉及到很多工作规范的地方，有很多借鉴和参考的作用，也可以给新入行的工程师作为参考。

文档下载地址：http://techforum-img.cn-hangzhou.oss-pub.aliyun-inc.com/阿里巴巴Java开发手册v1.2.0.pdf

(四) OOP规约

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)【推荐】所有的局部变量使用基本数据类型。
   说明:POJO类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何

   NPE 问题,或者入库检查,都由使用者来保证。

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

       反例:比如显示成交总额涨跌情况,即正负x%,x为基本数据类型,调用的RPC服务,调用

不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划线-。所以包装数据类型的null值,能够表示额外的信息,如:远程调用失败,异常退出。

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,结果是3System.out.println(ary.length);

14.【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读。

15.【推荐】 类内方法定义顺序依次是:公有方法或保护方法>私有方法>getter/setter方法。

说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特别关心,是一个黑盒实现;因为方法信息价值较低,所有Service和DAO的getter/setter方法放在类体最后。

16.【推荐】setter方法中,参数名称与类成员变量名称一致,this.成员名=参数名。在

getter/setter方法中,不要增加业务逻辑,增加排查问题的难度。

反例:

public Integer getData() {

if (true) {

return this.data + 100;} 

else {

return this.data - 100;

}

17.【推荐】循环体内,字符串的连接方式,使用StringBuilder的append方法进行扩展。说明:反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象,然后进行append操作,最后通过toString方法返回String对象,造成内存资源浪费。
反例:

String str = "start";
for (int i = 0; i < 100; i++) {

str = str + "hello";}

18.【推荐】final可以声明类、成员变量、方法、以及本地变量,下列情况使用final关键字:1) 不允许被继承的类,如:String类。
2) 不允许修改引用的域对象,如:POJO类的域变量。
3) 不允许被重写的方法,如:POJO类的setter方法。

4) 不允许运行过程中重新赋值的局部变量。

5) 避免上下文重复使用一个变量,使用final描述可以强制重新定义一个变量,方便更好地进行重构。

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的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。

(五)集合处理

1.【强制】关于hashCode和equals的处理,遵循如下规则:
1) 只要重写equals,就必须重写hashCode。
2) 因为Set存储的是不重复的对象,依据hashCode和equals进行判断,所以Set存储的对象必须重写这两个方法。
3) 如果自定义对象做为Map的键,那么必须重写hashCode和equals。
说明:String重写了hashCode和equals方法,所以我们可以非常愉快地使用String对象作为key来使用。

2. 【强制】ArrayList的subList结果不可强转成ArrayList,否则会抛出ClassCastException异常:java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ;说明:subList返回的是 ArrayList的内部类 SubList,并不是ArrayList ,而是ArrayList的一个视图,对于SubList子列表的所有操作最终会反映到原列表上。

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

4.【强制】使用集合转数组的方法,必须使用集合的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错误。

5.【强制】使用工具类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)也会随之修改。

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

7. 【强制】不要在 foreach循环里进行元素的 remove/add操作。remove元素请使用 Iterator

   方式,如果并发操作,需要对 Iterator对象加锁。

   正例:

   Iterator<String> it = a.iterator();while (it.hasNext()) {

   String temp = it.next();if (删除元素的条件) {

                it.remove();
             }
   

   }

   反例:

   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”,会是同样的结果吗?

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

   };

9.【推荐】集合初始化时,指定集合初始值大小。

说明:HashMap使用HashMap(int initialCapacity) 初始化,
正例:initialCapacity=(需要存储的元素个数/负载因子) + 1。注意负载因子(即loaderfactor)默认为0.75,如果暂时无法确定初始值大小,请设置为16。
反例:HashMap需要放置 1024个元素,由于没有设置容量初始大小,随着元素不断增加,容量7次被迫扩大,resize需要重建 hash表,严重影响性能。

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

11.【推荐】高度注意Map类集合K/V能不能存储null值的情况,如下表格:

集合类	Key	Value	Super	说明
Hashtable	不允许为null	不允许为null	Dictionary	线程安全
ConcurrentHashMap	不允许为null	不允许为null	AbstractMap	分段锁技术
TreeMap	不允许为null	允许为null	AbstractMap	线程不安全
HashMap	允许为null	允许为null	AbstractMap	线程不安全

反例:由于HashMap的干扰,很多人认为ConcurrentHashMap是可以置入null值,而事实上,存储null值时会抛出NPE异常。

12.【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。说明:有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如:ArrayList是order/unsort;HashMap是unorder/unsort;TreeSet是order/sort。

13.【参考】利用Set元素唯一的特性,可以快速对一个集合进行去重操作,避免使用List的contains方法进行遍历、对比、去重操作。

(六)并发处理
1.【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全。

说明:资源驱动类、工具类、单例工厂类都需要注意。

2. 【强制】创建线程或线程池时请指定有意义的线程名称,方便出错时回溯。

   正例:

   public class TimerTaskThread extends Thread {public TimerTaskThread() {

   super.setName("TimerTaskThread"); ...}

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

4. 【强制】线程池不允许使用 Executors去创建,而是通过 ThreadPoolExecutor的方式,这样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。说明:Executors返回的线程池对象的弊端如下:

   1)FixedThreadPool和 SingleThreadPool:
   允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致OOM。

   2)CachedThreadPool和 ScheduledThreadPool:
   允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致OOM。

5.【强制】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 strongimmutable thread-safe。

6. 【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁;能锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。说明:尽可能使加锁的代码块工作量尽可能的小,避免在锁代码块中调用RPC 方法。

7. 【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造成死锁。

   说明:线程一需要对表A、B、C依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序也必须是A、B、C,否则可能出现死锁。

8. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加

   锁,要么在数据库层使用乐观锁,使用 version作为更新依据。说明:如果每次访问冲突概率小于20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次数不得小于3 次。

9. 【强制】多线程并行处理定时任务时,Timer运行多个 TimeTask时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用ScheduledExecutorService 则没有这个问题。

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

11.【推荐】避免Random实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一seed导致的性能下降。

说明:Random实例包括java.util.Random的实例或者Math.random()的方式。
正例:在JDK7之后,可以直接使用API ThreadLocalRandom,而在JDK7之前,需要编码保证每个线程持有一个实例。

12.【推荐】在并发场景下,通过双重检查锁(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...

}

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

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

15.【参考】ThreadLocal无法解决共享对象的更新问题,ThreadLocal对象建议使用static

修饰。这个变量是针对一个线程内所有操作共有的,所以设置为静态变量,所有此类实例共享此静态变量 ,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。