CopyOnWriteArrayList 你了解多少？

一、摘要

在介绍 CopyOnWriteArrayList 之前，我们一起先来看看如下方法执行结果，代码内容如下：

public static void main(String[] args) {
    List<String> list = new ArrayList<String>();
    list.add("1");
    list.add("2");
    list.add("1");
    System.out.println("原始list元素："+ list.toString());
    //通过对象移除等于内容为1的元素
    for (String item : list) {
        if("1".equals(item)) {
            list.remove(item);
        }
    }
    System.out.println("通过对象移除后的list元素："+ list.toString());
}

执行结果内容如下：

原始list元素：[1, 2, 1]
Exception in thread "main" java.util.ConcurrentModificationException
  at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:909)
  at java.util.ArrayList$Itr.next(ArrayList.java:859)
  at com.example.container.a.TestList.main(TestList.java:16)

很遗憾，结果并没有达到我们想要的预期效果，执行之后直接报错！抛ConcurrentModificationException异常！

为啥会抛这个异常呢？

我们一起来看看，foreach写法实际上是对List.iterator() 迭代器的一种简写，因此我们可以从分析List.iterator() 迭代器进行入手，看看为啥会抛这个异常。

ArrayList类中的Iterator迭代器实现，源码内容：

通过代码我们发现 Itr 是 ArrayList 中定义的一个私有内部类，每次调用next、remove方法时，都会调用checkForComodification方法，源码如下：

/**修改次数检查*/
final void checkForComodification() {
  //检查List中的修改次数是否与迭代器类中的修改次数相等
    if (modCount != expectedModCount)
        thrownew ConcurrentModificationException();
}

checkForComodification方法，实际上是用来检查List中的修改次数modCount是否与迭代器类中的修改次数expectedModCount相等，如果不相等，就会抛出ConcurrentModificationException异常！

那么问题基本上已经清晰了，上面的运行结果之所以会抛出这个异常，就是因为List中的修改次数modCount与迭代器类中的修改次数expectedModCount不相同造成的！

阅读过集合源码的朋友，可能想起Vector这个类，它不是 JDK 中 ArrayList 线程安全的一个版本么？

好的，为了眼见为实，我们把ArrayList换成Vector来测试一下，代码如下：

public static void main(String[] args) {
    Vector<String> list = new Vector<String>();
    //模拟10个线程向list中添加内容，并且读取内容
    for (int i = 0; i < 5; i++) {
        finalint j = i;
        new Thread(new Runnable() {
            @Override
            public void run() {
                //添加内容
                list.add(j + "-j");
                //读取内容
                for (String str : list) {
                    System.out.println("内容：" + str);
                }
            }
        }).start();
    }
}

执行程序，运行结果如下：

还是一样的结果，抛异常了，Vector虽然线程安全，只不过是加了synchronized关键字，但是迭代问题完全没有解决！

继续回到本文要介绍的 CopyOnWriteArrayList 类，我们把上面的例子，换成CopyOnWriteArrayList类来试试，源码内容如下：

public static void main(String[] args) {
    //将ArrayList换成CopyOnWriteArrayList
    CopyOnWriteArrayList<String> list = new CopyOnWriteArrayList<>();
    list.add("1");
    list.add("2");
    list.add("1");
    System.out.println("原始list元素："+ list.toString());
    //通过对象移除等于11的元素
    for (String item : list) {
        if("1".equals(item)) {
            list.remove(item);
        }
    }
    System.out.println("通过对象移除后的list元素："+ list.toString());
}

执行结果如下：

原始list元素：[1, 2, 1]
通过对象移除后的list元素：[2]

呃呵，执行成功了，没有报错！是不是很神奇～～

当然，类似上面这样的例子有很多，比如写10个线程向list中添加元素读取内容，也会抛出上面那个异常，操作如下：

public static void main(String[] args) {
    final List<String> list = new ArrayList<>();
    //模拟10个线程向list中添加内容，并且读取内容
    for (int i = 0; i < 10; i++) {
        finalint j = i;
        new Thread(new Runnable() {
            @Override
            public void run() {
                //添加内容
                list.add(j + "-j");
                //读取内容
                for (String str : list) {
                    System.out.println("内容：" + str);
                }
            }
        }).start();
    }
}

类似的操作例子就非常多了，这里就不一一举例了。

CopyOnWriteArrayList 实际上是 ArrayList 一个线程安全的操作类！

从它的名字可以看出，CopyOnWrite 是在写入的时候，不修改原内容，而是将原来的内容复制一份到新的数组，然后向新数组写完数据之后，再移动内存指针，将目标指向最新的位置。

二、简介

从 JDK1.5 开始 Java 并发包里提供了两个使用CopyOnWrite机制实现的并发容器，分别是CopyOnWriteArrayList和CopyOnWriteArraySet。

从名字上看，CopyOnWriteArrayList主要针对动态数组，一个线程安全版本的 ArrayList ！

而CopyOnWriteArraySet主要针对集，CopyOnWriteArraySet可以理解为HashSet线程安全的操作类，我们都知道HashSet基于散列表HashMap实现，但是CopyOnWriteArraySet并不是基于散列表实现，而是基于CopyOnWriteArrayList动态数组实现！

关于这一点，我们可以从它的源码中得出结论，部分源码内容：

从源码上可以看出，CopyOnWriteArraySet默认初始化的时候，实例化了CopyOnWriteArrayList类，CopyOnWriteArraySet的大部分方法，例如add、remove等方法都基于CopyOnWriteArraySet实现！

两者最大的不同点是，CopyOnWriteArrayList可以允许元素重复，而CopyOnWriteArraySet不允许有重复的元素！

好了，继续来 BB 本文要介绍的CopyOnWriteArrayList类～～

打开CopyOnWriteArrayList类的源码，内容如下：

可以看到 CopyOnWriteArrayList 的存储元素的数组array变量，使用了volatile关键字保证的多线程下数据可见行；同时，使用了ReentrantLock可重入锁对象，保证线程操作安全。

在初始化阶段，CopyOnWriteArrayList默认给数组初始化了一个对象，当然，初始化方法还有很多，比如如下我们经常会用到的一个初始化方法，源码内容如下：

这个方法，表示如果我们传入的是一个 ArrayList数组对象，会将对象内容复制一份到新的数组中，然后初始化进去，操作如下：

List<String> list = new ArrayList<>();
...
//CopyOnWriteArrayList将list内容复制出来，并创建一个新的数组
CopyOnWriteArrayList<String> copyList = new CopyOnWriteArrayList<>(list);

CopyOnWriteArrayList是对原数组内容进行复制再写入，那么是不是也存在多线程下操作也会发生冲突呢？

下面我们再一起来看看它的方法实现！

三、常用方法

3.1、添加元素

add()方法是CopyOnWriteArrayList的添加元素的入口！

CopyOnWriteArrayList之所以能保证多线程下安全操作， add()方法功不可没，源码如下：

操作步骤如下：

• 1、获得对象锁；
• 2、获取数组内容；
• 3、将原数组内容复制到新数组；
• 4、写入数据；
• 5、将array数组变量地址指向新数组；
• 6、释放对象锁；

在 Java 中，独占锁方面，有2种方式可以保证线程操作安全，一种是使用虚拟机提供的synchronized来保证并发安全，另一种是使用JUC包下的ReentrantLock可重入锁来保证线程操作安全。

CopyOnWriteArrayList使用了ReentrantLock这种可重入锁，保证了线程操作安全，同时数组变量array使用volatile保证多线程下数据的可见性！

其他的，还有指定下标进行添加的方法，如add(int index, E element)，操作类似，先找到需要添加的位置，如果是中间位置，则以添加位置为分界点，分两次进行复制，最后写入数据！

3.2、移除元素

remove()方法是CopyOnWriteArrayList的移除元素的入口！

源码如下：

操作类似添加方法，步骤如下：

• 1、获得对象锁；
• 2、获取数组内容；
• 3、判断移除的元素是否为数组最后的元素，如果是最后的元素，直接将旧元素内容复制到新数组，并重新设置array值；
• 4、如果是中间元素，以index为分界点，分两节复制；
• 5、将array数组变量地址指向新数组；
• 6、释放对象锁；

当然，移除的方法还有基于对象的remove(Object o)，原理也是一样的，先找到元素的下标，然后执行移除操作。

3.3、查询元素

get()方法是CopyOnWriteArrayList的查询元素的入口！

源码如下：

public E get(int index) {
    //获取数组内容，通过下标直接获取
    return get(getArray(), index);
}

查询因为不涉及到数据操作，所以无需使用锁进行处理！

3.4、遍历元素

上文中我们介绍到，基本都是在遍历元素的时候因为修改次数与迭代器中的修改次数不一致，导致检查的时候抛异常，我们一起来看看CopyOnWriteArrayList迭代器实现。

打开源码，可以得出CopyOnWriteArrayList返回的迭代器是COWIterator，源码如下：

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

打开COWIterator类，其实它是CopyOnWriteArrayList的一个静态内部类，源码如下：

可以看出，在使用迭代器的时候，遍历的元素都来自于上面的getArray()方法传入的对象数组，也就是传递进来的 array 数组！

由此可见，CopyOnWriteArrayList 在使用迭代器遍历的时候，操作的都是原数组，没有像上面那样进行修改次数判断，所以不会抛异常！

当然，从源码上也可以得出，使用CopyOnWriteArrayList的迭代器进行遍历元素的时候，不能调用remove()方法移除元素，因为不支持此操作！

如果想要移除元素，只能使用CopyOnWriteArrayList提供的remove()方法，而不是迭代器的remove()方法，这个需要注意一下！

四、总结

CopyOnWriteArrayList是一个典型的读写分离的动态数组操作类！

在写入数据的时候，将旧数组内容复制一份出来，然后向新的数组写入数据，最后将新的数组内存地址返回给数组变量；移除操作也类似，只是方式是移除元素而不是添加元素；而查询方法，因为不涉及线程操作，所以并没有加锁出来！

因为CopyOnWriteArrayList读取内容没有加锁，在写入数据的时候同时也可以进行读取数据操作，因此性能得到很大的提升，但是也有缺陷，对于边读边写的情况，不一定能实时的读到最新的数据，比如如下操作：

public static void main(String[] args) throws InterruptedException {
    final CopyOnWriteArrayList<String> list = new CopyOnWriteArrayList<>();
    list.add("a");
    list.add("b");
    for (int i = 0; i < 5; i++) {
        finalint j =i;
        new Thread(new Runnable() {
            @Override
            public void run() {
                //写入数据
                list.add("i-" + j);
                //读取数据
                for (String str : list) {
                    System.out.println("线程-" + Thread.currentThread().getName() + "，读取内容：" + str);
                }
            }
        }).start();
    }
}

新建5个线程向list中添加元素，执行结果如下：

可以看到，5个线程的读取内容有差异！

因此CopyOnWriteArrayList很适合读多写少的应用场景！

五、参考

1、JDK1.7&JDK1.8 源码

2、掘金 - 拥抱心中的梦想 - 说一说Java中的CopyOnWriteArrayList

精彩回顾：

新型冠状病毒最新疫情

阿粉带你3分钟看完关于树的故事

请认真对待自己和家人的生命