死磕 java集合之CopyOnWriteArrayList源碼分析

歡迎關注我的公眾號“彤哥讀源碼”，查看更多源碼系列文章, 與彤哥一起暢游源碼的海洋。

簡介

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

繼承體系

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;

（1）lock

用于修改時加鎖，使用transient修飾表示不自動序列化。

（2）array

真正存儲元素的地方，使用transient修飾表示不自動序列化，使用volatile修飾表示一個線程對這個字段的修改另外一個線程立即可見。

問題：為啥沒有size字段？且聽后續分解。

CopyOnWriteArrayList()構造方法

創建空數組。

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

final void setArray(Object[] a) {
    array = a;
}

CopyOnWriteArrayList(Collection<? extends E> c)構造方法

如果c是CopyOnWriteArrayList類型，直接把它的數組賦值給當前list的數組，注意這里是淺拷貝，兩個集合共用同一個數組。

如果c不是CopyOnWriteArrayList類型，則進行拷貝把c的元素全部拷貝到當前list的數組中。

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);
}

CopyOnWriteArrayList(E[] toCopyIn)構造方法

把toCopyIn的元素拷貝給當前list的數組。

public CopyOnWriteArrayList(E[] toCopyIn) {
    setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}

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;
}

總結

（1）CopyOnWriteArrayList使用ReentrantLock重入鎖加鎖，保證線程安全；

（2）CopyOnWriteArrayList的寫操作都要先拷貝一份新數組，在新數組中做修改，修改完了再用新數組替換老數組，所以空間復雜度是O(n)，性能比較低下；

（3）CopyOnWriteArrayList的讀操作支持隨機訪問，時間復雜度為O(1)；

（4）CopyOnWriteArrayList采用讀寫分離的思想，讀操作不加鎖，寫操作加鎖，且寫操作占用較大內存空間，所以適用于讀多寫少的場合；

（5）CopyOnWriteArrayList只保證最終一致性，不保證實時一致性；

彩蛋

為什么CopyOnWriteArrayList沒有size屬性？

因為每次修改都是拷貝一份正好可以存儲目標個數元素的數組，所以不需要size屬性了，數組的長度就是集合的大小，而不像ArrayList數組的長度實際是要大于集合的大小的。

比如，add(E e)操作，先拷貝一份n+1個元素的數組，再把新元素放到新數組的最后一位，這時新數組的長度為len+1了，也就是集合的size了。

歡迎關注我的公眾號“彤哥讀源碼”，查看更多源碼系列文章, 與彤哥一起暢游源碼的海洋。