CopyOnWriteArrayList源码分析

目录

1.CopyOnWrite容器

2.CopyOnWriteArrayList源码分析

2.1  构造方法  public CopyOnWriteArrayList()

2.2  添加元素    public boolean add(E e)

2.3 获取元素  public E get(int index)

 2.4 删除元素  public boolean remove(Object o)

 3. 总结

---

1.CopyOnWrite容器

Copy-On-Write是一种用于集合的并发访问的优化策略。基本思想是：当我们往一个集合容器中写入元素时（添加、修改、删除），并不会直接在集合容器中写入，而是先将当前集合容器进行Copy，复制出一个新的容器，然后新的容器里写入元素，写入操作完成之后，再将原容器的引用指向新的容器。这样做实现了对CopyOnWrite集合容器写入操作时的线程安全，但同时并不影响进行并发的读取操作，是一种读写分离的思想。

CopyOnWriteArrayList是线程安全且读操作无锁的ArrayList，内部存储结构采用Object[]数组，线程安全使用ReentrantLock实现，允许多个线程并发读取，但只能有一个线程写入。写操作则通过创建底层数组的新副本来实现，是一种读写分离的并发策略。

2.CopyOnWriteArrayList源码分析

很多时候，我们的系统应对的都是读多写少的并发场景。CopyOnWriteArrayList容器允许并发读，读操作是无锁的，性能较高。至于写操作，比如向容器中添加一个元素，则首先将当前容器复制一份，然后在新副本上执行写操作，结束之后再将原容器的引用指向新容器。

2.1  构造方法  public CopyOnWriteArrayList()

使用方法：

List<String> list = new CopyOnWriteArrayList<String>();

源码分析：

private volatile transient Object[] array;//底层数据结构
 
    /**
     * 获取array
     */
    final Object[] getArray() {
        return array;
    }
 
    /**
     * 设置Object[]
     */
    final void setArray(Object[] a) {
        array = a;
    }
 
    /**
     * 创建一个CopyOnWriteArrayList
     * 注意：创建了一个0个元素的数组
     */
    public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }

 注意点：

• 设置一个容量为0的Object[]；ArrayList会创造一个容量为10的Object[] 

2.2  添加元素    public boolean add(E e)

使用方法：

list.add("hello");

 源码分析：

/**
     * 在数组末尾添加元素
     * 1）获取锁
     * 2）上锁
     * 3）获取旧数组及其长度
     * 4）创建新数组，容量为旧数组长度+1，将旧数组拷贝到新数组
     * 5）将要增加的元素加入到新数组的末尾，设置全局array为新数组
     */
    public boolean add(E e) {
        final ReentrantLock lock = this.lock;//这里为什么不直接用this.lock（即类中已经初始化好的锁）去上锁
        lock.lock();//上锁
        try {
            Object[] elements = getArray();//获取当前的数组
            int len = elements.length;//获取当前数组元素
            /*
             * Arrays.copyOf(elements, len + 1)的大致执行流程：
             * 1）创建新数组，容量为len+1，
             * 2）将旧数组elements拷贝到新数组，
             * 3）返回新数组
             */
            Object[] newElements = Arrays.copyOf(elements, len + 1);
            newElements[len] = e;//新数组的末尾元素设成e
            setArray(newElements);//设置全局array为新数组
            return true;
        } finally {
            lock.unlock();//解锁
        }
    }

2.3 获取元素  public E get(int index)

使用方法：

list.get(0)

/**
     * 根据下标获取元素
     * 1）获取数组array
     * 2）根据索引获取元素
     */
    public E get(int index) {
        return (E) (getArray()[index]);
    }

 2.4 删除元素  public boolean remove(Object o)

使用方法：

list.remove("hello")

/**
     * 删除list中的第一个o
     * 1）获取锁、上锁
     * 2）获取旧数组、旧数组的长度len
     * 3）如果旧数组长度为0，返回false
     * 4）如果旧数组有值，创建新数组，容量为len-1
     * 5）从0开始遍历数组中除了最后一个元素的所有元素
     * 5.1）将旧数组中将被删除元素之前的元素复制到新数组中，
     * 5.2）将旧数组中将被删除元素之后的元素复制到新数组中
     * 5.3）将新数组赋给全局array
     * 6）如果是旧数组的最后一个元素要被删除，则
     * 6.1）将旧数组中将被删除元素之前的元素复制到新数组中
     * 6.2）将新数组赋给全局array
     */
    public boolean remove(Object o) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            Object[] elements = getArray();//获取原数组
            int len = elements.length;//获取原数组长度
            if (len != 0) {//如果有数据
                // Copy while searching for element to remove
                // This wins in the normal case of element being present
                int newlen = len - 1;//新数组长度为原数组长度-1
                Object[] newElements = new Object[newlen];//创建新数组
 
                for (int i = 0; i < newlen; ++i) {//遍历新数组（不包含最后一个元素）
                    if (eq(o, elements[i])) {
                        // 将旧数组中将被删除元素之后的元素复制到新数组中
                        for (int k = i + 1; k < len; ++k)
                            newElements[k - 1] = elements[k];
                        setArray(newElements);//将新数组赋给全局array
                        return true;
                    } else
                        newElements[i] = elements[i];//将旧数组中将被删除元素之前的元素复制到新数组中
                }
 
                if (eq(o, elements[newlen])) {//将要删除的元素时旧数组中的最后一个元素
                    setArray(newElements);
                    return true;
                }
            }
            return false;
        } finally {
            lock.unlock();
        }
    }




//判断两个对象是否相等：

/**
     * 判断o1与o2是否相等
     */
    private static boolean eq(Object o1, Object o2) {
        return (o1 == null ? o2 == null : o1.equals(o2));
    }

 3. 总结

CopyOnWriteArrayList具有以下特性：
1在保证并发读取的前提下，确保了写入时的线程安全；
2由于每次写入操作时，进行了Copy复制原数组，所以无需扩容；
3适合读多写少的应用场景。由于add()、set() 、 remove()等修改操作需要复制整个数组，所以会有内存开销大的问题。
4CopyOnWriteArrayList由于只在写入时加锁，所以只能保证数据的最终一致性，不能保证数据的实时一致性。