CopyOnWriteArrayList随笔

CopyOnWriteArrayList内部操作

 

特点 

• 多占用内存： 写数据时是copy了一份完整的数据，单独进行操作
• 数据一致性：操作完数据，其他线程不一定能马上读取到最新数据 (只能保证最终数据一致性，不能保证数据实时一致)

主要的成员 

    /**写时候需要的锁*/
    final transient ReentrantLock lock = new ReentrantLock();

    /**数据存储的位置*/
    private transient volatile Object[] array;

构造方法 

 

    /**
     * 默认是创建一个空的数组
     */
    public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }

    //给定一个数组，需要做数组的拷贝
    public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
    }
    
    //给定一个集合
    public CopyOnWriteArrayList(Collection<? extends E> c) {
        Object[] elements;
        //需要判断是否是当前CopyOnWriteArrayList对象
        if (c.getClass() == CopyOnWriteArrayList.class)
            elements = ((CopyOnWriteArrayList<?>)c).getArray();//如果是直接赋值操作
        else {
            //将集合转换成数组
            elements = c.toArray();
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            //如果不是Object数组进行数组拷贝
            if (elements.getClass() != Object[].class)
                elements = Arrays.copyOf(elements, elements.length, Object[].class);
        }
        //赋值数组
        setArray(elements);
    }

add()方法

•  加锁处理
• 将数组拷贝到一个新的数组(长度为原长度+1)上
• 将要添加的元素放在数组最后一个元素上
• 重新赋值数组

 

    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();//释放锁
        }
    }

 public void add(int index, E element) {
        final ReentrantLock lock = this.lock;
        lock.lock();//加锁
        try {
            Object[] elements = getArray();
            int len = elements.length;
            //索引判断
            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];
                //将指定索引位置前后的数组元素拷贝到新数组上
                System.arraycopy(elements, 0, newElements, 0, index);
                System.arraycopy(elements, index, newElements, index + 1,
                                 numMoved);
            }
            //设置索引上元素
            newElements[index] = element;
            setArray(newElements);//赋值数组
        } finally {
            lock.unlock();//释放锁
        }
    }

addIfAbsent() 如果不存在就添加

    public boolean addIfAbsent(E e) {
        Object[] snapshot = getArray();//获取了一个快照
        return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
            addIfAbsent(e, snapshot);
    }

    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;
            }
            //数组拷贝
            Object[] newElements = Arrays.copyOf(current, len + 1);
            newElements[len] = e;//赋值
            setArray(newElements);
            return true;
        } finally {
            lock.unlock();//释放锁
        }
    }

set()方法 

//有锁操作
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();
        }
    }

get()方法 

  public E get(int index) {
        return get(getArray(), index);
  }
  
  private E get(Object[] a, int index) {
        return (E) a[index];//直接从数组中返回
  }

PS : 该类适应在写多读少的场景