安卓文档

[并发集合] CopyOnWriteArrayList源码分析

2020-01-01  本文已影响0人  LZhan

1 简介

CopyOnWriteArrayList是ArrayList的线程安全版本,其内部是通过数组实现,每次对数组的修改都完全拷贝一份新的数组来修改,修改完再替换掉老数组,这样保证了只阻塞写操作,不阻塞读操作,实现读写分离。

2 实现接口

3 源码解析

    /** The lock protecting all mutators */
    // 用于修改时加锁
    final transient ReentrantLock lock = new ReentrantLock();

    /** The array, accessed only via getArray/setArray. */
    // 真正存储元素的地方,只能通过setArray()/getArray()访问
    private transient volatile Object[] array;

都使用transient修饰,表示不自动序列化。

4 构造方法

默认构造方法:

    public CopyOnWriteArrayList() {
        // 所有对array的操作都是通过setArray()和getArray()进行
        setArray(new Object[0]);
    }
    final void setArray(Object[] a) {
        array = a;
    }

参数类型为Collection的构造方法:
如果参数c是CopyOnWriteArrayList类型,直接将它的数组赋值给当前list的数组,注意这里是浅拷贝,两个集合共用同一个数组。
如果参数c不是CopyOnWriteArrayList类型,则进行拷贝把c的元素全部拷贝到当前list的数组中。
(Arrays的copyOf()方法传回的数组是新的数组对象,改变传回数组中的元素值,不会影响原来的数组)

    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 might (incorrectly) not return Object[] (see 6260652)
            // 这里c.toArray()返回的不一定是Object[]类型
            if (elements.getClass() != Object[].class)
                elements = Arrays.copyOf(elements, elements.length, Object[].class);
        }
        setArray(elements);
    }

参数类型为数组的构造方法:
将toCopyIn的元素拷贝给当前list的数组。

  public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
    }

5 add(E e)方法

添加一个元素到末尾

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

6 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;
            // 检查是否越界,可以等于len
            if (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();
        }
    }

System.arraycopy(Object src, int srcPos,Object dest, int destPos,int length)方法,参数分别是:1 原数组 2 从原数据的起始位置开始 3 目标数组 4 目标数组的开始起始位置 5 要copy的数组的长度

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

调用内部的addIfAbsent方法

    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) {
                // Optimize for lost race to another addXXX operation
                // 重新检查元素是否在刚获取的数组里面
                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();
        }
    }

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

9 remove(int index) 方法

    public E remove(int index) {
        final ReentrantLock lock = this.lock;
        // 加锁
        lock.lock();
        try {
            // 获取旧数组
            Object[] elements = getArray();
            int len = elements.length;
            // 获取指定index的旧元素
            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();
        }
    }

10 总结

(1)CopyOnWriteArrayList使用ReentrantLock重入锁加锁,保证线程安全;
(2)CopyOnWriteArrayList的写操作都要先拷贝一份新数组,在新数组中做修改,修改完了再用新数组替换老数组,所以空间复杂度是O(n),性能比较低下;
(3)CopyOnWriteArrayList的读操作支持随机访问,时间复杂度为O(1);
(4)CopyOnWriteArrayList采用读写分离的思想,读操作不加锁,写操作加锁,且写操作占用较大内存空间,所以适用于读多写少的场合;
(5)CopyOnWriteArrayList只保证最终一致性,不保证实时一致性【当执行add或remove操作没完成时,get获取的仍然是旧数组的元素】

面试问题:

  1. 为什么CopyOnWriteArrayList没有size属性?
    不像ArrayList数组的长度实际是要大于集合的大小的,对于CopyOnWriteArrayList,每次修改都是拷贝一份正好可以存储目标个数元素的数组,所以不需要size属性了,数组的长度就是集合的大小

2.CopyOnWriteArrayList是怎么保证并发安全的?
在添加数据时,利用可重入锁ReentrantLock,先复制底层数组,进行写操作(添加或者删除),最后利用新数组替换旧数组,再释放锁。

3.CopyOnWriteArrayList的实现采用了什么思想?
是一种读写分离的思想,读和写不同的容器。

Copy-On-Write简称COW,是一种用于程序设计中的优化策略。其基本思路是,从一开始大家都在共享同一个内容,当某个人想要修改这个内容的时候,才会真正把内容Copy出去形成一个新的内容然后再改,这是一种延时懒惰策略。

CopyOnWrite容器即写时复制的容器。通俗的理解是当我们往一个容器添加元素的时候,不直接往当前容器添加,而是先将当前容器进行Copy,复制出一个新的容器,然后新的容器里添加元素,添加完元素之后,再将原容器的引用指向新的容器。

CopyOnWriteArrayList中add/remove等写方法是需要加锁的,目的是为了避免Copy出N个副本出来,导致并发写。

我们可以并发读,但是读到的数据可能不是最新的。

4.CopyOnWriteArrayList是不是强一致性的?
不是强一致性的,读操作不是加锁的,如果同时有写操作在进行,可能读的是旧容器,是旧值,所以是最终一致性,并不是强一致性。

5.CopyOnWriteArrayList适用于什么样的场景?
采用读写分离的思想,读操作不加锁,写操作加锁,且写操作占用较大内存空间,适用于读多写少的场景

6.CopyOnWriteArrayList插入、删除、查询元素的时间复杂度各是多少?
插入,删除的时间复杂度:O(n)
查询的时间复杂度:O(1)

上一篇 下一篇

猜你喜欢

热点阅读