Java編程：刪除 List 元素的三種正確方法

刪除 List 中的元素會產生兩個問題：

1. 刪除元素後 List 的元素數量會發生變化；
2. 對 List 進行刪除操做可能會產生併發問題；

咱們經過代碼示例演示正確的刪除邏輯

package com.ips.list;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public class ArrayListRemove {
    public static void main(String[] args) {
        ArrayList<String> list = new ArrayList<String>();
        list.add("beijing");
        list.add("shanghai");
        list.add("shanghai");
        list.add("guangzhou");
        list.add("shenzhen");
        list.add("hangzhou");
        remove11(list, "shanghai");

    }

    private static void print(List<String> list){
        for (String item : list) {
            System.out.println("元素值：" + item);
        }
    }

    /*
     * 錯誤
     */
    public static void remove11(List<String> list, String target){
        int size = list.size();
        for(int i = 0; i < size; i++){
            String item = list.get(i);
            if(target.equals(item)){
                list.remove(item);
            }
        }
        print(list);
    }
    /*
     * 錯誤
     */
    public static void remove12(List<String> list, String target){
        for(int i = 0; i < list.size(); i++){
            String item = list.get(i);
            if(target.equals(item)){
                list.remove(item);
            }
        }
        print(list);
    }
    /*
     * 錯誤
     */
    public static void remove13(List<String> list, String target){
        int size = list.size();
        for(int i = size - 1; i >= 0; i--){
            String item = list.get(i);
            if(target.equals(item)){
                list.remove(item);
            }
        }
        print(list);
    }
    /*
     * 正確
     */
    public static void remove14(List<String> list, String target){
        for(int i = list.size() - 1; i >= 0; i--){
            String item = list.get(i);
            if(target.equals(item)){
                list.remove(item);
            }
        }
        print(list);
    }

    /*
     * 錯誤
     */
    public static void remove21(List<String> list, String target){
        for(String item : list){
            if(target.equals(item)){
                list.remove(item);
            }
        }
        print(list);
    }

    /*
     * 正確
     */
    public static void remove22(ArrayList<String> list, String target) {
        final CopyOnWriteArrayList<String> cowList = new CopyOnWriteArrayList<String>(list);
        for (String item : cowList) {
            if (item.equals(target)) {
                cowList.remove(item);
            }
        }
        print(cowList);
    }

    /*
     * 錯誤
     */
    public static void remove31(List<String> list, String target){
        Iterator<String> iter = list.iterator();
        while (iter.hasNext()) {
            String item = iter.next();
            if (item.equals(target)) {
                list.remove(item);
            }
        }
        print(list);
    }
    /*
     * 正確
     */
    public static void remove32(List<String> list, String target){
        Iterator<String> iter = list.iterator();
        while (iter.hasNext()) {
            String item = iter.next();
            if (item.equals(target)) {
                iter.remove();
            }
        }
        print(list);
    }

}

執行 remove11 方法，出現以下錯誤：

Exception in thread 「main」 java.lang.IndexOutOfBoundsException: Index: 5, Size: 5 
at java.util.ArrayList.rangeCheck(ArrayList.java:635) 
at java.util.ArrayList.get(ArrayList.java:411) 
at com.ips.list.ArrayListRemove.remove11(ArrayListRemove.java:33) 
at com.ips.list.ArrayListRemove.main(ArrayListRemove.java:17)

因爲int size = list.size();提早獲取了 List 的大小，for 循環中刪除了兩個元素，致使出現數組越界問題。

執行 remove12 方法，出現以下錯誤：

元素值：beijing 
元素值：shanghai 
元素值：guangzhou 
元素值：shenzhen 
元素值：hangzhou

字符串「shanghai」沒有被刪除，該方法解決了數組越界問題，但沒有解決完全刪除數據的問題，緣由是這樣的，跟蹤 ArrayList.remove(Object 0) 方法：

public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

刪除元素時執行 else 邏輯，調用了 fastRemove(index) 方法：

private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

經過代碼咱們發現：List 刪除元素的邏輯是將目標元素以後的元素往前移一個索引位置，最後一個元素置爲 null，同時 size - 1；這也就解釋了爲何第二個「shanghai」沒有被刪除。

執行 remove13 方法，正確：

元素值：beijing 
元素值：guangzhou 
元素值：shenzhen 
元素值：hangzhou

執行 remove14 方法，正確：

元素值：beijing 
元素值：guangzhou 
元素值：shenzhen 
元素值：hangzhou

那麼 remove13 與 remove14 有什麼區別呢？答案是沒有區別，可是 remove11 與 remove12 是有區別的，remove12 中每次for(int i = 0; i < list.size(); i++)執行都會計算 size 值，比較耗性能。

執行 remove21 方法，出現以下錯誤：

Exception in thread "main" java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:859)
    at java.util.ArrayList$Itr.next(ArrayList.java:831)
    at com.ips.list.ArrayListRemove.remove21(ArrayListRemove.java:82)
    at com.ips.list.ArrayListRemove.main(ArrayListRemove.java:17)

產生java.util.ConcurrentModificationException異常。foreach 寫法其實是對的 Iterable、hasNext、next方法的簡寫。所以咱們從List.iterator()着手分析，跟蹤iterator()方法，該方法返回了 Itr 迭代器對象。

public Iterator<E> iterator() {
        return new Itr();
    }

Itr 類定義代碼：

private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        int expectedModCount = modCount;

        public boolean hasNext() {
            return cursor != size;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

經過代碼咱們發現 Itr 是 ArrayList 中定義的一個私有內部類，在 next、remove方法中都會調用 checkForComodification 方法，該方法的做用是判斷 modCount != expectedModCount是否相等，若是不相等則拋出ConcurrentModificationException異常。每次正常執行 remove 方法後，都會對執行expectedModCount = modCount賦值，保證兩個值相等，那麼問題基本上已經清晰了，在 foreach 循環中執行 list.remove(item);，對 list 對象的 modCount 值進行了修改，而 list 對象的迭代器的 expectedModCount 值未進行修改，所以拋出了ConcurrentModificationException異常。

執行 remove22 方法，正確：

元素值：beijing 
元素值：guangzhou 
元素值：shenzhen 
元素值：hangzhou 
經過 CopyOnWriteArrayList 解決了 List的併發問題。

執行 remove31 方法，出現以下錯誤：

Exception in thread 「main」 java.util.ConcurrentModificationException 
at java.util.ArrayListItr.checkForComodification(ArrayList.java:859)atjava.util.ArrayListItr.next(ArrayList.java:831) 
at com.ips.list.ArrayListRemove.remove31(ArrayListRemove.java:109) 
at com.ips.list.ArrayListRemove.main(ArrayListRemove.java:17)

與執行 remove21 產生的異常一致，問題產生的緣由也一致。

執行 remove32 方法，正確：

元素值：beijing 
元素值：guangzhou 
元素值：shenzhen 
元素值：hangzhou