Java 集合使用不當，Code Review 被 Diss了！
大家好，我是 Guide!
有很多小伙伴在寫代碼的時候，有一些比較基礎的問題沒有考慮到，導致項目 Code Review 的時候被 diss。
上周五 Code Review 的時候，團隊有個工作1年多的小伙伴使用 Java 集合的時候就出現了一個非常基礎的問題。
這篇文章我根據《阿里巴巴 Java 開發手冊》總結了關于集合使用常見的注意事項以及其具體原理。
強烈建議小伙伴們多多閱讀幾遍，避免自己寫代碼的時候出現這些低級的問題。
集合判空
《阿里巴巴 Java 開發手冊》的描述如下：
判斷所有集合內部的元素是否為空，使用 isEmpty() 方法，而不是 size()==0 的方式。
這是因為 isEmpty() 方法的可讀性更好，并且時間復雜度為 O(1)。
絕大部分我們使用的集合的 size() 方法的時間復雜度也是 O(1)，不過，也有很多復雜度不是 O(1) 的，比如 java.util.concurrent 包下的某些集合(ConcurrentLinkedQueue 、ConcurrentHashMap...)。
下面是 ConcurrentHashMap 的 size() 方法和 isEmpty() 方法的源碼。
- public int size() {
- long n = sumCount();
- return ((n < 0L) ? 0 :
- (n > (long)Integer.MAX_VALUE) ? Integer.MAX_VALUE :
- (int)n);
- }
- final long sumCount() {
- CounterCell[] as = counterCells; CounterCell a;
- long sum = baseCount;
- if (as != null) {
- for (int i = 0; i < as.length; ++i) {
- if ((a = as[i]) != null)
- sum += a.value;
- }
- }
- return sum;
- }
- public boolean isEmpty() {
- return sumCount() <= 0L; // ignore transient negative values
- }
集合轉 Map
《阿里巴巴 Java 開發手冊》的描述如下：
在使用 java.util.stream.Collectors 類的 toMap() 方法轉為 Map 集合時，一定要注意當 value 為 null 時會拋 NPE 異常。
- class Person {
- private String name;
- private String phoneNumber;
- // getters and setters
- }
- List<Person> bookList = new ArrayList<>();
- bookList.add(new Person("jack","18163138123"));
- bookList.add(new Person("martin",null));
- // 空指針異常
- bookList.stream().collect(Collectors.toMap(Person::getName, Person::getPhoneNumber));
下面我們來解釋一下原因。
首先，我們來看 java.util.stream.Collectors 類的 toMap() 方法 ，可以看到其內部調用了 Map 接口的 merge() 方法。
- public static <T, K, U, M extends Map<K, U>>
- Collector<T, ?, M> toMap(Function<? super T, ? extends K> keyMapper,
- Function<? super T, ? extends U> valueMapper,
- BinaryOperator<U> mergeFunction,
- Supplier<M> mapSupplier) {
- BiConsumer<M, T> accumulator
- = (map, element) -> map.merge(keyMapper.apply(element),
- valueMapper.apply(element), mergeFunction);
- return new CollectorImpl<>(mapSupplier, accumulator, mapMerger(mergeFunction), CH_ID);
- }
Map 接口的 merge() 方法如下，這個方法是接口中的默認實現。
如果你還不了解 Java 8 新特性的話，請看這篇文章：《Java8 新特性總結》 。
- default V merge(K key, V value,
- BiFunction<? super V, ? super V, ? extends V> remappingFunction) {
- Objects.requireNonNull(remappingFunction);
- Objects.requireNonNull(value);
- V oldValue = get(key);
- V newValue = (oldValue == null) ? value :
- remappingFunction.apply(oldValue, value);
- if(newValue == null) {
- remove(key);
- } else {
- put(key, newValue);
- }
- return newValue;
- }
merge() 方法會先調用 Objects.requireNonNull() 方法判斷 value 是否為空。
- public static <T> T requireNonNull(T obj) {
- if (obj == null)
- throw new NullPointerException();
- return obj;
- }
集合遍歷
《阿里巴巴 Java 開發手冊》的描述如下：
不要在 foreach 循環里進行元素的 remove/add 操作。remove 元素請使用 Iterator 方式，如果并發操作，需要對 Iterator 對象加鎖。
通過反編譯你會發現 foreach 語法糖底層其實還是依賴 Iterator 。不過， remove/add 操作直接調用的是集合自己的方法，而不是 Iterator 的 remove/add方法
這就導致 Iterator 莫名其妙地發現自己有元素被 remove/add ，然后，它就會拋出一個 ConcurrentModificationException 來提示用戶發生了并發修改異常。這就是單線程狀態下產生的 fail-fast 機制。
fail-fast 機制 ：多個線程對 fail-fast 集合進行修改的時候，可能會拋出ConcurrentModificationException。即使是單線程下也有可能會出現這種情況，上面已經提到過。
Java8 開始，可以使用 Collection#removeIf()方法刪除滿足特定條件的元素,如
- List<Integer> list = new ArrayList<>();
- for (int i = 1; i <= 10; ++i) {
- list.add(i);
- }
- list.removeIf(filter -> filter % 2 == 0); /* 刪除list中的所有偶數 */
- System.out.println(list); /* [1, 3, 5, 7, 9] */
除了上面介紹的直接使用 Iterator 進行遍歷操作之外，你還可以：
- 使用普通的 for 循環
- 使用 fail-safe 的集合類。java.util包下面的所有的集合類都是 fail-fast 的，而java.util.concurrent包下面的所有的類都是 fail-safe 的。
- ......
集合去重
《阿里巴巴 Java 開發手冊》的描述如下：
可以利用 Set 元素唯一的特性，可以快速對一個集合進行去重操作，避免使用 List 的 contains() 進行遍歷去重或者判斷包含操作。
這里我們以 HashSet 和 ArrayList 為例說明。
- // Set 去重代碼示例
- public static <T> Set<T> removeDuplicateBySet(List<T> data) {
- if (CollectionUtils.isEmpty(data)) {
- return new HashSet<>();
- }
- return new HashSet<>(data);
- }
- // List 去重代碼示例
- public static <T> List<T> removeDuplicateByList(List<T> data) {
- if (CollectionUtils.isEmpty(data)) {
- return new ArrayList<>();
- }
- List<T> result = new ArrayList<>(data.size());
- for (T current : data) {
- if (!result.contains(current)) {
- result.add(current);
- }
- }
- return result;
- }
兩者的核心差別在于 contains() 方法的實現。
HashSet 的 contains() 方法底部依賴的 HashMap 的 containsKey() 方法，時間復雜度接近于 O(1)(沒有出現哈希沖突的時候為 O(1))。
- private transient HashMap<E,Object> map;
- public boolean contains(Object o) {
- return map.containsKey(o);
- }
我們有 N 個元素插入進 Set 中，那時間復雜度就接近是 O (n)。
ArrayList 的 contains() 方法是通過遍歷所有元素的方法來做的，時間復雜度接近是 O(n)。
- public boolean contains(Object o) {
- return indexOf(o) >= 0;
- }
- public int indexOf(Object o) {
- if (o == null) {
- for (int i = 0; i < size; i++)
- if (elementData[i]==null)
- return i;
- } else {
- for (int i = 0; i < size; i++)
- if (o.equals(elementData[i]))
- return i;
- }
- return -1;
- }
我們的 List 有 N 個元素，那時間復雜度就接近是 O (n^2)。
集合轉數組
《阿里巴巴 Java 開發手冊》的描述如下：
使用集合轉數組的方法，必須使用集合的 toArray(T[] array)，傳入的是類型完全一致、長度為 0 的空數組。
toArray(T[] array) 方法的參數是一個泛型數組，如果 toArray 方法中沒有傳遞任何參數的話返回的是 Object類 型數組。
- String [] s= new String[]{
- "dog", "lazy", "a", "over", "jumps", "fox", "brown", "quick", "A"
- };
- List<String> list = Arrays.asList(s);
- Collections.reverse(list);
- //沒有指定類型的話會報錯
- s=list.toArray(new String[0]);
由于 JVM 優化，new String[0]作為Collection.toArray()方法的參數現在使用更好，new String[0]就是起一個模板的作用，指定了返回數組的類型，0 是為了節省空間，因為它只是為了說明返回的類型。詳見：https://shipilev.net/blog/2016/arrays-wisdom-ancients/
數組轉集合
《阿里巴巴 Java 開發手冊》的描述如下：
使用工具類 Arrays.asList() 把數組轉換成集合時，不能使用其修改集合相關的方法， 它的 add/remove/clear 方法會拋出 UnsupportedOperationException 異常。
我在之前的一個項目中就遇到一個類似的坑。
Arrays.asList()在平時開發中還是比較常見的，我們可以使用它將一個數組轉換為一個 List 集合。
- String[] myArray = {"Apple", "Banana", "Orange"};
- List<String> myList = Arrays.asList(myArray);
- //上面兩個語句等價于下面一條語句
- List<String> myList = Arrays.asList("Apple","Banana", "Orange");
JDK 源碼對于這個方法的說明：
- /**
- *返回由指定數組支持的固定大小的列表。此方法作為基于數組和基于集合的API之間的橋梁，
- * 與 Collection.toArray()結合使用。返回的List是可序列化并實現RandomAccess接口。
- */
- public static <T> List<T> asList(T... a) {
- return new ArrayList<>(a);
- }
下面我們來總結一下使用注意事項。
1、Arrays.asList()是泛型方法，傳遞的數組必須是對象數組，而不是基本類型。
- int[] myArray = {1, 2, 3};
- List myList = Arrays.asList(myArray);
- System.out.println(myList.size());//1
- System.out.println(myList.get(0));//數組地址值
- System.out.println(myList.get(1));//報錯：ArrayIndexOutOfBoundsException
- int[] array = (int[]) myList.get(0);
- System.out.println(array[0]);//1
當傳入一個原生數據類型數組時，Arrays.asList() 的真正得到的參數就不是數組中的元素，而是數組對象本身!此時 List 的唯一元素就是這個數組，這也就解釋了上面的代碼。
我們使用包裝類型數組就可以解決這個問題。
- Integer[] myArray = {1, 2, 3};
2、使用集合的修改方法: add()、remove()、clear()會拋出異常。
- List myList = Arrays.asList(1, 2, 3);
- myList.add(4);//運行時報錯：UnsupportedOperationException
- myList.remove(1);//運行時報錯：UnsupportedOperationException
- myList.clear();//運行時報錯：UnsupportedOperationException
Arrays.asList() 方法返回的并不是 java.util.ArrayList ，而是 java.util.Arrays 的一個內部類,這個內部類并沒有實現集合的修改方法或者說并沒有重寫這些方法。
- List myList = Arrays.asList(1, 2, 3);
- System.out.println(myList.getClass());//class java.util.Arrays$ArrayList
下圖是 java.util.Arrays$ArrayList 的簡易源碼，我們可以看到這個類重寫的方法有哪些。
- private static class ArrayList<E> extends AbstractList<E>
- implements RandomAccess, java.io.Serializable
- {
- ...
- @Override
- public E get(int index) {
- ...
- }
- @Override
- public E set(int index, E element) {
- ...
- }
- @Override
- public int indexOf(Object o) {
- ...
- }
- @Override
- public boolean contains(Object o) {
- ...
- }
- @Override
- public void forEach(Consumer<? super E> action) {
- ...
- }
- @Override
- public void replaceAll(UnaryOperator<E> operator) {
- ...
- }
- @Override
- public void sort(Comparator<? super E> c) {
- ...
- }
- }
我們再看一下java.util.AbstractList的 add/remove/clear 方法就知道為什么會拋出 UnsupportedOperationException 了。
- public E remove(int index) {
- throw new UnsupportedOperationException();
- }
- public boolean add(E e) {
- add(size(), e);
- return true;
- }
- public void add(int index, E element) {
- throw new UnsupportedOperationException();
- }
- public void clear() {
- removeRange(0, size());
- }
- protected void removeRange(int fromIndex, int toIndex) {
- ListIterator<E> it = listIterator(fromIndex);
- for (int i=0, n=toIndex-fromIndex; i<n; i++) {
- it.next();
- it.remove();
- }
- }
那我們如何正確的將數組轉換為 ArrayList ?
1、手動實現工具類
- static <T> List<T> arrayToList(final T[] array) {
- final List<T> l = new ArrayList<T>(array.length);
- for (final T s : array) {
- l.add(s);
- }
- return l;
- }
- Integer [] myArray = { 1, 2, 3 };
- System.out.println(arrayToList(myArray).getClass());//class java.util.ArrayList
2、最簡便的方法
- List list = new ArrayList<>(Arrays.asList("a", "b", "c"))
3、使用 Java8 的 Stream(推薦)
- Integer [] myArray = { 1, 2, 3 };
- List myList = Arrays.stream(myArray).collect(Collectors.toList());
- //基本類型也可以實現轉換（依賴boxed的裝箱操作）
- int [] myArray2 = { 1, 2, 3 };
- List myList = Arrays.stream(myArray2).boxed().collect(Collectors.toList());
4、使用 Guava
對于不可變集合，你可以使用ImmutableList類及其of()與copyOf()工廠方法：(參數不能為空)
- List<String> il = ImmutableList.of("string", "elements"); // from varargs
- List<String> il = ImmutableList.copyOf(aStringArray); // from array
對于可變集合，你可以使用Lists類及其newArrayList()工廠方法：
- List<String> l1 = Lists.newArrayList(anotherListOrCollection); // from collection
- List<String> l2 = Lists.newArrayList(aStringArray); // from array
- List<String> l3 = Lists.newArrayList("or", "string", "elements"); // from varargs
5、使用 Apache Commons Collections
- List<String> list = new ArrayList<String>();
- CollectionUtils.addAll(list, str);
6、 使用 Java9 的 List.of()方法
- Integer[] array = {1, 2, 3};
- List<Integer> list = List.of(array);
