JDK的並發List之CopyOnWriteArrayList
1.介紹
CopyOnWriteArrayList是一個線程安全的ArrayList，它的寫操作都是在底層的一個復制數組（快照）中進行的，也就是使用了寫時復制策略。
什么是寫時復制策略？
通俗易用地講，不同進程訪問同一資源的時候，只有在寫操作，才會復制一份新的數據，否則都是訪問同一資源。
每個CopyOnWriteArrayList對象中，都有一個array對象來存放具體的元素，ReentrantLock獨占鎖對象用來保證同一時刻只有一個線程對array進行修改。
2.主要方法源碼解析
2.1 構造函數
無參構造函數，內部創建了一個大小為0的Object數組，作為array的初始值。
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
再來看有參構造函數。
/**
* 入參為集合，將集合里面的元素復制到新的數組，把array的引用指向新的數組
*/
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));
}
2.2 添加元素
public boolean add(E e) {
// 1.首先去獲取獨占鎖
final ReentrantLock lock = this.lock;
lock.lock();
try {
// 2.獲取array
Object[] elements = getArray();
// 3.復制到新的數組newElements，添加元素到新數組
int len = elements.length;
Object[] newElements = Arrays.copyOf(elements, len + 1);
newElements[len] = e;
// 4.使用新數組替換原來的數組
setArray(newElements);
return true;
} finally {
// 5.釋放鎖
lock.unlock();
}
}
- 如果同一時刻有多個線程調用add方法，則只有一個線程能獲取到該鎖，其他線程會被阻塞掛起直到鎖釋放。
- 新數組的大小 = 原數組大小 + 1，所以CopyOnWriteArrayList是無界list。
- 保證添加元素的時候是一個原子性操作。
- 需要注意的是，在添加元素的時候，首先復制了一個快照，再在快照的基礎上添加一個元素，而不是在原來的數組上進行。
2.3 獲取指定的元素位置
public E get(int index) {
return get(getArray(), index);
}
final Object[] getArray() {
return array;
}
private E get(Object[] a, int index) {
return (E) a[index];
}
當某個線程調用get方法獲取指定位置的元素時，有兩步操作：
1.會首先獲取array
2.再通過下標訪問指定位置的元素
在這個過程中並沒有加鎖同步。可以假設有這個場景，有x、y兩個線程，x執行get方法，當x在執行完步驟1后步驟2前。
此時，y線程進來了，y線程要進行remove操作，當然就是獲取鎖進行寫時復制，復制一份新的數組，刪除此數組后，把array指向新數組。
但是，這個時候x線程讀取到的還是原來舊的數組，這種情況，就是寫時復制策略產生的弱一致性問題。
2.4 修改指定的元素
public E set(int index, E element) {
final ReentrantLock lock = this.lock;
lock.lock();
try {
Object[] elements = getArray();
E oldValue = get(elements, index);
if (oldValue != element) {
int len = elements.length;
Object[] newElements = Arrays.copyOf(elements, len);
newElements[index] = element;
setArray(newElements);
} else {
// Not quite a no-op; ensures volatile write semantics
setArray(elements);
}
return oldValue;
} finally {
lock.unlock();
}
}
跟上面的方法一樣，也是先拿到獨占鎖，調用get方法獲取指定元素的位置，如果得到的值與新值不一樣，則復制一個新數組，把元素設置到新數組中，並讓array指向新數組。
如果新值等於舊值，為了保證volatile語義，還是需要重新設置array，雖然array的內容沒有改變。
2.5 刪除元素
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)
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();
}
}
沒什么特別的，首先拿到要刪除元素的值，判斷是否是刪除最后一個元素，是的話，則直接拷貝0~len-1的數組，否則，新建一個長度為len-1的數組，分兩次復制刪除后剩余的數組。
2.6 弱一致性的迭代器
public Iterator<E> iterator() {
return new COWIterator<E>(getArray(), 0);
}
static final class COWIterator<E> implements ListIterator<E> {
/** Snapshot of the array */
private final Object[] snapshot;
/** Index of element to be returned by subsequent call to next. */
private int cursor;
private COWIterator(Object[] elements, int initialCursor) {
cursor = initialCursor;
snapshot = elements;
}
public boolean hasNext() {
return cursor < snapshot.length;
}
public boolean hasPrevious() {
return cursor > 0;
}
@SuppressWarnings("unchecked")
public E next() {
if (! hasNext())
throw new NoSuchElementException();
return (E) snapshot[cursor++];
}
@SuppressWarnings("unchecked")
public E previous() {
if (! hasPrevious())
throw new NoSuchElementException();
return (E) snapshot[--cursor];
}
public int nextIndex() {
return cursor;
}
public int previousIndex() {
return cursor-1;
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code remove}
* is not supported by this iterator.
*/
public void remove() {
throw new UnsupportedOperationException();
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code set}
* is not supported by this iterator.
*/
public void set(E e) {
throw new UnsupportedOperationException();
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code add}
* is not supported by this iterator.
*/
public void add(E e) {
throw new UnsupportedOperationException();
}
@Override
public void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
Object[] elements = snapshot;
final int size = elements.length;
for (int i = cursor; i < size; i++) {
@SuppressWarnings("unchecked") E e = (E) elements[i];
action.accept(e);
}
cursor = size;
}
}
當調用iterator()方法獲取迭代器的時候，實際上會返回一個COWIterator對象，COWIterator對象的snapshot變量保存了當前list的內容，cursor是遍歷list時數據的下標。
這里我們看到明明snapshot是引用，而不是快照。是因為如果在遍歷的期間，其他線程對該list進行了寫操作，那么snapshot實際上就是快照，因為寫操作完成后，list里面就是新的數組，但是此時老數組還是被snapshot引用。
其他線程對該list的寫操作是不可見的，因為他們操作的是不同數組，這就是弱一致性。
可以通過以下的一個例子去驗證
public class CopyTest {
private static volatile CopyOnWriteArrayList<Integer> list = new CopyOnWriteArrayList<Integer>();
public static void main(String[] args) throws Exception {
list.add(1);
list.add(2);
list.add(3);
list.add(4);
list.add(5);
Thread t = new Thread(() -> {
list.set(1, 100);
});
// 啟動線程前，先去獲取該list的迭代器
Iterator<Integer> iterator = list.iterator();
t.start();
// 等待t執行完畢
t.join();
while (iterator.hasNext()) {
System.out.println(iterator.next());
}
}
}
輸出：
1
2
3
4
5
子線程t進行的操作，從輸出的結果來看，一個都沒有生效，因為父線程獲取的是舊的數組。
3.總結
CopyOnWriteArrayList使用寫時復制策略來保證List的一致性，而獲取獲取->修改->寫入這三步操作並不是原子性，所以在寫操作的時候使用了獨占鎖，來保證某段時間只有一個線程來操作list。另外，CopyOnWriteArrayList提供了弱一致性的迭代器，保證獲取迭代器后，其他線程對list的修改是不可見的，迭代器遍歷的數組是一個快照。