JUC系列 | CopyOnWriteArrayList源码解析

水深无声 2022-09-08 00:18 235阅读 0赞

> 原创不易，转载请注明出处

### 文章目录 ###

*   *   *  1.原理介绍
         *   *  1.1 底层原理：
             *  1.2 原理图解
             *  1.3 优缺点/适用场景
         *  2.源码分析
         *   *  2.1 add 方法源码分析
             *  2.2 get方法
             *  2.3 remove 方法

--------------------

### 1.原理介绍 ###

CopyOnWriteArrayList从名字上也能看出来，写时复制的一个ArrayList（关于采用写时复制机制其他工具源码分析我们写过2篇，可以一块学习下，原理是一样的《[Tomcat中基于ArrayList实现的数组栈ArrayStack源码剖析][Tomcat_ArrayList_ArrayStack]》，《[深度解析Kafka中CopyOnWriteMap实现原理][Kafka_CopyOnWriteMap]》），并且是一个线程安全的工具，我们都知道ArrayList是个线程不安全的数据结构，多线程并发的时候容易产生线程安全问题（也就是数据错乱）。

#### 1.1 底层原理： ####

CopyOnWriteArrayList 底层跟ArrayList 是一样的，也是个数组，但是它这个数组是volatile 关键字修饰的，这个就很重要了，volatile 两个作用，1是防止指令的重排序，2是线程的可见性，也就是说当它变了的时候，其他线程能够立马感知到。

变更（增删改）元素的时候： 写时复制，在往CopyOnWriteArrayList 添加元素，删除元素等写操作的时候，会进行加锁，新建一个数组，进行数组拷贝，将原来数组中的元素拷贝到新数组中，最后就是将数组引用指向新数组，释放锁。

读取数据的时候：拿到当时那一个时刻引用的那个数组（`使用final修饰引用，这个也是一个非常重要的点`），进行读取操作，如果说后续进行了CopyOnWriteArrayList元素变更（也就是进行了数组引用的替换），都跟这一时刻这个数组没有关系了。

#### 1.2 原理图解 ####

![在这里插入图片描述][80a58b2bb66c465eb6de59bb5432628d.png]

1.  比如说一开始的时候我们CopyOnWriteArrayList 里面有一个元素，也就是数组中有一个元素，如上图所示。
2.  接着我们往CopyOnWriteArrayList 添加元素，看看它是怎么做的，首先是获取锁，接着就是创建一个比上图array多一个元素的数组，将老数组中的元素拷贝到新数组中，然后将要添加的元素放到数组最后一个位置  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_Q1NETiBAJOeggeWHuuacquadpQ_size_37_color_FFFFFF_t_70_g_se_x_16]
3.  将新数组赋值给array 。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_Q1NETiBAJOeggeWHuuacquadpQ_size_39_color_FFFFFF_t_70_g_se_x_16]  
    这个时候老数组的引用就没有被array持有了（array持有新数组的引用），如果再没有别的地方用到的话，gc的时候可能会被回收。

#### 1.3 优缺点/适用场景 ####

*注意：可能总结不完整，欢迎留言补充*

优点：ArrayList具有的优点，数组具有的优点（查找快），读写线程安全，读无锁。  
缺点：写的时候性能低下，不光是加锁的原因，还有就是数组copy的原因，ArrayList 缺点，数组缺点（定长）  
适用场景：读多写少（数据万年不变，基本全是读的场景，有很少的写场景）

### 2.源码分析 ###

首先来看看CopyOnWriteArrayList 的类继承关系

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

接着看看核心成员

final transient ReentrantLock lock = new ReentrantLock();
    private transient volatile Object[] array;

lock： 这个就是我们上面介绍写时复制用到的锁。  
array：底层存储，数组结构，最关键的是使用volatile （可见性，防止指令重排序）关键字修饰。

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

可以看到，先是获取锁，接着就是数组拷贝（新建一个长度+1的数组，然后将老数组中的元素数据拷贝到新数组中），最后将新数组赋值个array成员变量（也就是我们上面看到的底层存储成员变量），释放锁。

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

这个getArray 方法获取 array数组引用，然后使用final关键字修饰，这个时候你拿到的这个引用就不会在发生改变，就是当时那个数组引用。这样的话，根据普通获取元素一样了。

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

remove删除其实跟add同理，也是需要获取锁，进行数组拷贝，不过它这个稍微麻烦点，最后也是将新数组赋值给array，将删除的元素返回，释放锁。

[Tomcat_ArrayList_ArrayStack]: https://inetyoung.blog.csdn.net/article/details/119652466
[Kafka_CopyOnWriteMap]: https://inetyoung.blog.csdn.net/article/details/112249790
[80a58b2bb66c465eb6de59bb5432628d.png]: /images/20220829/e08421c043ec4e139774092edc0c010b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_Q1NETiBAJOeggeWHuuacquadpQ_size_37_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/be1c08ed01d3460d8e1ca0d0353a5ff2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_Q1NETiBAJOeggeWHuuacquadpQ_size_39_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/c2f74e9d1c964165a208b3154f48673a.png