java中CopyOnWriteArrayList源碼的示例分析

這篇文章將為大家詳細(xì)講解有關(guān)java中CopyOnWriteArrayList源碼的示例分析，小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲。

簡(jiǎn)介

CopyOnWriteArrayList是ArrayList的線程安全版本，內(nèi)部也是通過(guò)數(shù)組實(shí)現(xiàn)，每次對(duì)數(shù)組的修改都完全拷貝一份新的數(shù)組來(lái)修改，修改完了再替換掉老數(shù)組，這樣保證了只阻塞寫操作，不阻塞讀操作，實(shí)現(xiàn)讀寫分離。

繼承體系

public class CopyOnWriteArrayList<E>
    implements List<E>, RandomAccess, Cloneable, java.io.Serializable 
    {...}

• CopyOnWriteArrayList實(shí)現(xiàn)了List，RandomAccess，Cloneable，java.io.Serializable等接口。

• CopyOnWriteArrayList實(shí)現(xiàn)了List，提供了基礎(chǔ)的添加、刪除、遍歷等操作。

• CopyOnWriteArrayList實(shí)現(xiàn)了RandomAccess，提供了隨機(jī)訪問(wèn)的能力。

• CopyOnWriteArrayList實(shí)現(xiàn)了Cloneable，可以被克隆。

• CopyOnWriteArrayList實(shí)現(xiàn)了Serializable，可以被序列化。

源碼解析

屬性

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

/** 真正存儲(chǔ)元素的地方，只能通過(guò)getArray()/setArray()訪問(wèn) */
private transient volatile Object[] array;

• lock：修改時(shí)加鎖，使用transient修飾表示不自動(dòng)序列化。

• array：存儲(chǔ)元素的地方，使用transient修飾表示不自動(dòng)序列化，使用volatile修飾表示一個(gè)線程對(duì)這個(gè)字段的修改另外一個(gè)線程立即可見。

構(gòu)造方法

創(chuàng)建空數(shù)組。

public CopyOnWriteArrayList() {
    // 所有對(duì)array的操作都是通過(guò)setArray()和getArray()進(jìn)行
    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類型
        // 那么直接把它的數(shù)組拿過(guò)來(lái)使用
        elements = ((CopyOnWriteArrayList<?>)c).getArray();
    else {
        // 否則調(diào)用其toArray()方法將集合元素轉(zhuǎn)化為數(shù)組
        elements = c.toArray();
        // 這里c.toArray()返回的不一定是Object[]類型
        // 詳細(xì)原因見ArrayList里面的分析
        if (elements.getClass() != Object[].class)
            elements = Arrays.copyOf(elements, elements.length, Object[].class);
    }
    setArray(elements);
}

• 如果 c 是CopyOnWriteArrayList類型，直接把它的數(shù)組賦值給當(dāng)前l(fā)ist的數(shù)組，注意這里是淺拷貝，兩個(gè)集合共用同一個(gè)數(shù)組。

• 如果 c 不是CopyOnWriteArrayList類型，則進(jìn)行拷貝把c的元素全部拷貝到當(dāng)前l(fā)ist的數(shù)組中。

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

• 把toCopyIn的元素拷貝給當(dāng)前l(fā)ist的數(shù)組。

add(E e)方法

添加一個(gè)元素到末尾。

public boolean add(E e) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 獲取舊數(shù)組
        Object[] elements = getArray();
        int len = elements.length;
        // 將舊數(shù)組元素拷貝到新數(shù)組中
        // 新數(shù)組大小是舊數(shù)組大小加1
        Object[] newElements = Arrays.copyOf(elements, len + 1);
        // 將元素放在最后一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

• 加鎖；

• 獲取元素?cái)?shù)組；

• 新建一個(gè)數(shù)組，大小為原數(shù)組長(zhǎng)度加1，并把原數(shù)組元素拷貝到新數(shù)組；

• 把新添加的元素放到新數(shù)組的末尾；

• 把新數(shù)組賦值給當(dāng)前對(duì)象的array屬性，覆蓋原數(shù)組；

• 解鎖。

add(int index, E element)方法

添加一個(gè)元素在指定索引處。

public void add(int index, E element) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 獲取舊數(shù)組
        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)
            // 如果插入的位置是最后一位
            // 那么拷貝一個(gè)n+1的數(shù)組, 其前n個(gè)元素與舊數(shù)組一致
            newElements = Arrays.copyOf(elements, len + 1);
        else {
            // 如果插入的位置不是最后一位
            // 那么新建一個(gè)n+1的數(shù)組
            newElements = new Object[len + 1];
            // 拷貝舊數(shù)組前index的元素到新數(shù)組中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 將index及其之后的元素往后挪一位拷貝到新數(shù)組中
            // 這樣正好index位置是空出來(lái)的
            System.arraycopy(elements, index, newElements, index + 1,
                             numMoved);
        }
        // 將元素放置在index處
        newElements[index] = element;
        setArray(newElements);
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

• 加鎖；

• 檢查索引是否合法，如果不合法拋出IndexOutOfBoundsException異常，注意這里 index 等于 len 也是合法的；

• 如果索引等于數(shù)組長(zhǎng)度（也就是數(shù)組最后一位再加1），那就拷貝一個(gè)len+1的數(shù)組；

• 如果索引不等于數(shù)組長(zhǎng)度，那就新建一個(gè)len+1的數(shù)組，并按索引位置分成兩部分，索引之前（不包含）的部分拷貝到新數(shù)組索引之前（不包含）的部分，索引之后（包含）的位置拷貝到新數(shù)組索引之后（不包含）的位置，索引所在位置留空；

• 把索引位置賦值為待添加的元素；

• 把新數(shù)組賦值給當(dāng)前對(duì)象的array屬性，覆蓋原數(shù)組；

• 解鎖；

addIfAbsent(E e)方法

添加一個(gè)元素如果這個(gè)元素不存在于集合中。

public boolean addIfAbsent(E e) {
    // 獲取元素?cái)?shù)組, 取名為快照
    Object[] snapshot = getArray();
    // 檢查如果元素不存在,直接返回false
    // 如果存在再調(diào)用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 {
        // 重新獲取舊數(shù)組
        Object[] current = getArray();
        int len = current.length;
        // 如果快照與剛獲取的數(shù)組不一致
        // 說(shuō)明有修改
        if (snapshot != current) {
            // 重新檢查元素是否在剛獲取的數(shù)組里
            int common = Math.min(snapshot.length, len);
            for (int i = 0; i < common; i++)
                // 到這個(gè)方法里面了, 說(shuō)明元素不在快照里面
                if (current[i] != snapshot[i] && eq(e, current[i]))
                    return false;
            if (indexOf(e, current, common, len) >= 0)
                    return false;
        }
        // 拷貝一份n+1的數(shù)組
        Object[] newElements = Arrays.copyOf(current, len + 1);
        // 將元素放在最后一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

• 檢查這個(gè)元素是否存在于數(shù)組快照中；

• 如果存在直接返回 false，如果不存在調(diào)用addIfAbsent(E e, Object[] snapshot)處理;

• 加鎖；

• 如果當(dāng)前數(shù)組不等于傳入的快照，說(shuō)明有修改，檢查待添加的元素是否存在于當(dāng)前數(shù)組中，如果存在直接返回false;

• 拷貝一個(gè)新數(shù)組，長(zhǎng)度等于原數(shù)組長(zhǎng)度加1，并把原數(shù)組元素拷貝到新數(shù)組中；

• 把新元素添加到數(shù)組最后一位；

• 把新數(shù)組賦值給當(dāng)前對(duì)象的array屬性，覆蓋原數(shù)組；

• 解鎖；

get(int index)

獲取指定索引的元素，支持隨機(jī)訪問(wèn)，時(shí)間復(fù)雜度為O(1)。

public E get(int index) {
    // 獲取元素不需要加鎖
    // 直接返回index位置的元素
    // 這里是沒(méi)有做越界檢查的, 因?yàn)閿?shù)組本身會(huì)做越界檢查
    return get(getArray(), index);
}

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

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

• 獲取元素?cái)?shù)組；

• 返回?cái)?shù)組指定索引位置的元素；

remove(int index)方法

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

public E remove(int index) {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 獲取舊數(shù)組
        Object[] elements = getArray();
        int len = elements.length;
        E oldValue = get(elements, index);
        int numMoved = len - index - 1;
        if (numMoved == 0)
            // 如果移除的是最后一位
            // 那么直接拷貝一份n-1的新數(shù)組, 最后一位就自動(dòng)刪除了
            setArray(Arrays.copyOf(elements, len - 1));
        else {
            // 如果移除的不是最后一位
            // 那么新建一個(gè)n-1的新數(shù)組
            Object[] newElements = new Object[len - 1];
            // 將前index的元素拷貝到新數(shù)組中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 將index后面(不包含)的元素往前挪一位
            // 這樣正好把index位置覆蓋掉了, 相當(dāng)于刪除了
            System.arraycopy(elements, index + 1, newElements, index,
                             numMoved);
            setArray(newElements);
        }
        return oldValue;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

• 加鎖；

• 獲取指定索引位置元素的舊值；

• 如果移除的是最后一位元素，則把原數(shù)組的前l(fā)en-1個(gè)元素拷貝到新數(shù)組中，并把新數(shù)組賦值給當(dāng)前對(duì)象的數(shù)組屬性；

• 如果移除的不是最后一位元素，則新建一個(gè)len-1長(zhǎng)度的數(shù)組，并把原數(shù)組除了指定索引位置的元素全部拷貝到新數(shù)組中，并把新數(shù)組賦值給當(dāng)前對(duì)象的數(shù)組屬性；

• 解鎖并返回舊值；

size()方法

返回?cái)?shù)組的長(zhǎng)度。

public int size() {
    // 獲取元素個(gè)數(shù)不需要加鎖
    // 直接返回?cái)?shù)組的長(zhǎng)度
    return getArray().length;
}

提問(wèn)

為什么CopyOnWriteArrayList沒(méi)有size屬性？

因?yàn)槊看涡薷亩际强截愐环菡每梢源鎯?chǔ)目標(biāo)個(gè)數(shù)元素的數(shù)組，所以不需要size屬性了，數(shù)組的長(zhǎng)度就是集合的大小，而不像ArrayList數(shù)組的長(zhǎng)度實(shí)際是要大于集合的大小的。比如，add(E e)操作，先拷貝一份n+1個(gè)元素的數(shù)組，再把新元素放到新數(shù)組的最后一位，這時(shí)新數(shù)組的長(zhǎng)度為len+1了，也就是集合的size了。

總結(jié)

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

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

• CopyOnWriteArrayList的讀操作支持隨機(jī)訪問(wèn)，時(shí)間復(fù)雜度為O(1)；

• CopyOnWriteArrayList采用讀寫分離的思想，讀操作不加鎖，寫操作加鎖，且寫操作占用較大內(nèi)存空間，所以適用于讀多寫少的場(chǎng)合；

• CopyOnWriteArrayList只保證最終一致性，不保證實(shí)時(shí)一致性。

關(guān)于“java中CopyOnWriteArrayList源碼的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，使各位可以學(xué)到更多知識(shí)，如果覺得文章不錯(cuò)，請(qǐng)把它分享出去讓更多的人看到。