一、簡介
CopyOnWriteArrayList是ArrayList的線程安全版本，內部也是通過數組實現，每次對數組的修改都完全拷貝一份新的數組來修改，修改完了再替換掉老數組，這樣保證了只阻塞寫操作，不阻塞讀操作，實現讀寫分離。
二、繼承體系
- CopyOnWriteArrayList實現了List, RandomAccess, Cloneable, java.io.Serializable等接口。
- CopyOnWriteArrayList實現了List，提供了基礎的添加、刪除、遍歷等操作。
- CopyOnWriteArrayList實現了RandomAccess，提供了隨機訪問的能力。
- CopyOnWriteArrayList實現了Cloneable，可以被克隆。
- CopyOnWriteArrayList實現了Serializable，可以被序列化。
三、源碼分析
3.1 屬性
/** The lock protecting all mutators */
final transient ReentrantLock lock = new ReentrantLock();
/** The array, accessed only via getArray/setArray. */
private transient volatile Object[] array;
- 用於修改時加鎖，使用transient修飾表示不自動序列化。
- array：真正存儲元素的地方，使用transient修飾表示不自動序列化，使用volatile修飾表示一個線程對這個字段的修改另外一個線程立即可見。
3.2 CopyOnWriteArrayList()構造方法
創建空數組。
/**
* Creates an empty list.
*/
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
CopyOnWriteArrayList(Collection c)構造方法
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);
}
如果c是CopyOnWriteArrayList類型，直接把它的數組賦值給當前list的數組，注意這裏是淺拷貝，兩個集合共用同一個數組。
如果c不是CopyOnWriteArrayList類型，則進行拷貝把c的元素全部拷貝到當前list的數組中。
CopyOnWriteArrayList(E[] toCopyIn)構造方法：把toCopyIn的元素拷貝給當前list的數組。
public CopyOnWriteArrayList(E[] toCopyIn) {
setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
/**
* Sets the array.
*/
final void setArray(Object[] a) {
array = a;
}
add(E e)方法
添加一個元素到末尾。
/**
* Appends the specified element to the end of this list.
*
* @param e element to be appended to this list
* @return {@code true} (as specified by {@link Collection#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();
}
}
- 加鎖；
- 獲取元素數組；
- 新建一個數組，大小爲原數組長度加1，並把原數組元素拷貝到新數組
- 把新添加的元素放到新數組的末尾；
- 把新數組賦值給當前對象的array屬性，覆蓋原數組；
- 解鎖；
add(int index, E element)方法
/**
* Inserts the specified element at the specified position in this
* list. Shifts the element currently at that position (if any) and
* any subsequent elements to the right (adds one to their indices).
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
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();
}
}
- 加鎖；
- 檢查索引是否合法，如果不合法拋出IndexOutOfBoundsException異常，注意這裏index等於len也是合法的；
- 如果索引等於數組長度（也就是數組最後一位再加1），那就拷貝一個len+1的數組；
- 如果索引不等於數組長度，那就新建一個len+1的數組，並按索引位置分成兩部分，索引之前（不包含）的部分拷貝到新數組索引之前（不包含）的部分，索引之後（包含）的位置拷貝到新數組索引之後（不包含）的位置，索引所在位置留空；
- 把索引位置賦值爲待添加的元素；
- 把新數組賦值給當前對象的array屬性，覆蓋原數組；
- 解鎖；
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);
}
/**
* A version of addIfAbsent using the strong hint that given
* recent snapshot does not contain e.
*/
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) {
// 重新檢查元素是否在剛獲取的數組裏
// Optimize for lost race to another addXXX operation
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();
}
}
- 檢查這個元素是否存在於數組快照中；
- 如果存在直接返回false，如果不存在調用addIfAbsent(E e, Object[] snapshot)處理;
- 加鎖；
- 如果當前數組不等於傳入的快照，說明有修改，檢查待添加的元素是否存在於當前數組中，如果存在直接返回false;
- 拷貝一個新數組，長度等於原數組長度加1，並把原數組元素拷貝到新數組中；
- 把新元素添加到數組最後一位；
- 把新數組賦值給當前對象的array屬性，覆蓋原數組；
- 解鎖；
get(int index):獲取指定索引的元素，支持隨機訪問，時間複雜度爲O(1)。
public E get(int index) {
// 獲取元素不需要加鎖
// 直接返回index位置的元素
// 這裏是沒有做越界檢查的, 因爲數組本身會做越界檢查
return get(getArray(), index);
}
- 獲取元素數組；
- 返回數組指定索引位置的元素；
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;
// 如果移除的是最後一位
// 那麼直接拷貝一份n-1的新數組, 最後一位就自動刪除了
if (numMoved == 0)
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();
}
}
- 加鎖；
- 獲取指定索引位置元素的舊值；
- 如果移除的是最後一位元素，則把原數組的前len-1個元素拷貝到新數組中，並把新數組賦值給當前對象的數組屬性；
- 如果移除的不是最後一位元素，則新建一個len-1長度的數組，並把原數組除了指定索引位置的元素全部拷貝到新數組中，並把新數組賦值給當前對象的數組屬性；
- 解鎖並返回舊值；
size()方法：返回數組的長度。
/**
* Returns the number of elements in this list.
*
* @return the number of elements in this list
*/
public int size() {
return getArray().length;
}
四、總結
- CopyOnWriteArrayList使用ReentrantLock重入鎖加鎖，保證線程安全；
- CopyOnWriteArrayList的寫操作都要先拷貝一份新數組，在新數組中做修改，修改完了再用新數組替換老數組，所以空間複雜度是O(n)，性能比較低下；
- CopyOnWriteArrayList的讀操作支持隨機訪問，時間複雜度爲O(1)；
- CopyOnWriteArrayList採用讀寫分離的思想，讀操作不加鎖，寫操作加鎖，且寫操作佔用較大內存空間，所以適用於讀多寫少的場合；
- CopyOnWriteArrayList只保證最終一致性，不保證實時一致性