CopyOnWriteArrayList源码解析和设计思

引入

在ArrayList的注解上,JDK告诉我们,当ArrayList(JDK1.2)作为线程共享变量时,是线程不安全的,推荐我们加锁或者使用Connection.synchronizedList(),而Vector(JDK1.0)不推荐使用,因为Vector保证线程安全的前提是加synchronized重量级锁,严重影响性能,所以提供了一种新的线程安全的List–CopyOnWriteArrayList(JDK1.5)

特征

1.线程安全 无需加锁
2.通过使用读写锁+数组拷贝+volatile 保证线程安全
3.写操作时,都会将数组拷贝一份出来,在新数组上进行操作,操作成功后再赋值回去
4.读操作时不需要拷贝,读写分离思想,不过用底层数组用volatile修饰,对线程可见
5.和ArrayList数据结构一致,底层都是数组

总体归纳

CopyOnWriteArrayList对数组进行操作时分为四步走:
1.读写锁加锁
2.从原数组中拷贝出一份新的数组
3.在新数组上进行操作,并把新数组赋值给原数组容器
4.释放锁(finally释放 防止内存泄漏)

源码分析

底层数组容器

private transient volatile Object[] array; //volatile修饰对线程可见

构造方法

	//无参构造 会直接初始化一个数组 将数组赋值给底层数组容器
    public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }

	/*
		有参构造 需要传一个可以接收E类型或者E的子类型的集合

		如果类型和CopyOnWriteArrayList的类型相同则将它的
		数组赋值给新的CopyOnWriteArrayList集合

		如果不相同 则将其转换为一个数组 然后进行数组拷贝赋值
	*/
	public CopyOnWriteArrayList(Collection<? extends E> c) {
        Object[] elements;
        if (c.getClass() == CopyOnWriteArrayList.class)
            elements = ((CopyOnWriteArrayList<?>)c).getArray();
        else {
            elements = c.toArray();
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elements.getClass() != Object[].class)
                elements = Arrays.copyOf(elements, elements.length, Object[].class);
        }
        setArray(elements);
    }

尾部新增

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

此处使用加锁保证同一时间只有一个线程对同一个数组进行add,那么除了加锁,还会从老数组中创建新数组,并拷贝值,而不是在原数组上进行操作,出现了新问题,为什么拷贝数组,而不是在数组上进行操作呢?
原因是:
volatile关键词修饰的是原数组,如果只在数组上修改几个节点的值是不会触发可见性的,所以我们必须通过修改数组的内存地址才行,也就是说要对数组进行重新赋值
新的数组进行拷贝,对老数组没影响,只有新数组拷贝完,外部才能访问到,降低了在赋值过程中老数组的变动影响

索引处新增

public void add(int index, E element) {
        final ReentrantLock lock = this.lock;
        lock.lock();//加锁
        try {
            Object[] elements = getArray();
            int len = elements.length;
            //判断index和原数组长度的关系
            if (index > len || index < 0)
                throw new IndexOutOfBoundsException("Index: "+index+
                                                    ", Size: "+len);
            //新数组
            Object[] newElements;
            int numMoved = len - index;
            //索引处 = 数组 末尾直接添加节点
            if (numMoved == 0)
                newElements = Arrays.copyOf(elements, len + 1);
            else {
                newElements = new Object[len + 1];
                //数组拷贝 拷贝0--index
                System.arraycopy(elements, 0, newElements, 0, index);
                //数组拷贝 拷贝index+1--末尾
                System.arraycopy(elements, index, newElements, index + 1,
                                 numMoved);
            }
            //index为空 节点赋值
            newElements[index] = element;
            //数组赋值
            setArray(newElements);
        } finally {
        	//释放锁
            lock.unlock();
        }
    }

小结

1.加锁:保证同一时刻数组只能被一个线程操作
2.数组拷贝:保证数组内存地址修改 触发volatile可见性
3.volatile:值修改后,其他线程马上感知

删除索引处节点

 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); //老的值
            //如果在数组尾部 直接拷贝0--len-1
            int numMoved = len - index - 1;
            if (numMoved == 0)
                setArray(Arrays.copyOf(elements, len - 1));
            else {
            //如果不是在数组 拷贝两次 第一次0--len-1 第二次index+1--尾部做
                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(); //释放锁
        }
    }

小结

1.加锁
2.分段拷贝
3.释放锁

批量删除

public boolean removeAll(Collection<?> c) {
        if (c == null) throw new NullPointerException();
        final ReentrantLock lock = this.lock;
        lock.lock(); //加锁
        try {
            Object[] elements = getArray();
            int len = elements.length;
            if (len != 0) {
                int newlen = 0;
                Object[] temp = new Object[len];//创建新数组
                for (int i = 0; i < len; ++i) {
                    Object element = elements[i];
                	//将不包含c集合中的元素 从0开始放到新数组中
                    if (!c.contains(element))
                        temp[newlen++] = element;
                }
                if (newlen != len) {
                    setArray(Arrays.copyOf(temp, newlen));
                    return true;
                }
            }
            return false;
        } finally {
            lock.unlock(); //释放锁
        }
    }

从源码中可以看到 CopyOnWriteArrayList并不会将元素逐个删除,而是对数组进行循环判断,把我们不需要删除的数据放到临时数组中,最后淋湿数组就是我们不需要需要删除的数据.
如果使用逐个删除的话,在每次删除的时候都会进行一次数组拷贝,消耗时间和性能,加锁时间长,并发大,会造成大量请求等待锁,这也会占用一定的内存.

查询IndexOf

  private static int indexOf(Object o搜索对象, Object[] elements搜索目标数组,
                               int index开始位置, int fence结束位置) {
       //查询元素为空 遍历放回
        if (o == null) {
            for (int i = index; i < fence; i++)
                if (elements[i] == null)
                    return i;
        } else {
        //不为空遍历
            for (int i = index; i < fence; i++)
                if (o.equals(elements[i]))
                    return i;
        }
        return -1;
    }

迭代

其迭代过程中,如果数组的原值被改变,也不会抛出ConcurrentModificationException异常,其原因是读写分离,每次操作都会生成新的数组,不影响老数组.

总结

我们在线程不安全的情况下使用List时,建议使用CopyOnWriteArrayList,CopyOnWriteArrayList通过锁+数组拷贝+volatile之间互相配合,实现List的线程安全.