【Java】通俗易懂的CopyOnWriteArrayList源码剖析

• Z时代
• 2024-01-10
• 分类：技术分享

/** The lock protecting all mutators */
final transient ReentrantLock lock = new ReentrantLock();
/** The array, accessed only via getArray/setArray. */
private transient volatile Object[] array;

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();
}
}

public E set(int index, E element) {
final ReentrantLock lock = this.lock;
lock.lock();
try {
Object[] elements = getArray();
E oldValue = get(elements, index);
// 如果新值与旧值不同，则拷贝一个新数组，并在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
// 新值与旧值相同，为了保证volatile语义，也覆盖下数组，即使内容相同。
setArray(elements);
}
return oldValue;
} finally {
lock.unlock();
}
}

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();
}
}

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];
}

前言

众所皆知，ArrayList是线程不安全的，它的所有方法都没有加锁，那么有没有线程安全并且性能高的类呢？那就是CopyOnWriteArrayList

实现原理

首先来看它的关键数据结构：

/** The lock protecting all mutators */
final transient ReentrantLock lock = new ReentrantLock();
/** The array, accessed only via getArray/setArray. */
private transient volatile Object[] array;

可以看到，底层和ArrayList一样，用数组来保存元素，但它多了把独占锁lock，来保证线程安全。
下面直接进入主题，看看它的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();
}
}

代码逻辑很清晰明了：
第一步，获取数组的排他锁
第二步，获取数组元素和长度n，拷贝一个n+1长度的新数组
第三步，把待添加的元素e放在最后一个位置
第四步，覆盖旧的数组，返回true表示添加成功
第五步，释放锁
简而言之，它的实现思路就跟它的命名一样，CopyOnWrite，“写时复制”，添加元素的时候，先复制数组，添加完成后覆盖掉旧的数组，这些步骤是在加锁的环境完成的，也就是说这个过程中不会有其他线程同时也在写数组，这就保证了写操作的线程安全。

再来看set()方法：

public E set(int index, E element) {
final ReentrantLock lock = this.lock;
lock.lock();
try {
Object[] elements = getArray();
E oldValue = get(elements, index);
// 如果新值与旧值不同，则拷贝一个新数组，并在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
// 新值与旧值相同，为了保证volatile语义，也覆盖下数组，即使内容相同。
setArray(elements);
}
return oldValue;
} finally {
lock.unlock();
}
}

再来看remove()方法

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();
}
}

再来看get()方法：

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方法分为2步，先获取数组，再获取index位置的元素，这2步都是没有加锁的？为什么不需要加锁呢？
上面提到，add()是先拷贝原数组，然后在拷贝的数组上操作的，在setArray()之前对原数组并没有影响，因此读的时候不需要加锁。虽然不需要加锁，但会出现数据弱一致性问题,下图说明

在A线程获取了数组(a=array)后，还没有来得及获取index位置的元素a[index]，线程B删除了index位置的元素，并将array引用指向新的数组(array=newArray)，但是由于线程A用的是栈区的数组引用a，它引用的还是删除元素前的数组，因此它还是会访问到index这个被删除的元素，因此说会有数据的弱一致性问题，但不会抛异常。
由此可以看出，CopyOnWriteArrayList适合用在读多写少的场景，性能会比Vector快，因为Vector的所有方法都加了锁，包括读。

以上是 【Java】通俗易懂的CopyOnWriteArrayList源码剖析 的全部内容， 来源链接： utcz.com/a/106714.html