并发容器之CopyOnWriteArrayList

前言

Copy-On-Write简称COW，是一种用于程序设计中的优化策略。其基本思路是，从一开始大家都在共享同一个内容，当某个人想要修改这个内容的时候，才会真正把内容Copy出去形成一个新的内容然后再改，这是一种延时懒惰策略。从JDK1.5开始Java并发包里提供了两个使用CopyOnWrite机制实现的并发容器,它们是CopyOnWriteArrayList和CopyOnWriteArraySet。CopyOnWrite容器非常有用，可以在非常多的并发场景中使用到。

---

什么是CopyOnWrite容器

• CopyOnWrite容器即写时复制的容器。通俗的理解是当我们往一个容器添加元素的时候，不直接往当前容器添加，而是先将当前容器进行Copy，复制出一个新的容器，然后新的容器里添加元素，添加完元素之后，再将原容器的引用指向新的容器。这样做的好处是我们可以对CopyOnWrite容器进行并发的读，而不需要加锁，因为当前容器不会添加任何元素。所以CopyOnWrite容器也是一种读写分离的思想，读和写不同的容器。

CopyOnWriteArrayList的实现原理

• 在使用CopyOnWriteArrayList之前，我们先阅读其源码了解下它是如何实现的。以下代码是向CopyOnWriteArrayList中add方法的实现（向CopyOnWriteArrayList里添加元素），可以发现在添加的时候是需要加锁的，否则多线程写的时候会Copy出N个副本出来。

    /**
     * Appends the specified element to the end of this list.
     *
     * @param e element to be appended to this list
     * @return <tt>true</tt> (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            Object[] elements = getArray();
            int len = elements.length;
            //复制一个新的数组
            Object[] newElements = Arrays.copyOf(elements, len + 1);
            newElements[len] = e;
            //将引用指向新的数据
            setArray(newElements);
            return true;
        } finally {
            lock.unlock();
        }
    }

• 读的时候不需要加锁，如果读的时候有多个线程正在向CopyOnWriteArrayList添加数据，读还是会读到旧的数据，因为写的时候不会锁住旧的CopyOnWriteArrayList。

    /**
     * {@inheritDoc}
     *
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E get(int index) {
        return get(getArray(), index);
    }

• JDK中并没有提供CopyOnWriteMap，我们可以参考CopyOnWriteArrayList来实现一个，
  基本代码如下：

package com.zeng.copyOnWrite;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * 方腾飞提供的copyOnWritMap
 * 
 * @author leo-zeng
 *
 */
public class CopyOnWriteMap<K,V> implements Map<K, V>,Cloneable {
    /**
     * 保证所有的线程都是可见的
     */
    private volatile Map<K,V> internalMap;

    public CopyOnWriteMap() {
        this.internalMap =new HashMap<K, V>();
    }

    public CopyOnWriteMap(int i) {
        this.internalMap =new HashMap<K, V>(i);
    }

    @Override
    public int size() {
        return internalMap.size();
    }

    @Override
    public boolean isEmpty() {
        return internalMap.isEmpty();
    }

    @Override
    public boolean containsKey(Object key) {

        return internalMap.containsKey(key);
    }

    @Override
    public boolean containsValue(Object value) {
        return internalMap.containsKey(value);
    }

    @Override
    public V get(Object key) {
        //copyOnWrite 中对应的读，还是读取木有复制的map
        return internalMap.get(key);
    }

    @Override
    public V put(K key, V value) {
        //给该对象枷锁
        synchronized (this) {
            //先复制出一个map
            Map<K,V> map =new HashMap<K, V>(internalMap);
            V val =map.put(key, value);
            //放好之后，再将引用指向新的地址
            internalMap =map;
            return val;
        }
    }

    @Override
    public V remove(Object key) {
        synchronized (this) {
            //先复制出一个map
            Map<K,V> map =new HashMap<K, V>(internalMap);
            V val =map.remove(key);
            internalMap =map;
            //删好之后，再讲引用指向新的地址
            return val;
        }
    }

    @Override
    public void putAll(Map<? extends K, ? extends V> m) {
        //给该对象枷锁
                synchronized (this) {
                    //先复制出一个map
                    Map<K,V> map =new HashMap<K, V>(internalMap);
                    map.putAll(m);
                    //放好之后，再将引用指向新的地址
                    internalMap =map;
                }
    }

    @Override
    public void clear() {
    }

    @Override
    public Set<K> keySet() {
        return internalMap.keySet();
    }

    @Override
    public Collection<V> values() {
        return internalMap.values();
    }

    @Override
    public Set<java.util.Map.Entry<K, V>> entrySet() {
        return internalMap.entrySet();
    }

}

实现很简单，只要了解了CopyOnWrite机制，我们可以实现各种CopyOnWrite容器，并且在不同的应用场景中使用。

---

CopyOnWrite的应用场景

• CopyOnWrite并发容器用于读多写少的并发场景。比如白名单，黑名单，商品类目的访问和更新场景，假如我们有一个搜索网站，用户在这个网站的搜索框中，输入关键字搜索内容，但是某些关键字不允许被搜索。这些不能被搜索的关键字会被放在一个黑名单当中，黑名单每天晚上更新一次。当用户搜索时，会检查当前关键字在不在黑名单当中，如果在，则提示不能搜索。
• 实现代码如下：

package com.zeng.copyOnWrite;

import java.util.Map;

/**
 * 方腾飞提供的实例：
 * 　CopyOnWrite并发容器用于读多写少的并发场景。
 * 比如白名单，黑名单，商品类目的访问和更新场景，
 *      假如我们有一个搜索网站，用户在这个网站的搜索框中，输入关键字搜索内容，但是某些关键字不允许被搜索。
 *      这些不能被搜索的关键字会被放在一个黑名单当中，黑名单每天晚上更新一次。当用户搜索时，会检查当前关键字在不在黑名单当中，如果在，则提示不能搜索。
 * @author leo-zeng
 *
 */
public class BlackListServiceImpl {
    //设置
    private static  CopyOnWriteMap<String, Boolean> blackListMap = new CopyOnWriteMap<String, Boolean>(1000);
    /**
     * 是否在黑名单中
     * @param keyId
     */
    public static boolean isInBlackList(String keyId){
        return blackListMap.get(keyId)==null?false:true;
    }
    /**
     * 添加到黑名单中
     * @param keyId
     */
    public static void addBlackList(String keyId){
        blackListMap.put(keyId, Boolean.TRUE);
    }
    /**
     * 批量添加到黑名单中
     * @param m
     */
    public static void addAllBlackList(Map<String,Boolean> m){
        blackListMap.putAll(m);
    }
}

代码很简单，但是使用CopyOnWriteMap需要注意两件事情：

　　1. 减少扩容开销。根据实际需要，初始化CopyOnWriteMap的大小，避免写时CopyOnWriteMap扩容的开销。

　　2. 使用批量添加。因为每次添加，容器每次都会进行复制，所以减少添加次数，可以减少容器的复制次数。如使用上面代码里的addBlackList方法。

---

CopyOnWrite的缺点

• CopyOnWrite容器有很多优点，但是同时也存在两个问题，即内存占用问题和数据一致性问题。所以在开发的时候需要注意一下。

  1. 内存占用问题。因为CopyOnWrite的写时复制机制，所以在进行写操作的时候，内存里会同时驻扎两个对象的内存，旧的对象和新写入的对象（注意:在复制的时候只是复制容器里的引用，只是在写的时候会创建新对象添加到新容器里，而旧容器的对象还在使用，所以有两份对象内存）。如果这些对象占用的内存比较大，比如说200M左右，那么再写入100M数据进去，内存就会占用300M，那么这个时候很有可能造成频繁的Yong GC和Full GC。之前我们系统中使用了一个服务由于每晚使用CopyOnWrite机制更新大对象，造成了每晚15秒的Full GC，应用响应时间也随之变长。
  2. 针对内存占用问题，可以通过压缩容器中的元素的方法来减少大对象的内存消耗，比如，如果元素全是10进制的数字，可以考虑把它压缩成36进制或64进制。或者不使用CopyOnWrite容器，而使用其他的并发容器，如ConcurrentHashMap。
  3. 数据一致性问题。CopyOnWrite容器只能保证数据的最终一致性，不能保证数据的实时一致性。所以如果你希望写入的的数据，马上能读到，请不要使用CopyOnWrite容器。

---

注：本文转自并发编程网http://ifeve.com/java-copy-on-write/