java中CopyOnWriteArrayList詳解

初念初戀發表於2022-02-22
Java

簡介

CopyOnWriteArrayList是ArrayList的執行緒安全版本，內部也是通過陣列實現，每次對陣列的修改都完全拷貝一份新的陣列來修改，修改完了再替換掉老陣列，這樣保證了只阻塞寫操作，不阻塞讀操作，實現讀寫分離。

繼承體系

public class CopyOnWriteArrayList<E>
    implements List<E>, RandomAccess, Cloneable, java.io.Serializable 
    {...}
  • CopyOnWriteArrayList實現了List，RandomAccess，Cloneable，java.io.Serializable等介面。
  • CopyOnWriteArrayList實現了List，提供了基礎的新增、刪除、遍歷等操作。
  • CopyOnWriteArrayList實現了RandomAccess，提供了隨機訪問的能力。
  • CopyOnWriteArrayList實現了Cloneable，可以被克隆。
  • CopyOnWriteArrayList實現了Serializable，可以被序列化。

原始碼解析

屬性

/** 用於修改時加鎖 */
final transient ReentrantLock lock = new ReentrantLock();

/** 真正儲存元素的地方，只能通過getArray()/setArray()訪問 */
private transient volatile Object[] array;
  • lock：修改時加鎖，使用transient修飾表示不自動序列化。
  • array：儲存元素的地方，使用transient修飾表示不自動序列化，使用volatile修飾表示一個執行緒對這個欄位的修改另外一個執行緒立即可見。

構造方法

建立空陣列。

public CopyOnWriteArrayList() {
    // 所有對array的操作都是通過setArray()和getArray()進行
    setArray(new Object[0]);
}

final void setArray(Object[] a) {
    array = a;
}
public CopyOnWriteArrayList(Collection<? extends E> c) {
    Object[] elements;
    if (c.getClass() == CopyOnWriteArrayList.class)
        // 如果c也是CopyOnWriteArrayList型別
        // 那麼直接把它的陣列拿過來使用
        elements = ((CopyOnWriteArrayList<?>)c).getArray();
    else {
        // 否則呼叫其toArray()方法將集合元素轉化為陣列
        elements = c.toArray();
        // 這裡c.toArray()返回的不一定是Object[]型別
        // 詳細原因見ArrayList裡面的分析
        if (elements.getClass() != Object[].class)
            elements = Arrays.copyOf(elements, elements.length, Object[].class);
    }
    setArray(elements);
}
  • 如果 c 是CopyOnWriteArrayList型別，直接把它的陣列賦值給當前list的陣列，注意這裡是淺拷貝，兩個集合共用同一個陣列。
  • 如果 c 不是CopyOnWriteArrayList型別，則進行拷貝把c的元素全部拷貝到當前list的陣列中。
public CopyOnWriteArrayList(E[] toCopyIn) {
    setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
  • 把toCopyIn的元素拷貝給當前list的陣列。

add(E e)方法

新增一個元素到末尾。

public boolean add(E e) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 獲取舊陣列
        Object[] elements = getArray();
        int len = elements.length;
        // 將舊陣列元素拷貝到新陣列中
        // 新陣列大小是舊陣列大小加1
        Object[] newElements = Arrays.copyOf(elements, len + 1);
        // 將元素放在最後一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}
  1. 加鎖；
  2. 獲取元素陣列；
  3. 新建一個陣列，大小為原陣列長度加1，並把原陣列元素拷貝到新陣列；
  4. 把新新增的元素放到新陣列的末尾；
  5. 把新陣列賦值給當前物件的array屬性，覆蓋原陣列；
  6. 解鎖。

add(int index, E element)方法

新增一個元素在指定索引處。

public void add(int index, E element) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 獲取舊陣列
        Object[] elements = getArray();
        int len = elements.length;
        // 檢查是否越界, 可以等於len
        if (index > len || index < 0)
            throw new IndexOutOfBoundsException("Index: "+index+
                                                ", Size: "+len);
        Object[] newElements;
        int numMoved = len - index;
        if (numMoved == 0)
            // 如果插入的位置是最後一位
            // 那麼拷貝一個n+1的陣列, 其前n個元素與舊陣列一致
            newElements = Arrays.copyOf(elements, len + 1);
        else {
            // 如果插入的位置不是最後一位
            // 那麼新建一個n+1的陣列
            newElements = new Object[len + 1];
            // 拷貝舊陣列前index的元素到新陣列中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 將index及其之後的元素往後挪一位拷貝到新陣列中
            // 這樣正好index位置是空出來的
            System.arraycopy(elements, index, newElements, index + 1,
                             numMoved);
        }
        // 將元素放置在index處
        newElements[index] = element;
        setArray(newElements);
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}
  1. 加鎖；
  2. 檢查索引是否合法，如果不合法丟擲IndexOutOfBoundsException異常，注意這裡 index 等於 len 也是合法的；
  3. 如果索引等於陣列長度（也就是陣列最後一位再加1），那就拷貝一個len+1的陣列；
  4. 如果索引不等於陣列長度，那就新建一個len+1的陣列，並按索引位置分成兩部分，索引之前（不包含）的部分拷貝到新陣列索引之前（不包含）的部分，索引之後（包含）的位置拷貝到新陣列索引之後（不包含）的位置，索引所在位置留空；
  5. 把索引位置賦值為待新增的元素；
  6. 把新陣列賦值給當前物件的array屬性，覆蓋原陣列；
  7. 解鎖；

addIfAbsent(E e)方法

新增一個元素如果這個元素不存在於集合中。

public boolean addIfAbsent(E e) {
    // 獲取元素陣列, 取名為快照
    Object[] snapshot = getArray();
    // 檢查如果元素不存在,直接返回false
    // 如果存在再呼叫addIfAbsent()方法新增元素
    return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
        addIfAbsent(e, snapshot);
}

private boolean addIfAbsent(E e, Object[] snapshot) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 重新獲取舊陣列
        Object[] current = getArray();
        int len = current.length;
        // 如果快照與剛獲取的陣列不一致
        // 說明有修改
        if (snapshot != current) {
            // 重新檢查元素是否在剛獲取的陣列裡
            int common = Math.min(snapshot.length, len);
            for (int i = 0; i < common; i++)
                // 到這個方法裡面了, 說明元素不在快照裡面
                if (current[i] != snapshot[i] && eq(e, current[i]))
                    return false;
            if (indexOf(e, current, common, len) >= 0)
                    return false;
        }
        // 拷貝一份n+1的陣列
        Object[] newElements = Arrays.copyOf(current, len + 1);
        // 將元素放在最後一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}
  1. 檢查這個元素是否存在於陣列快照中；
  2. 如果存在直接返回 false，如果不存在呼叫addIfAbsent(E e, Object[] snapshot)處理;
  3. 加鎖；
  4. 如果當前陣列不等於傳入的快照，說明有修改，檢查待新增的元素是否存在於當前陣列中，如果存在直接返回false;
  5. 拷貝一個新陣列，長度等於原陣列長度加1，並把原陣列元素拷貝到新陣列中；
  6. 把新元素新增到陣列最後一位；
  7. 把新陣列賦值給當前物件的array屬性，覆蓋原陣列；
  8. 解鎖；

get(int index)

獲取指定索引的元素，支援隨機訪問，時間複雜度為O(1)。

public E get(int index) {
    // 獲取元素不需要加鎖
    // 直接返回index位置的元素
    // 這裡是沒有做越界檢查的, 因為陣列本身會做越界檢查
    return get(getArray(), index);
}

final Object[] getArray() {
    return array;
}

private E get(Object[] a, int index) {
    return (E) a[index];
}
  1. 獲取元素陣列；
  2. 返回陣列指定索引位置的元素；

remove(int index)方法

刪除指定索引位置的元素。

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;
        if (numMoved == 0)
            // 如果移除的是最後一位
            // 那麼直接拷貝一份n-1的新陣列, 最後一位就自動刪除了
            setArray(Arrays.copyOf(elements, len - 1));
        else {
            // 如果移除的不是最後一位
            // 那麼新建一個n-1的新陣列
            Object[] newElements = new Object[len - 1];
            // 將前index的元素拷貝到新陣列中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 將index後面(不包含)的元素往前挪一位
            // 這樣正好把index位置覆蓋掉了, 相當於刪除了
            System.arraycopy(elements, index + 1, newElements, index,
                             numMoved);
            setArray(newElements);
        }
        return oldValue;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}
  1. 加鎖；
  2. 獲取指定索引位置元素的舊值；
  3. 如果移除的是最後一位元素，則把原陣列的前len-1個元素拷貝到新陣列中，並把新陣列賦值給當前物件的陣列屬性；
  4. 如果移除的不是最後一位元素，則新建一個len-1長度的陣列，並把原陣列除了指定索引位置的元素全部拷貝到新陣列中，並把新陣列賦值給當前物件的陣列屬性；
  5. 解鎖並返回舊值；

size()方法

返回陣列的長度。

public int size() {
    // 獲取元素個數不需要加鎖
    // 直接返回陣列的長度
    return getArray().length;
}

提問

為什麼CopyOnWriteArrayList沒有size屬性？

因為每次修改都是拷貝一份正好可以儲存目標個數元素的陣列，所以不需要size屬性了，陣列的長度就是集合的大小，而不像ArrayList陣列的長度實際是要大於集合的大小的。比如，add(E e)操作，先拷貝一份n+1個元素的陣列，再把新元素放到新陣列的最後一位，這時新陣列的長度為len+1了，也就是集合的size了。

總結

  1. CopyOnWriteArrayList使用ReentrantLock重入鎖加鎖，保證執行緒安全；
  2. CopyOnWriteArrayList的寫操作都要先拷貝一份新陣列，在新陣列中做修改，修改完了再用新陣列替換老陣列，所以空間複雜度是O(n)，效能比較低下；
  3. CopyOnWriteArrayList的讀操作支援隨機訪問，時間複雜度為O(1)；
  4. CopyOnWriteArrayList採用讀寫分離的思想，讀操作不加鎖，寫操作加鎖，且寫操作佔用較大記憶體空間，所以適用於讀多寫少的場合；
  5. CopyOnWriteArrayList只保證最終一致性，不保證實時一致性。

相關文章