走進原始碼——CopyOnWriteArrayList閱讀筆記

liangxingwei發表於2017-12-14

CopyOnWriteArrayList

無繼承,實現了List,RandomAccess,Cloneable,和Serializable介面,具有List的特性,提供可隨機訪問,提供自身克隆以及序列化的一個容器類。 特點:執行緒安全;讀寫分離;陣列實現

CopyOnWriteArrayList這個容器類的名字也很好理解,寫時拷貝列表,網上對COW(CopyOnWrite)有一個高大上的名字,叫做讀寫分離,所以CopyOnWriteArrayList是讀寫分離列表類,下面描述下它的實現

成員變數

相比於ArrayList,CopyOnWriteArrayList的成員變數發生了很多改變,就只有下面幾個

// 序列化ID
private static final long serialVersionUID = 8673264195747942595L;
// 鎖變數
final transient ReentrantLock lock = new ReentrantLock();
// 真正儲存資料的陣列
private transient volatile Object[] array;
複製程式碼

甚至是size都沒了,而size()函式的實現則變成了下面這樣

public int size() {
    return getArray().length;
}
複製程式碼
方法

首先是對array操作的限制,CopyOnWriteArrayList提供了array的setter和getter方法,在下文會看到,涉及到array的操作,都是通過setter和getter來完成的

final Object[] getArray() {
    return array;
}
final void setArray(Object[] a) {
    array = a;
}
複製程式碼

其次是建構函式,CopyOnWriteArrayList提供了預設,帶集合類和帶陣列的三個建構函式,在這三個函式裡面都能看到setArray()的影子。而其中,預設的建構函式初始化容器的容量為0

public CopyOnWriteArrayList() {
    setArray(new Object[0]);
}
public CopyOnWriteArrayList(Collection<? extends E> c) {
    Object[] elements;
    if (c.getClass() == CopyOnWriteArrayList.class)
        elements = ((CopyOnWriteArrayList<?>)c).getArray();
    else {
        elements = c.toArray();
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        if (elements.getClass() != Object[].class)
            elements = Arrays.copyOf(elements, elements.length, Object[].class);
    }
    setArray(elements);
}
public CopyOnWriteArrayList(E[] toCopyIn) {
    setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
複製程式碼

接著看最重頭戲的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();
    }
}
複製程式碼

我們可以看到,CopyOnWriteArrayList沒有像ArrayListVector那樣複雜的擴容機制,只通過兩句程式碼即實現了新增資料,又實現了擴容

  Object[] newElements = Arrays.copyOf(elements, len + 1);
  newElements[len] = e;
  setArray(newElements);
複製程式碼

接著,在方法的開始和結束分別是上鎖lock.lock();和解鎖lock.unlock();,給方法上鎖的一個原因是避免多執行緒環境下,多個執行緒拷貝出多個副本,然後多個副本運算元據後影響資料的正確性。 除了add()方法外,set(),remove()等的運算元據的操作,基本都和add()方法類似,這裡就不在贅述了。 再接著看獲取的方法get()

private E get(Object[] a, int index) {
    return (E) a[index];
}

public E get(int index) {
    return get(getArray(), index);
}
複製程式碼

可以看到,get()方法是直接在array中進行獲取。 綜合看add()get()方法,add()方法在進行的時候會先上鎖,然後拷貝一份資料的副本進行操作,然後將操作後的副本賦值到array中去,至於get()方法是直接獲取array中的值,也正是這樣,實現了讀寫分離。但是這也會有一個問題,就是資料的實時不一致性,有可能副本還沒賦值到array,而使用者通過get()方法獲取了舊的array的值。

來看下CopyOnWriteArrayList的迭代器,因為它沒有繼承AbstractList因此也沒有modCount這個變數,先看下怎麼得到它的迭代器

public ListIterator<E> listIterator(int index) {
    Object[] elements = getArray();
    int len = elements.length;
    if (index < 0 || index > len)
        throw new IndexOutOfBoundsException("Index: "+index);

    return new COWIterator<E>(elements, index);
}

private COWIterator(Object[] elements, int initialCursor) {
    cursor = initialCursor;
    snapshot = elements;
}
複製程式碼

可以看到是直接通過array和初始化的下標來獲取到迭代器。至於迭代資料則是直接獲取

@SuppressWarnings("unchecked")
public E next() {
   if (! hasNext())
       throw new NoSuchElementException();
       return (E) snapshot[cursor++];
}
複製程式碼

因此,這裡沒有像ArrayList那樣,有一個checkForComodification,檢查是否迭代資料被修改,因此我又測試了下

意料之中的毫無錯誤
ArrayList中,如果獲取到攔截器之後對容器內資料進行操作,就會報ConcurrentModificationExceptio,而在CopyOnWriteArrayList則不存在這個問題。 但是也有另外一個問題,如圖片所展示那樣,獲取到迭代器之後修改容器內的資料,攔截器並不會有所更新,要獲取到修改後的資料,還得重新獲取迭代器。

剩下的一些方法就不贅述啦,大同小異。

總結

CopyOnWriteArrayList的核心是在運算元據的時候,通過拷貝原容器陣列的副本,在副本上進行操作後,將副本賦值到容器陣列,從而實現讀寫分離。 CopyOnWriteArrayList適用於讀多寫少的場景,因為寫的時候會拷貝陣列,很容易產生大量垃圾而觸發GC,不利於系統的效能。

水平有限,難免有錯,還請評論區指正。

相關文章