JDK集合源码之CopyOnWriteArrayList解析
CopyOnWriteArrayList简介
CopyOnWriteArrayList是ArrayList的线程安全版本，内部也是通过数组实现，每次对数组的修改都完全拷贝一份新的数组来修改，修改完了再替换掉老数组，这样保证了只阻塞写操作，不阻塞读操作，实现读写分离。
CopyOnWriteArrayList继承体系
从继承体系中得出：
- CopyOnWriteArrayList实现了List、RandomAccess、Cloneable、java.io.Serializable等接口
- CopyOnWriteArrayList实现了List，提供了基础的添加、删除、遍历等操作。
- CopyOnWriteArrayList实现了RandomAccess，提供了随机访问的能力。
- CopyOnWriteArrayList实现了Cloneable，可以被克隆。
- CopyOnWriteArrayList实现了Serializable，可以被序列化。
CopyOnWriteArrayList源码解析
//序列化版本号
private static final long serialVersionUID = 8673264195747942595L;
//ReentrantLock可重入锁，用于修改内部数组结构的时候加锁
final transient ReentrantLock lock = new ReentrantLock();
//真正存储元素的地方，只能通过getArray()/setArray()访问
private transient volatile Object[] array;
-
lock用于修改的时候加锁，使用transient修饰表示不自动被序列化
-
array真正存储元素的地方，使用transient修饰表示不自动序列化，使用volatile修饰表示一个线程对这个字段的修改另外以恶搞线程立即可见。
问题：为什么没有size字段？文章最后会介绍
构造方法
final void setArray(Object[] a) {
array = a;
}
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
/**
* CopyOnWriteArrayList(Collection<? extends E> c)构造方法
* 如果c 是CopyOnWriteArrayList类型，直接把它的数组赋值给当前list的数组
* 注意：这里是浅拷贝，两个集合共用一个数组
* 如果c不说CopyOnWriteArrayList类型，则进行拷贝把c的元素全部拷贝给当前list的数组中
* @param c
*/
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[]类型的数据
if (elements.getClass() != Object[].class)
//则将数组中的数据全部拷贝为Object类型的数据
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）方法
/**
* 添加一个元素到末尾
* @param e
* @return
*/
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，并把原数组元素拷贝到新数组中
- 把新添加的元素放入到新数组的末尾
- 把新数组赋值给当前对象的array属性，覆盖原数组
- 解锁
add（int index,E element）方法
/**
* 添加一个元素在指定索引处
* @param index 指定索引位置
* @param 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) //说明要添加在末尾
//如果插入的位置是最后一位
//那么拷贝一个长度为len+1的数组，其前len个元素与旧数组一致
newElements = Arrays.copyOf(elements, len + 1);
else {
//如果插入的位置不是最后一位
//那么新建一个len+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）方法
/**
* 添加一个元素如果这个元素不存在于集合中
* @param e
* @return
*/
public boolean addIfAbsent(E e) {
//获取元素数组，取名为快照
//只保证最终一致性，不保证实时一致性
Object[] snapshot = getArray();
//检查如果元素存在，直接返回false
//如果不存在再调用addIfAbsent()方法添加元素
return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
addIfAbsent(e, snapshot);
}
/**
* 向集合中添加集合中不存在的元素
* @param e
* @param snapshot
* @return
*/
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;
}
//拷贝一份长度为len+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）
private E get(Object[] a, int index) {
return (E) a[index];
}
/**
* 获取指定索引的元素，支持随机访问，时间复杂度为1
* @param index
* @return
*/
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;
//获取旧数组当前index位置的元素的值，用于删除成功后将该oldValue返回
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();
}
}
步骤：
- 加锁
- 获取指定索引位置元素的旧值
- 如果移除的是最后一位元素，则把原数组的前len-1个元素拷贝到新数组中，并把新数组赋值给当前对象的数组属性；
- 如果移除的不是最后一位元素，则新建一个len-1长度的数组，并把原数组除了指定索引位置的元素全部拷贝到新数组中，并把新数组赋值给当前对象的数组属性
- 解锁并返回旧值
size（）方法
//返回数组的长度
public int size() {
//获取元素个数不需要加锁
//直接返回数组的长度
return getArray().length;
}
总结
- CopyOnWriteArrayList使用ReentrantLock重入锁加锁，保证线程安全
- CopyOnWriteArrayList的写操作都要先拷贝一份新数组，在新数组中做修改，修改完了再用新数组替换老数组，所以空间复杂度是O(n)，性能比较低下（ArrayList中采用的数组动态扩容）。
- CopyOnWriteArrayList的读操作支持随机访问，时间复杂度为O(1)；
- CopyOnWriteArrayList采用读写分离的思想，读操作不加锁，写操作加锁，且写操作占用较大的内存空间，所以适用于读多写少的场合。
- CopyOnWriteArrayList只保证最终一致性，不能保证实时一致性，从add添加相关方法中可以看出，再修改数据结构时先获取一个快照，然后在真正修改数组结构前对比快照和当前数组结构是否发生变化。
扩展
为什么CopyOnWriteArrayList没有size属性？
因为每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要size属性了（也不需要进行是否扩容的判断)，数组的长度就是集合的大小，而不像ArrayList数组的长度实际是要大于集合的大小的。
杂度为O(1)；
- CopyOnWriteArrayList采用读写分离的思想，读操作不加锁，写操作加锁，且写操作占用较大的内存空间，所以适用于读多写少的场合。
- CopyOnWriteArrayList只保证最终一致性，不能保证实时一致性，从add添加相关方法中可以看出，再修改数据结构时先获取一个快照，然后在真正修改数组结构前对比快照和当前数组结构是否发生变化。
扩展
为什么CopyOnWriteArrayList没有size属性？
因为每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要size属性了（也不需要进行是否扩容的判断)，数组的长度就是集合的大小，而不像ArrayList数组的长度实际是要大于集合的大小的。
比如，add（E e）操作，先拷贝一份n+1个元素的数组，再把新元素放到新数组的最后一位，这时新数组的长度为len+1了，也就是集合的size了。