一、簡介
CopyOnWriteArrayList 是ArrayList的線程線程安全版本,其主要是通過volitle 修飾數組本事保證寫操作對其他線程可見性,寫操作是使用ReentrantLock加鎖,每次對數組的寫操作,都完全拷貝一份新的數組來修改,修改完了再替換掉老數組,這樣保證了只阻塞寫操作,不阻塞讀操作,實現讀寫分離。
二、繼承體系
public class CopyOnWriteArrayList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable {}
CopyOnWriteArrayList實現了List接口、RandomAccess(可隨機訪問)、Cloneable(可拷貝)、Serializable(可序列化)。
三、重要字段
/** The lock protecting all mutators */
//用於寫操作加鎖,使用transient修飾表示不自動序列化。
final transient ReentrantLock lock = new ReentrantLock();
/** The array, accessed only via getArray/setArray. */
//存儲元素的地方,使用volatile修飾表示保證了寫操作對其他線程的可見性,
private transient volatile Object[] array;
四、構造函數
4.1、CopyOnWriteArrayList()
這裏有對數組的set,get方法,所有對數組的操作都基於get,set方法
final Object[] getArray() {
return array;
}
final void setArray(Object[] a) {
array = a;
}
創建空數組,把他賦值給CopyOnWriteArrayList
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
4.2、CopyOnWriteArrayList(Collection<? extends E> c)
public CopyOnWriteArrayList(Collection<? extends E> c) {
Object[] elements;
//如果c也是CopyOnWriteArrayList直接拿到他的數組進行賦值
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.toArray()返回的不一定是Object[]類型,具體可以查看jdk bug單 (單號6260652),這個bug jdk9已經解決.
地址爲 https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6260652
4.3、 CopyOnWriteArrayList(E[] toCopyIn)
public CopyOnWriteArrayList(E[] toCopyIn) {
setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
五、重要的方法
5.1、add(E e)方法
public boolean add(E e) {
final ReentrantLock lock = this.lock;
//加鎖
lock.lock();
try {
//獲取久的數組
Object[] elements = getArray();
int len = elements.length;
//將舊數組copy到新數組中,新數組的長度爲舊數組長度+1
Object[] newElements = Arrays.copyOf(elements, len + 1);
//把新加入的元素放在最後一位
newElements[len] = e;
//把新數組賦值給List
setArray(newElements);
return true;
} finally {
//解鎖
lock.unlock();
}
}
(1)加鎖;
(2)獲取元素數組;
(3)新建一個數組,大小爲原數組長度加1,並把原數組元素拷貝到新數組;
(4)把新添加的元素放到新數組的末尾;
(5)把新數組賦值給當前對象的array屬性,覆蓋原數組;
(6)解鎖
5.2、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;
//檢查是否越界
if (index > len || index < 0)
throw new IndexOutOfBoundsException("Index: "+index+
", Size: "+len);
Object[] newElements;
//移動元素的個數
int numMoved = len - index;
//爲0代表插入的位置是最後一位
if (numMoved == 0)
//拷貝數組給新數組,新數組的長度是老數組的長度+1
newElements = Arrays.copyOf(elements, len + 1);
else {
//新建一個數組其長度是老數組的長度+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;
//將數組賦值給List
setArray(newElements);
} finally {
//解鎖
lock.unlock();
}
}
(1)加鎖;
(2)檢查索引是否合法,注意這裏index等於len也是合法的;
(3)如果索引等於數組長度(也就是數組最後一位再加1),那就拷貝一個len+1的數組;
(4)如果索引不等於數組長度,那就新建一個len+1的數組,並按索引位置分成兩部分,索引之前(不包含)的部分拷貝到新數組索引之前(不包含)的部分,索引之後(包含)的位置拷貝到新數組索引之後(不包含)的位置,索引所在位置留空;
(5)把索引位置賦值爲待添加的元素;
(6)把新數組賦值給當前對象的array屬性,覆蓋原數組;
(7)解鎖;
5.3、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) {
// 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();
}
}
(1)檢查這個元素是否存在於數組快照中;
(2)如果存在直接返回false,如果不存在調用addIfAbsent(E e, Object[] snapshot)處理;
(3)加鎖;
(4)如果當前數組不等於傳入的快照,說明有修改,檢查待添加的元素是否存在於當前數組中,如果存在直接返回false;
(5)拷貝一個新數組,長度等於原數組長度加1,並把原數組元素拷貝到新數組中;
(6)把新元素添加到數組最後一位;
(7)把新數組賦值給當前對象的array屬性,覆蓋原數組;
(8)解鎖;
5.4、get(int index)
public E get(int index) {
return get(getArray(), index);
}
@SuppressWarnings("unchecked")
private E get(Object[] a, int index) {
return (E) a[index];
}
(1)獲取元素數組;
(2)返回數組指定索引位置的元素;
5.5、remove(int index)方法
public E remove(int index) {
final ReentrantLock lock = this.lock;
//加鎖
lock.lock();
try {
//獲取老數組
Object[] elements = getArray();
int len = elements.length;
//獲取老數組index位置的元素
E oldValue = get(elements, index);
//移動元素的個數
int numMoved = len - index - 1;
//刪除的是最後一位元素
if (numMoved == 0)
//copy老數組到新數組中,拷貝長度爲len-1,相當於刪除最後一位元素
setArray(Arrays.copyOf(elements, len - 1));
else {
//老一套,利用arraycopy方法完成元素的移除
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();
}
}
(1)加鎖;
(2)獲取指定索引位置元素的舊值;
(3)如果移除的是最後一位元素,則把原數組的前len-1個元素拷貝到新數組中,並把新數組賦值給當前對象的數組屬性;
(4)如果移除的不是最後一位元素,則新建一個len-1長度的數組,並把原數組除了指定索引位置的元素全部拷貝到新數組中,並把新數組賦值給當前對象的數組屬性;
(5)解鎖並返回舊值;
5.6、size()方法
public int size() {
return getArray().length;
}
爲什麼CopyOnWriteArrayList沒有size屬性?
因爲每次修改都是拷貝一份正好可以存儲目標個數元素的數組,所以不需要size屬性了,數組的長度就是集合的大小,而不像ArrayList數組的長度實際是要大於集合的大小的。
比如,add(E e)操作,先拷貝一份n+1個元素的數組,再把新元素放到新數組的最後一位,這時新數組的長度爲len+1了,也就是集合的size了。