当前位置： 代码迷 >> 综合 >> Java 集合 (5) -- CopyOnWriteArrayList 类
  详细解决方案

Java 集合 (5) -- CopyOnWriteArrayList 类

热度：63   发布时间：2023-12-16 13:21:58.0

文章目录

    • 1. 简介
    • 2. 继承体系
    • 3. 字段
    • 4. 构造器
    • 5. 常用方法
    • 6. 总结

1. 简介

public class CopyOnWriteArrayList<E>implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    }

CopyOnWriteArrayList 是 ArrayList 的线程安全版本，内部也是通过数组实现，每次对数组的修改都是通过完全拷贝一份新的数组来修改，修改完了之后再用该数组替换掉老数组。

为什么 CopyOnWriteArrayList 没有 size 属性 ？因为 CopyOnWriteArrayList 每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要 size 属性，数组的长度就是集合的大小，而不像 ArrayList 数组的长度实际是要大于集合的大小的。比如，add(E e) 操作，首先会将老数组的 n 个元素拷贝到一个 n+1 长度的新数组，再把新元素放到新数组的最后一位，这时新数组的长度就是集合的 size 。

2. 继承体系

在这里插入图片描述

3. 字段

/** 序列化ID */
private static final long serialVersionUID = 8673264195747942595L;/** 用于修改时加锁，使用transient修饰表示不自动序列化 */
final transient ReentrantLock lock = new ReentrantLock();/** 真正存储元素的地方，只能通过getArray()/setArray()访问使用volatile修饰表示一个线程对这个字段的修改另外一个线程立即可见 */
private transient volatile Object[] array;final Object[] getArray() {
    return array;
}
final void setArray(Object[] a) {
    array = a;
}

4. 构造器

  1. CopyOnWriteArrayList()：创建空数组
    public CopyOnWriteArrayList() {
      // 所有对array的操作都是通过setArray()和getArray()进行setArray(new Object[0]);
}
  2. CopyOnWriteArrayList(Collection<? extends E> c)：如果c是CopyOnWriteArrayList类型，直接把它的数组赋值给 array 数组，注意这里是浅拷贝，两个集合共用同一个数组；如果c不是CopyOnWriteArrayList类型，则进行拷贝把c的元素全部拷贝到 array 数组中 (array：真正存储元素的地方)
    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[]类型// 详细原因见ArrayList里面的分析if (elements.getClass() != Object[].class)elements = Arrays.copyOf(elements, elements.length, Object[].class);}setArray(elements);
}
  3. CopyOnWriteArrayList(E[] toCopyIn)：把toCopyIn的元素拷贝给 array 数组
    public CopyOnWriteArrayList(E[] toCopyIn) {
      setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}

5. 常用方法

  1. public boolean add(E e)：添加一个元素到末尾

    //源码
public boolean add(E e) {
      final ReentrantLock lock = this.lock;// 加锁lock.lock();try {
      // 获取旧数组Object[] elements = getArray();int len = elements.length;// 将旧数组元素拷贝到新数组中// 新数组大小是旧数组大小加1Object[] newElements = Arrays.copyOf(elements, len + 1);// 将元素放在最后一位newElements[len] = e;setArray(newElements);return true;} finally {
      // 释放锁lock.unlock();}
}

    大致的步骤：加锁；获取旧数组；新建一个数组，大小为原数组长度加1，并把原数组元素拷贝到新数组；把新添加的元素放到新数组的末尾；把新数组赋值给当前对象的array属性，覆盖原数组；解锁。

  2. public void 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;// 检查是否越界, 可以等于lenif (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属性，覆盖原数组；解锁。

  3. public boolean 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) {
      // 重新检查元素是否在刚获取的数组里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属性，覆盖原数组；解锁。

  4. public E get(int index)：获取指定索引的元素，支持随机访问，时间复杂度为O(1)

    //源码
public E get(int index) {
      // 获取元素不需要加锁// 直接返回index位置的元素// 这里是没有做越界检查的, 因为数组本身会做越界检查return get(getArray(), index);
}

    final Object[] getArray() {
      return array;
}private E get(Object[] a, int index) {
      return (E) a[index];
}

    大致的步骤：获取元素数组；返回数组指定索引位置的元素。

  5. public E 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;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长度的数组，并把原数组除了指定索引位置的元素全部拷贝到新数组中，并把新数组赋值给当前对象的数组属性；解锁并返回旧值。

  6. public int size()：返回数组的长度

    public int size() {
      // 获取元素个数不需要加锁// 直接返回数组的长度return getArray().length;
}

  7. public E set(int index, E element)：修改指定元素

    public E set(int index, E element) {
      final ReentrantLock lock = this.lock;//加锁lock.lock();try {
      //获取旧数组Object[] elements = getArray();E oldValue = get(elements, index);//如果指定位置的元素值和新的值不一样if (oldValue != element) {
      int len = elements.length;//创建新数组并复制元素，然后在新数组上修改指定位置的元素值Object[] newElements = Arrays.copyOf(elements, len);newElements[index] = element;//设置新数组到arraysetArray(newElements);} else {
      // Not quite a no-op; ensures volatile write semanticssetArray(elements);}return oldValue;} finally {
      //解锁lock.unlock();}
}

6. 总结

  1. CopyOnWriteArrayList 使用 ReentrantLock 重入锁加锁，保证线程安全；
  2. 它的写操作都是先拷贝一份新数组，然后在新数组中做修改，修改完了再用新数组替换掉老数组，所以空间复杂度是 O(n)，性能比较低下；
  3. 不过它的读操作支持随机访问，时间复杂度为 O(1)；
  4. CopyOnWriteArrayList 采用读写分离的思想，读操作不加锁，写操作加锁，由于写操作会占用较大的内存空间，所以适用于读多写少的场合；
  5. 另外，CopyOnWriteArrayList 只保证最终一致性，并不保证实时一致性；
  相关解决方案

代码迷 - 您身边的软件异常，代码异常，编程异常助手（发现，解决，分享）
Copyright © 2009-2013 DAIMAMI.COM. All rights reserved.