CopyOnWriteArrayList
一、简介:
1.相当于线程安全的ArrayList。
2.对于可变的操作add,set,remove操作,需要复制整个基础数组,开销很大。因此适合读操作频率大于写操作
3.迭代器支持hasNext(),next()操作,不支持remove操作
4.实现List,RandomAccess,Cloneable,Serializable接口。
二、成员变量
final transient ReentrantLock lock = new ReentrantLock(); //互斥锁
/** The array, accessed only via getArray/setArray. */
private transient volatile Object[] array; //volatile数组
volatile数组的作用:保证了动态数组的机制
–在add,set,remove数据时,都会新建一个数组,并将更新的数据拷贝到新的数组上去,最后通过setArray方法复制给 volatile数组。保证了数组的可见性,每个线程都会读取到最新的数据。但是修改数据的效率很低。
ReentranLock锁作用:保证了线程安全机制
–与volatile数组相互作用,保证在add,set,remove数据时,线程需要先获取锁,修改数据并更新到volatile数组中,释放锁。
三、方法
1.setArray()/getArray() 更新和获取volatile数组
final void setArray(Object[] a) {
array = a;
}
final Object[] getArray() {
return array;
}
2.add(E e)添加元素
public boolean add(E e) {
final ReentrantLock lock = this.lock;
lock.lock(); //获得锁,用来保证多线程修改数据
try {
Object[] elements = getArray(); //获取当前的数组对象内容
int len = elements.length; //获取length长度
Object[] newElements = Arrays.copyOf(elements, len + 1); //复制一个比当前长度大1的数组,并将原先的数组值复制进去
newElements[len] = e; //将最后一位的数据添加
setArray(newElements); //更新到volatile数组保持可见性
return true;
} finally {
lock.unlock(); //释放锁
}
}
说明:将数据e添加到volatile数组中。它的实现方式,新建一个数组,将原始的volatile数组copy新的数组中,然后将新增的数据添加到新数组中;最后,将新数组赋值给volatile数组。
3.get(Object[] a, int index)
@SuppressWarnings("unchecked")
private E get(Object[] a, int index) {
return (E) a[index]; //返回第几个元素
}
4.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); //调用get()方法,获取要删除元素的内容
int numMoved = len - index - 1; //计算删除元素需要移动的元素的个数
if (numMoved == 0) //为0表示,删除的是数组的最后一位
setArray(Arrays.copyOf(elements, len - 1)); //copy一个数组,并更新volatile数组
else {
Object[] newElements = new Object[len - 1]; //获取删除后数组的长度
System.arraycopy(elements, 0, newElements, 0, index); //复制0-index位置的数组长度
System.arraycopy(elements, index + 1, newElements, index,
numMoved); //复
setArray(newElements);
}
return oldValue;
} finally {
lock.unlock(); //释放锁
}
}
说明:如果被删除的是最后一个元素,直接通过Arrays.copyOf()进行处理,不需要创建新的数组。否则新建数组,然后将volatile数组中删除元素之外的其他元素copy到新的数组中;最后,将新数组赋值给volatile数组。
private boolean remove(Object o, Object[] snapshot, int index) {
final ReentrantLock lock = this.lock;
lock.lock();
try {
Object[] current = getArray();
int len = current.length;
if (snapshot != current) findIndex: {
int prefix = Math.min(index, len);
for (int i = 0; i < prefix; i++) {
if (current[i] != snapshot[i] && eq(o, current[i])) {
index = i;
break findIndex;
}
}
if (index >= len)
return false;
if (current[index] == o)
break findIndex;
index = indexOf(o, current, index, len);
if (index < 0)
return false;
}
Object[] newElements = new Object[len - 1];
System.arraycopy(current, 0, newElements, 0, index);
System.arraycopy(current, index + 1,
newElements, index,
len - index - 1);
setArray(newElements);
return true;
} finally {
lock.unlock();
}
}
5.addAll(Collection<? extends E> c)
public boolean addAll(Collection<? extends E> c) {
Object[] cs = (c.getClass() == CopyOnWriteArrayList.class) ? //判断集合是否是CopyOnWriterArrayList,并转换为对应的数组
((CopyOnWriteArrayList<?>)c).getArray() : c.toArray();
if (cs.length == 0) //判断是是否有数据
return false;
final ReentrantLock lock = this.lock;
lock.lock(); //获取锁
try {
Object[] elements = getArray(); //获取当前volatile数组
int len = elements.length; //数组长度
if (len == 0 && cs.getClass() == Object[].class) //判断数组长度为0,并且cs和Object类型相同。就可以直接将cs数组,更新到volatile数组中。
setArray(cs);
else { //否则会创建新的数组,将原有的数组数据和add的数组数据加进新的数组中
Object[] newElements = Arrays.copyOf(elements, len + cs.length);
System.arraycopy(cs, 0, newElements, len, cs.length);
setArray(newElements);
}
return true;
} finally {
lock.unlock(); //释放锁
}
}
6.Iterator迭代器
static final class COWIterator<E> implements ListIterator<E> {
private final Object[] snapshot; //需要进行迭代的数组
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;
}
public void remove() {
throw new UnsupportedOperationException();
}
public void set(E e) {
throw new UnsupportedOperationException();
}
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;
}
}
说明:对于remove,add,set操作,COWIterator会抛出异常,所以也不会支持fail-fast机制。
7.addIfAbsent(E e, Object[] snapshot)
private boolean addIfAbsent(E e, Object[] snapshot) {
final ReentrantLock lock = this.lock;
lock.lock(); //获取锁
try {
Object[] current = getArray(); //从volatile数组中取出数组数据
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;
}
Object[] newElements = Arrays.copyOf(current, len + 1);
newElements[len] = e;
setArray(newElements);
return true;
} finally {
lock.unlock();
}
}