Like Share Discussion Bookmark Smile

J.J. Huang   2020-05-03   Java   瀏覽次數:

《阿里Java開發手冊》 | 編程規約 - 集合處理

【強制】關於hashCode和equals的處理,遵循如下規則:

  • 只要重寫 equals,就必須重寫 hashCode。
  • 因為 Set 存儲的是不重複的對象,依據 hashCode 和 equals 進行判斷,所以 Set 存儲的對象必須重寫 這兩個方法。
  • 如果自定義對像作為 Map 的鍵,那麼必須覆寫 hashCode 和 equals。
    說明:String 因為重寫了 hashCode 和 equals 方法,所以我們可以愉快地使用 String 對像作為 key 來使 用。

【強制】判斷所有集合內部的元素是否為空,使用isEmpty()方法,而不是size()==0的方式。
說明:前者的時間複雜度為 O(1),而且可讀性更好。
正例:

1
2
3
4
Map < String, Object > map = new HashMap < > ();
if (map.isEmpty()) {
System.out.println("no element in this map.");
}

【強制】在使用 java.util.stream.Collectors 類的 toMap() 方法轉為 Map 集合時,一定要使用含有參數類型為 BinaryOperator,參數名為 mergeFunction 的方法,否則當出現相同 key 值時會拋出 IllegalStateException 異常。
說明:參數 mergeFunction 的作用是當出現 key 重複時,自定義對 value 的處理策略。
正例:

1
2
3
4
5
6
7
List < Pair < String, Double >> pairArrayList = new ArrayList < > (3);
pairArrayList.add(new Pair < > ("version", 6.19));
pairArrayList.add(new Pair < > ("version", 10.24));
pairArrayList.add(new Pair < > ("version", 13.14));
Map < String, Double > map = pairArrayList.stream().collect(
// 生成的map 集合中只有一個鍵值對:{version=13.14}
Collectors.toMap(Pair::getKey, Pair::getValue, (v1 , v2) -> v2));

反例:

1
2
3
4
String[] departments = new String[] {"iERP", "iERP", "EIBU"};
// 拋出 IllegalStateException 異常
Map < Integer, String > map = Arrays.stream(departments)
.collect(Collectors.toMap(String::hashCode, str -> str));

【強制】在使用 java.util.stream.Collectors 類的 toMap() 方法轉為 Map 集合時,一定要注意當 value 為 null 時會拋 NPE 異常。
說明:在 java.util.HashMap 的 merge 方法裡會進行如下的判斷:

1
2
if (value == null || remappingFunction == null)
throw new NullPointerException();

反例:

1
2
3
4
5
6
List < Pair < String, Double >> pairArrayList = new ArrayList < > (2);
pairArrayList.add(new Pair < > ("version1", 4.22));
pairArrayList.add(new Pair < > ("version2", null));
Map < String, Double > map = pairArrayList.stream().collect(
// 抛出 NullPointerException 异常
Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) -> v2));

【強制】ArrayList 的 subList 結果不可強轉成 ArrayList,否則會拋出 ClassCastException 異常:java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。
說明:subList 返回的是 ArrayList 的內部類 SubList,並不是 ArrayList 而是 ArrayList 的一個視圖,對 於 SubList 子列表的所有操作最終會反映到原列表上。


【強制】使用 Map 的方法 keySet()/values()/entrySet() 返回集合對象時,不可以對其進行添加元素操作,否則會拋出 UnsupportedOperationException 異常。


【強制】Collections 類返回的對象,如:emptyList()/singletonList()等都是 immutable list,不可對其進行添加或者刪除元素的操作。
反例:如果查詢無結果,返回 Collections.emptyList()空集合對象,調用方一旦進行了添加元素的操作,就會觸發 UnsupportedOperationException 異常。


【強制】在 subList 場景中,高度注意對父集合元素的增加或刪除,均會導致子列表的遍歷、增加、刪除產生 ConcurrentModificationException 異常。


【強制】使用集合轉陣列的方法,必須使用集合的 toArray(T[] array),傳入的是類型完全一致、長度為 0 的空陣列。
反例:直接使用 toArray 無參方法存在問題,此方法返回值只能是 Object[]類,若強轉其它類型陣列將出現ClassCastException 錯誤。
正例:

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

說明:使用 toArray 帶參方法,陣列空間大小的 length,

  • 等於 0,動態建立與 size 相同的陣列,性能最好。
  • 大於 0 但小於 size,重新建立大小等於 size 的陣列,增加 GC 負擔。
  • 等於 size,在高並發情況下,陣列建立完成之後,size 正在變大的情況下,負面影響與 2 相同。
  • 大於 size,空間浪費,且在 size 處插入 null 值,存在 NPE 隱患。

【強制】在使用 Collection 接口任何實作類的 addAll()方法時,都要對輸入的集合參數進行 NPE 判斷。
說明:在 ArrayList#addAll 方法的第一行程式碼即 Object[] a = c.toArray(); 其中 c 為輸入集合參數,如果為 null,則直接拋出異常。


【強制】使用工具類 Arrays.asList() 把陣列轉換成集合時,不能使用其修改集合相關的方法,它的 add/remove/clear 方法會拋出 UnsupportedOperationException 異常。
說明:asList 的返回對像是一個 Arrays 內部類,並沒有實作集合的修改方法。 Arrays.asList 體現的是適配器模式,只是轉換接口,後台的資料仍是陣列。

1
2
String[] str = new String[] { "yang", "hao" };
List list = Arrays.asList(str);

第一種情況:list.add(“yangguanbao”); 運行時異常。
第二種情況:str[0] = “changed”; 也會隨之修改,反之亦然。


【強制】泛型通配符 <? extends T> 來接收返回的資料,此寫法的泛型集合不能使用 add 方法, 而 <? super T> 不能使用 get 方法,兩者在接口調用賦值的場景中容易出錯。
說明:擴展說一下 PECS(Producer Extends Consumer Super)原則:第一、頻繁往外讀取內容的,適合用 <? extends T>。第二、經常往裡插入的,適合用<? super T>


【強制】在無泛型限制定義的集合賦值給泛型限制的集合時,在使用集合元素時,需要進行 instanceof 判斷,避免拋出 ClassCastException 異常。
說明:畢竟泛型是在 JDK5 後才出現,考慮到向前兼容,編譯器是允許非泛型集合與泛型集合互相賦值。
反例:

1
2
3
4
5
6
7
List<String> generics = null;
List notGenerics = new ArrayList(10);
notGenerics.add(new Object());
notGenerics.add(new Integer(1));
generics = notGenerics;
// 此處拋出 ClassCastException 異常
String string = generics.get(0);

【強制】不要在 foreach 循環裡進行元素的 remove/add 操作。 remove 元素請使用 Iterator 方式,如果並發操作,需要對 Iterator 對象加鎖。
正例:

1
2
3
4
5
6
7
8
9
10
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();
}
}

反例:

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

說明:以上程式碼的執行結果肯定會出乎大家的意料,那麼試一下把“1”換成“2”,會是同樣的結果嗎?

1
java.util.ConcurrentModificationException

【強制】在 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 比較結果相同。
    反例:下例中沒有處理相等的情況,交換兩個對象判斷結果並不互反,不符合第一個條件,在實際使用中 可能會出現異常。
    1
    2
    3
    4
    5
    6
    new Comparator < Student > () {
    @Override
    public int compare(Student o1, Student o2) {
    return o1.getId() > o2.getId() ? 1 : -1;
    }
    };

【推薦】集合泛型定義時,在 JDK7 及以上,使用 diamond 語法或全省略。
說明:菱形泛型,即 diamond,直接使用<>來指代前邊已經指定的類型。
正例:

1
2
3
4
// diamond 方式,即<>
HashMap<String, String> userCache = new HashMap<>(16);
// 全省略方式
ArrayList<User> users = new ArrayList(10);

【推薦】集合初始化時,指定集合初始值大小。
說明:HashMap 使用 HashMap(int initialCapacity) 初始化,如果暫時無法確定集合大小,那麼指定默 認值(16)即可。
正例:initialCapacity = (需要存儲的元素個數 / 負載因子) + 1。注意負載因子(即 loader factor)預設為 0.75,如果暫時無法確定初始值大小,請設置為 16(即預設值)。
反例:HashMap 需要放置 1024 個元素,由於沒有設置容量初始大小,隨著元素不斷增加,容量 7 次被迫擴大,resize 需要重建 hash 表。當放置的集合元素個數達千萬級別時,不斷擴容會嚴重影響性能。


【推薦】使用 entrySet 遍歷 Map 類集合 KV,而不是 keySet 方式進行遍歷。
說明:keySet 其實是遍歷了 2 次,一次是轉為 Iterator 對象,另一次是從 hashMap 中取出 key 所對應的 value。而 entrySet 只是遍歷了一次就把 key 和 value 都放到了 entry 中,效率更高。如果是 JDK8,使用 Map.forEach 方法。
正例:values()返回的是V 值集合,是一個list 集合對象;keySet()返回的是K 值集合,是一個Set 集合對象;entrySet( )返回的是KV 值組合集合。


【推薦】高度注意 Map 類集合 K/V 能不能存儲 null 值的情況,如下表格:

集合類 Key Value Super 說明
Hashtable 不允許為 null 不允許為 null Dictionary 執行緒(thread)安全
ConcurrentHashMap 不允許為 null 不允許為 null AbstractMap 鎖分段技術 (JDK8:CAS)
TreeMap 不允許為 null 允許為 null AbstractMap 執行緒(thread)不安全
HashMap 允許為 null 允許為 null AbstractMap 執行緒(thread)不安全

反例:由於 HashMap 的干擾,很多人認為 ConcurrentHashMap 是可以置入 null 值,而事實上,存儲 null 值時會拋出 NPE 異常。

【參考】合理利用好集合的有序性(sort)和穩定性(order),避免集合的無序性(unsort)和不穩定性(unorder)帶來的負面影響。
說明:有序性是指遍歷的結果是按某種比較規則依次排列的。穩定性指集合每次遍歷的元素次序是一定的。
如:ArrayList 是 order/unsort;HashMap 是 unorder/unsort;TreeSet 是 order/sort。

【參考】利用 Set 元素唯一的特性,可以快速對一個集合進行去重操作,避免使用 List 的 contains()進行遍歷去重或者判斷包含操作。


心得

看完這篇「集合處理」後,發現常見的一些集合操作,並沒有這麼嚴謹的去使用;還有最常見的判斷Size = 0,這也是在很多專案中常見的狀況。

只能說在對集合做任何的做操作前,都應該要了解其特性和可能發生的問題,對其先行做處理,避免後續發生很多非預期的例外。

結語

文章越看越多,技術越學越多,就會發現自己的不足;技術學到後面都會想要將基礎再重新在打得更加扎實。

以前在開發覺得理所當然的事情,例如:命名規則、命名規範,照著別人怎麼說就怎麼做的想法,並沒有好好去想為什麼要這樣設計和規範。
於是乎同事們推薦《阿里巴巴Java開發手冊》來做閱讀,書中提到種種規範《正確範例》、《錯誤範例》還有解釋定義說明;我相信在閱讀完這一系列後,一定會更加扎實且實在。

如對此書有興趣,建議去購買官方認證的書籍,給予官方支持。

註:如有侵權,通知即刪。


註:以上參考了
Alibaba-Java-Coding-Guidelines Github
Alibaba-Java-Coding-Guidelines English Version