Java併發包之 CopyOnWriteArrayList

ChaseFor發表於2020-12-21
Java

大家在學習Java的過程中，或者工作中，始終都繞不開集合。在單執行緒環境下，ArrayList就可以滿足要求。多執行緒時，我們可以使用CopyOnWriteArrayList來保證資料安全。下面我們一起來看看CopyOnWriteArrayList類中的一些值得學習的方法。

說明：程式碼部分，均基於JDK1.8

一、新增元素

寫時複製思想

CopyOnWrite, 簡稱COW，顧名思義，就是寫入的時候將當前集合複製一份副本出來，新寫入的值新增到副本集合裡，再將原集合的引用指向新的副本集合。基於這個原理，就可以不加鎖實現併發讀，因為當前集合並不會新增元素，不會造成衝突。同樣的原理還應用在MySQL中建立快照的過程。

	/**
	  * 將指定的元素追加到此列表的末尾
	  *
	  * @param e element to be appended to this list
	  * @return {@code true} (as specified by {@link Collection#add})
	  */
	public boolean add(E e) {
	// 宣告可重入鎖
        final ReentrantLock lock = this.lock;
	// 加鎖
        lock.lock();
        try {
	      // 獲取當前陣列
            Object[] elements = getArray();
            int len = elements.length;
	      // 複製當前陣列到一個新陣列中
            Object[] newElements = Arrays.copyOf(elements, len + 1);
	      // 新增元素
            newElements[len] = e;
	      // 改變引用
            setArray(newElements);
            return true;
        } finally {
            lock.unlock();
        }
    }

二、刪除元素

ArrayList 遍歷過程中刪除的問題

大家在學習Java期間，一定都有過使用forEach遍歷ArrayList時刪除元素都會得到一個java.util.ConcurrentModificationException的錯誤。這是因為在ArrayList的remove()方法中，有一個引數modCount 專門用來記錄修改的次數，每刪除一次就modCount++。在forEach遍歷集合時，首先會記錄final int expectedModCount = modCount，若是遍歷過程中發現expectedModCount!=modCount，則會丟擲錯誤。

下面來看看具體程式碼

    /**
     * 刪除元素
     */
    public E remove(int index) {
	// 檢查下標是否越界
        rangeCheck(index);
	// 記錄修改次數
        modCount++;
	// 待刪除的元素
        E oldValue = elementData(index);
	// 待刪除元素下標之後的陣列長度
        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

        return oldValue;
    }

   /**
     * forEach 方法
     */
    @Override
    public void forEach(Consumer<? super E> action) {
        Objects.requireNonNull(action);
	// 記錄modCount
        final int expectedModCount = modCount;
        @SuppressWarnings("unchecked")
        final E[] elementData = (E[]) this.elementData;
        final int size = this.size;
	// 遍歷時判斷modCount
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            action.accept(elementData[i]);
        }
	// 不相同，丟擲異常
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

所以使用ArrayList時，如果你有遍歷刪除某個元素的場景，我們可以使用迭代器來刪除。

CopyOnWriteArrayList 的刪除

先來看看CopyOnWriteArrayList的remove()方法的原始碼，整體邏輯與ArrayList的remove()方法一直，有區別的是沒有記錄修改次數，因為每次刪除都是重新獲取的當前陣列。而forEach()方法在遍歷時也是獲取的當前陣列，因此在使用forEach遍歷時刪除元素不會丟擲異常。

	/**
     * 刪除元素
     */
    public E remove(int index) {
        final ReentrantLock lock = this.lock;
	// 加鎖
        lock.lock();
        try {
	      // 獲取當前陣列
            Object[] elements = getArray();
	      // 記錄陣列的長度
            int len = elements.length;
	      // 記錄待刪除元素
            E oldValue = get(elements, index);
	      // 記錄待刪除元素後一個元素到尾節點的長度
            int numMoved = len - index - 1;
	      // 為0代表待刪除元素就在陣列的末尾
            if (numMoved == 0)
                setArray(Arrays.copyOf(elements, len - 1));
            else {
                Object[] newElements = new Object[len - 1];
		// 複製到新陣列中
                System.arraycopy(elements, 0, newElements, 0, index);
                System.arraycopy(elements, index + 1, newElements, index,
                                 numMoved);
		// 改變引用
                setArray(newElements);
            }
            return oldValue;
        } finally {
            lock.unlock();
        }
    }

   /**
     * 遍歷方法
     */
    public void forEach(Consumer<? super E> action) {
        if (action == null) throw new NullPointerException();
		// 獲取當前陣列
        Object[] elements = getArray();
        int len = elements.length;
        for (int i = 0; i < len; ++i) {
            @SuppressWarnings("unchecked") E e = (E) elements[i];
            action.accept(e);
        }
    }

值得注意的是，CopyOnWriteArrayList的迭代器實現裡的remove()方法會直接丟擲異常，因此在使用迭代器遍歷元素時，不能刪除元素。

總結

使用場景

基於原理，不難分析出CopyOnWriteArrayList適用於讀多寫少的併發環境

需要注意的點

因為每次新增元素都需要複製一份副本，所以最好是使用批量新增，減少複製副本的次數

缺點

一、記憶體佔用問題。 因為 CopyOnWrite 的寫時複製機制，所以在進行寫操作的時候，記憶體裡會同時駐紮兩個物件的記憶體，這一點會佔用額外的記憶體空間。

二、資料一致性問題。 由於 CopyOnWrite 容器的修改是先修改副本，所以這次修改對於其他執行緒來說，並不是實時能看到的，只有在修改完之後才能體現出來。如果你希望寫入的的資料馬上能被其他執行緒看到，CopyOnWrite 容器是不適用的。

相關文章