Java并发编程——CopyOnWriteArrayList原理解析

PunkLu 2020年01月12日 61次浏览
CopyOnWriteArrayList原理解析

CopyOnWriteArrayList

介绍

并发包中的并发List只有CopyOnWriteArrayList。CopyOnWriteArrayList是一个线程安全的ArrayList,对其进行的修改操作都是在底层的一个复制的数组(快照)上进行的,也就是使用了写时复制策略。

源码分析

初始化

CopyOnWriteArrayList的无参构造函数在内部创建了一个大小为0的Object数组作为array的初始值。

public CopyOnWriteArrayList() {
        setArray(new Object[0]);
}

有参构造函数:

// 创建一个list,其内部元素是入参toCopyIn的副本
public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}

// 入参为集合,将集合里面的元素复制到本list
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);
}

添加元素

CopyOnWriteArrayList中用来添加元素的函数有add(E e)、add(int index,E element)、addIfAbsent(E e)和addAllAbsent(Collection<? entends E> c)等,它们的原理类似,以add(E e)举例:

public boolean add(E e) {
		// 1、获取独占锁
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
        	// 2、获取array
            Object[] elements = getArray();
            
            // 3、复制array到新数组,添加元素到新数组
            int len = elements.length;
            Object[] newElements = Arrays.copyOf(elements, len + 1);
            newElements[len] = e;
            
            // 4、使用新数组替换添加前的数组
            setArray(newElements);
            return true;
        } finally {
        	// 5、释放独占锁
            lock.unlock();
        }
}

如上所示,首先获取独占锁,获取到独占锁后,先获取现有数组,然后创建一个大小比原有数组大小大1的新数组,并将传入的元素值放入新数组,再将数组替换为新数组,最后释放锁。

获取指定位置元素

使用E get(int index)获取下标为index的元素,如果元素不存在则抛出异常。

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

因为并没有加锁,所以可能会出现获取到的元素实际上已经被其他线程删除的情况。即写时复制策略产生的弱一致性问题。

修改指定元素

使用E set(int index,E element)修改list中指定元素的值,如果指定位置的元素不存在则抛出异常。

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;
                setArray(newElements);
            } else {
                // Not quite a no-op; ensures volatile write semantics
                setArray(elements);
            }
            return oldValue;
        } finally {
            lock.unlock();
        }
}

如上代码,首先获取独占锁,从而阻止其他线程对array数组进行修改,然后获取当前数组,并调用get方法获取指定位置的元素,如果指定位置的元素值与新值不一致则创建数组并复制元素,然后在新数组上修改指定位置的元素值并设置新数组到array。如果指定位置的元素值与新值一样,则为了保证volatile语义,还是需要重新设置array,虽然array的内容并没有改变。

删除元素

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

如上代码和新增元素的代码类似,首先获取独占锁以保证删除数据期间其他线程不能对array进行修改,然后获取数组中要被删除的元素,并把剩余的元素复制到新数组,之后使用新数组替换原来的数组,最后在返回前释放锁。

弱一致性的迭代器

所谓弱一致性是指返回迭代器后,其他线程对list的增删改对迭代器是不可见的。

public Iterator<E> iterator() {
        return new COWIterator<E>(getArray(), 0);
}

static final class COWIterator<E> implements ListIterator<E> {
        /** Snapshot of the array */
        private final Object[] snapshot;
        /** Index of element to be returned by subsequent call to next.  */
        private int cursor;

        private COWIterator(Object[] elements, int initialCursor) {
            cursor = initialCursor;
            snapshot = elements;
        }

        public boolean hasNext() {
            return cursor < snapshot.length;
        }

        public boolean hasPrevious() {
            return cursor > 0;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            if (! hasNext())
                throw new NoSuchElementException();
            return (E) snapshot[cursor++];
        }

        @SuppressWarnings("unchecked")
        public E previous() {
            if (! hasPrevious())
                throw new NoSuchElementException();
            return (E) snapshot[--cursor];
        }

        public int nextIndex() {
            return cursor;
        }

        public int previousIndex() {
            return cursor-1;
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         * @throws UnsupportedOperationException always; {@code remove}
         *         is not supported by this iterator.
         */
        public void remove() {
            throw new UnsupportedOperationException();
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         * @throws UnsupportedOperationException always; {@code set}
         *         is not supported by this iterator.
         */
        public void set(E e) {
            throw new UnsupportedOperationException();
        }

        /**
         * Not supported. Always throws UnsupportedOperationException.
         * @throws UnsupportedOperationException always; {@code add}
         *         is not supported by this iterator.
         */
        public void add(E e) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            Object[] elements = snapshot;
            final int size = elements.length;
            for (int i = cursor; i < size; i++) {
                @SuppressWarnings("unchecked") E e = (E) elements[i];
                action.accept(e);
            }
            cursor = size;
        }
}

可以看到,当调用iterator()方法获取迭代器时实际上会返回一个COWIterator对象,COWIterator对象的snapshot变量保存了当前list的内容。

虽然是指针传递的引用,但是因为当其他线程对list进行修改时是新建一个数组,然后将原有list数组指向新数组,所以此时的snapshot快照已经是副本,而不是对新数组的引用了。

多线程下迭代器的弱一致性的效果:

public class CopyList {

    private static volatile CopyOnWriteArrayList<String> arrayList = new CopyOnWriteArrayList<String>();

    public static void main(String[] args) throws InterruptedException{
        arrayList.add("hello");
        arrayList.add("java");
        arrayList.add("welcome");
        arrayList.add("to");
        arrayList.add("java");

        Thread threadOne = new Thread(new Runnable() {
            public void run() {
                // 修改list中下标为1的元素为java1
                arrayList.set(1,"java1");
                // 删除元素
                arrayList.remove(2);
                arrayList.remove(3);
            }
        });

        // 保证在修改线程启动前获取迭代器
        Iterator<String> itr = arrayList.iterator();

        // 启动线程
        threadOne.start();

        // 等待子线程执行完毕
        threadOne.join();

        // 迭代元素
        while (itr.hasNext()){
            System.out.println(itr.next());
        }
    }
}

运行结果:

hello
java
welcome
to
java