Java笔记---ArrayList源码分析

一、前言

一直就想看看java的源码，学习一下大牛的编程。这次下狠心花了几个晚上的时间，终于仔细分析了下 ArrayList 的源码（PS：谁说的一个晚上可以看完的？太瞎扯了）。现在记录一下所得。

二、ArrayList 源码分析

2.1 如何分析？

想要分析下源码是件好事，但是如何去进行分析呢？以我的例子来说，我进行源码分析的过程如下几步：

• 找到类：利用 Eclipse 找到所需要分析的类（此处就是 ArrayList）
• 新建类：新建一个类，命名为 ArrayList，将源码拷贝到该类。因为我们分析的时候肯定是需要进行代码注释，以及调试的，而jdk的源码，我们是没法在里面直接进行代码注释和断点调试的
• 修改类：我们刚拷贝过来的源码，肯定会报错的。报错原因比如：包名不匹配、继承的类中权限问题，因此我们需要对源码进行修改。
• 查看代码 + 测试案例 + 断点调试：前面准备好了，就到分析的过程了。分析，不仅仅是简单的看下代码，我们需要仔细思考，且辅以相应的测试案例，甚至于进行断点跟踪查看运行过程。

     

2.2 ArrayList 的分析

先直接将我对ArrayList的分析结果放出来，然后说一下其中的注意点。 注：本人的 JDK 是 1.8 的，因此 ArrayList 中有不少是 1.8 才支持的函数，用于函数式编程。不过本人函数式编程那部分没怎么学，因此函数式编程部分没怎么分析

// 注意：此处我们需要将 AbstractList 的源码拷贝到同包下的 AbstractList 类中
// 否则若是直接使用 java.util.AbstractList，会报错，因为我们无权访问 modCount。因
// 该变量的声明为 protected transient int modCount = 0;
/**
 * ArrayList 源码分析
 * - 继承：抽象类 java.util.AbstractList
 * - 实现：java.util.List，java.util.List，java.util.List，java.io.Serializable
 * - 本类的实现中，大量调用了 System.arraycopy()  和 Arrays.copyOf() 方法
 * 
 * 几个工具类：System、Arrays、Objects
 * @author johnnie
 * @time 2016年5月15日
 * @param 
 */
public class ArrayList  extends AbstractList implements List, RandomAccess, Cloneable, java.io.Serializable {

	/**
	 * 序列号
	 */
	private static final long serialVersionUID = 8683452581122892189L;

	/**
     * 默认容量
     */
    private static final int DEFAULT_CAPACITY = 10;

    /**
     * 一个空数组
     * - 当用户指定该 ArrayList 容量为 0 时，返回该空数组
     * - ArrayList(int initialCapacity)
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /**
     * 一个空数组实例
     * - 当用户没有指定 ArrayList 的容量时(即调用无参构造函数)，返回的是该数组==>刚创建一个 ArrayList 时，其内数据量为 0。
     * - 当用户第一次添加元素时，该数组将会扩容，变成默认容量为 10(DEFAULT_CAPACITY) 的一个数组===>通过  ensureCapacityInternal() 实现
     * 
     * 它与 EMPTY_ELEMENTDATA 的区别就是：该数组是默认返回的，而后者是在用户指定容量为 0 时返回
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     * ArrayList基于数组实现，用该数组保存数据, ArrayList 的容量就是该数组的长度
     * - 该值为 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 时，当第一次添加元素进入 ArrayList 中时，数组将扩容值 DEFAULT_CAPACITY(10)
     */
    transient Object[] elementData; // non-private to simplify nested class access

    /**
     * ArrayList实际存储的数据数量
     */
    private int size;

    /**
     * 创建一个初试容量的、空的ArrayList
     * - 可能报错： java.lang.OutOfMemoryError: Requested array size exceeds VM limit
     * @param  initialCapacity  初始容量
     * @throws IllegalArgumentException 当初试容量值非法(小于0)时抛出
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
        	// 数组缓冲区为 EMPTY_ELEMENTDATA，注意与 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 的区别
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+ initialCapacity);
        }
    }
    
    /**
     * 无参构造函数：
     * - 创建一个 空的 ArrayList，此时其内数组缓冲区 elementData = {}, 长度为 0
     * - 当元素第一次被加入时，扩容至默认容量 10
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    /**
     * Constructs a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     * 
     * 创建一个包含collection的ArrayList
     *
     * @param c 要放入 ArrayList 中的集合，其内元素将会全部添加到新建的 ArrayList 实例中
     * @throws NullPointerException 当参数 c 为 null 时抛出异常
     */
    public ArrayList(Collection c) {
        elementData = c.toArray();						// 集合转 Object[] 数组
        // 将转换后的 Object[] 长度赋值给当前 ArrayList 的 size，并判断是否为 0
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
        	// 这句话意思是：c.toArray 可能不会返回 Object[]，可以查看 java 官方编号为 6260652 的 bug
            if (elementData.getClass() != Object[].class)
            	// 若 c.toArray() 返回的数组类型不是 Object[]，则利用 Arrays.copyOf(); 来构造一个大小为 size 的 Object[] 数组
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
        	// 换成空数组
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

    /**
     * 将数组缓冲区大小调整到实际 ArrayList 存储元素的大小，即 elementData = Arrays.copyOf(elementData, size);
     * - 该方法由用户手动调用，以减少空间资源浪费的目的
     */
    public void trimToSize() {
    	// modCount 是 AbstractList 的属性值：protected transient int modCount = 0;
    	// [问] modCount 有什么用？
        modCount++;								
        // 当实际大小 < 数组缓冲区大小时
        // 如调用默认构造函数后，刚添加一个元素，此时 elementData.length = 10，而 size = 1
        // 通过这一步，可以使得空间得到有效利用，而不会出现资源浪费的情况
        if (size < elementData.length) {
        	// 注意这里：这里的执行顺序不是 (elementData = (size == 0) ) ? EMPTY_ELEMENTDATA : Arrays.copyOf(elementData, size);
        	// 而是：elementData = ((size == 0) ? EMPTY_ELEMENTDATA : Arrays.copyOf(elementData, size));
        	// 这里是运算符优先级的语法
        	// 调整数组缓冲区 elementData，变为实际存储大小 Arrays.copyOf(elementData, size)
            elementData = (size == 0) ? EMPTY_ELEMENTDATA : Arrays.copyOf(elementData, size);
        }
    }

    /**
     * 指定 ArrayList 的容量
     * @param   minCapacity   指定的最小容量
     */
    public void ensureCapacity(int minCapacity) {
    	// 最小扩充容量，默认是 10
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA) ? 0 : DEFAULT_CAPACITY;
        
        // 若用户指定的最小容量 > 最小扩充容量，则以用户指定的为准，否则还是 10
        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);	
        }
    }

    /**
     * 私有方法：明确 ArrarList 的容量，提供给本类使用的方法
     * - 用于内部优化，保证空间资源不被浪费：尤其在 add() 方法添加时起效
     * @param minCapacity    指定的最小容量
     */
    private void ensureCapacityInternal(int minCapacity) {
    	// 若 elementData == {}，则取 minCapacity 为 默认容量和参数 minCapacity 之间的最大值
    	// 注：ensureCapacity() 是提供给用户使用的方法，在 ArrayList 的实现中并没有使用
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);	
    }
    
    /**
     * 私有方法：明确 ArrayList 的容量
     * - 用于内部优化，保证空间资源不被浪费：尤其在 add() 方法添加时起效
     * @param minCapacity    指定的最小容量
     */
    private void ensureExplicitCapacity(int minCapacity) {
    	// 将“修改统计数”+1，该变量主要是用来实现fail-fast机制的 
        modCount++;

        // 防止溢出代码：确保指定的最小容量 > 数组缓冲区当前的长度
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    /**
     * 数组缓冲区最大存储容量
     * - 一些 VM 会在一个数组中存储某些数据--->为什么要减去 8 的原因
     * - 尝试分配这个最大存储容量，可能会导致 OutOfMemoryError(当该值 > VM 的限制时)
     */
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    /**
     * 私有方法：扩容，以确保 ArrayList 至少能存储 minCapacity 个元素
     * - 扩容计算：newCapacity = oldCapacity + (oldCapacity >> 1);	
     * @param minCapacity    指定的最小容量
     */
    private void grow(int minCapacity) {
    	// 防止溢出代码
        int oldCapacity = elementData.length;
        // 运算符 >> 是带符号右移. 如 oldCapacity = 10,则 newCapacity = 10 + (10 >> 1) = 10 + 5 = 15
        int newCapacity = oldCapacity + (oldCapacity >> 1);	
        if (newCapacity - minCapacity < 0)					// 若 newCapacity 依旧小于 minCapacity
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)			// 若 newCapacity 大于最大存储容量，则进行大容量分配
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

    /**
     * 私有方法：大容量分配，最大分配 Integer.MAX_VALUE
     * @param minCapacity
     * @return
     */
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE;
    }

    /**
     * 获取该 list 所实际存储的元素个数
     * @return list 所实际存储的元素个数
     */
    public int size() {
        return size;
    }

    /**
     * 判断 list 是否为空
     * @return ture？空：非空
     */
    public boolean isEmpty() {
        return size == 0;				// 直接看 size 是否为 0，没有先调用 size() 然后判断
    }

    /**
     * 判断该 ArrayList 是否包含指定对象(Object 类型)
     * - 面对抽象编程，向上转型是安全的
     * @param o 
     * @return true？包含：不包含
     */
    public boolean contains(Object o) {
    	// 根据 indexOf() 的值(索引值)来判断，大于等于 0 就包含
    	// 注意：等于 0 的情况不能漏，因为索引号是从 0 开始计数的
        return indexOf(o) >= 0;
    }

    /**
     * 顺序查找，返回元素的最低索引值(最首先出现的索引位置)
     * @return 存在？最低索引值：-1
     */
    public int indexOf(Object o) {
        if (o == null) {								// 注意：元素为 null 并非表示这是非法操作。空值也可以作为元素放入 ArrayList
            for (int i = 0; i < size; i++)		// 顺序查找数组缓冲区。注意：Arrays 工具类提供了二分搜索，但没有提供顺序查找
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    /**
     * 反向查找(从数组末尾向开始查找)，返回元素的最高索引值
     * @return 存在？最高索引值：-1
     */
    public int lastIndexOf(Object o) {
        if (o == null) {
            for (int i = size-1; i >= 0; i--)			// 逆序查找
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = size-1; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    /**
     * 深度复制：对拷贝出来的 ArrayList 对象的操作，不会影响原来的 ArrayList
     * @return 一个克隆的 ArrayList 实例(深度复制的结果)
     */
    public Object clone() {
        try {
        	// Object 的克隆方法：会复制本对象及其内所有基本类型成员和 String 类型成员，但不会复制对象成员、引用对象
            ArrayList v = (ArrayList) super.clone();
            // 对需要进行复制的引用变量，进行独立的拷贝：将存储的元素移入新的 ArrayList 中
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }
    }
    

    /**
     * 返回 ArrayList 的 Object 数组
     * - 包含 ArrayList 的所有储存元素
     * - 对返回的该数组进行操作，不会影响该 ArrayList（相当于分配了一个新的数组）==>该操作是安全的
     * - 元素存储顺序与 ArrayList 中的一致
     * @return 
     */
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

    /**
     * 返回 ArrayList 元素组成的数组
     * @param a 需要存储 list 中元素的数组
     * 若 a.length >= list.size，则将 list 中的元素按顺序存入 a 中，然后 a[list.size] = null, a[list.size + 1] 及其后的元素依旧是 a 的元素
     * 否则，将返回包含list 所有元素且数组长度等于 list 中元素个数的数组
     * 注意：若 a 中本来存储有元素，则 a 会被 list 的元素覆盖，且 a[list.size] = null
     * @return 
     * @throws ArrayStoreException 当 a.getClass() != list 中存储元素的类型时
     * @throws NullPointerException 当 a 为 null 时
     */
    @SuppressWarnings("unchecked")
    public  T[] toArray(T[] a) {
    	// 若数组a的大小 < ArrayList的元素个数,则新建一个T[]数组，数组大小是"ArrayList的元素个数",并将“ArrayList”全部拷贝到新数组中
        if (a.length < size)
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        
        // 若数组a的大小 >= ArrayList的元素个数,则将ArrayList的全部元素都拷贝到数组a中。
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
        	// a[list.size] = null
            a[size] = null;
        return a;
    }

    // Positional Access Operations
    
    /**
     * 返回在索引为 index 的元素：数组的随机访问 
     * - 默认包访问权限
     * 
     * 封装粒度很强，连数组随机取值都封装为一个方法。
     * 主要是避免每次取值都要强转===>设置值就没有封装成一个方法，因为设置值不需要强转
     * @param index
     * @return
     */
    @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }

    /**
     * 获取指定位置的元素：从 0 开始计数
     * @param  index 元素索引
     * @return 存储在 index 位置的元素
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E get(int index) {
        rangeCheck(index);					// 检查是否越界

        return elementData(index);		// 随机访问
    }

    /**
     * 设置 index 位置元素的值
     * @param index 索引值
     * @param element 需要存储在 index 位置的元素值
     * @return 替换前在 index 位置的元素值
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E set(int index, E element) {
        rangeCheck(index);							//  数组越界检查

        E oldValue = elementData(index);		// 取出旧值
        elementData[index] = element;			// 替换成新值
        return oldValue;
    }

    /**
     * 添加新值到 list 末尾
     * @param e 添加的值
     * @return true
     */
    public boolean add(E e) {
    	// 确定ArrayList的容量大小---严谨
    	// 注意：size + 1，保证资源空间不被浪费，按当前情况，保证要存多少个元素，就只分配多少空间资源
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 添加 e 到 ArrayList 中，然后 size 自增 1
        elementData[size++] = e;
        return true;
    }

    /**
     * 插入方法，其实应该命名为 insert() 比较合理
     * - 在指定位置插入新元素，原先在 index 位置的值往后移动一位
     * @param 要插入的位置
     * @param 要插入的元素
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public void add(int index, E element) {
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }

    /**
     * 移除指定索引位置的元素：index 之后的所有元素依次左移一位
     * @param index 
     * @return 被移出的元素
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E remove(int index) {
        rangeCheck(index);							// 越界检查

        modCount++;
        E oldValue = elementData(index);		// 旧值

        int numMoved = size - index - 1;		// 需要左移的元素个数
        if (numMoved > 0)
        	// 左移：利用 System.arraycopy() 进行左移一位的操作
        	// 将 elementData（源数组）从下标为 index+1 开始的元素，拷贝到 elementData（目标数组）下标为 index 的位置，总共拷贝 numMoved 个
            System.arraycopy(elementData, index+1, elementData, index, numMoved);
        elementData[--size] = null; 				// 将最后一个元素置空

        return oldValue;
    }

    /**
     * 删除 ArrayList 中的一个指定元素（符合条件的索引最低）
     * - 只会删除一个
     * - 删除的那个元素，是符合条件的结果中索引号最低的那个
     * - 若不包含要删除的元素，则返回 false
     * 
     * 相比 remove(index)：该方法并没有进行越界检查，即调用 rangeCheck() 
     * 
     * @param o 要删除的元素
     * @return true ? ArrayList中包含该元素，删除成功：不包含该元素，删除失败
     */
    public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {		// 判断是否存储了 null 
                    fastRemove(index);
                    return true;
                }
        } else {
        	 // 遍历ArrayList，找到“元素o”，则删除，并返回true
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {		// 利用 equals 判断两对象值是否相等（equals 比较值，== 比较引用）
                    fastRemove(index);
                    return true;
                }
        }
        
        return false;
    }

    /*
     * 私有方法：快速删除第 index 个元素
     * - 该方法会跳过越界检查
     */
    private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        // 左移操作
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        
        elementData[--size] = null; 		//  将最后一个元素设为null
    }

    /**
     * 清空所有存储元素
     * - 它会将数组缓冲区所以元素置为 null
     * - 清空后，我们直接打印 list，却只会看见一个 [], 而不是 [null, null, ....] ==> toString() 和 迭代器进行了处理
     */
    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }
    
    /** 
     * 将一个集合的所有元素顺序添加（追加）到 lits 末尾
     * - ArrayList 是线程不安全的。
     * - 该方法没有加锁，当一个线程正在将 c 中的元素加入 list 中，但同时有另一个线程在更改 c 中的元素，可能会有问题
     * @param c collection containing elements to be added to this list
     * @return true ？ list 元素个数有改变时，成功：失败
     * @throws NullPointerException 当 c 为 null 时
     */
    public boolean addAll(Collection c) {
        Object[] a = c.toArray();								// 若 c 为 null，此行将抛出空指针异常
        int numNew = a.length;							// 要添加的元素个数
        ensureCapacityInternal(size + numNew);  // 扩容，Increments modCount
        System.arraycopy(a, 0, elementData, size, numNew);	// 添加
        size += numNew;
        
        return numNew != 0;
    }

    /**
     * 从 index 位置开始，将集合 c 中的元素添加到ArrayList
     * - 并不会覆盖掉在 index 位置原有的值
     * - 类似于 insert 操作，在 index 处插入 c.length 个元素（原来在此处的 n 个元素依次右移）
     * @param index 插入位置
     * @param c 
     * @return true ？ list 元素个数有改变时，成功：失败
     * @throws IndexOutOfBoundsException {@inheritDoc}
     * @throws NullPointerException 当 c 为 null 时
     */
    public boolean addAll(int index, Collection c) {
        rangeCheckForAdd(index);						// 越界检查

        Object[] a = c.toArray();								// 空指针异常抛出点
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // 扩容，Increments modCount

        int numMoved = size - index;					// 要移动的元素个数
        /* 
         * 先元素移动，在拷贝，以免被覆盖
         */
        if (numMoved > 0)									
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }

    /**
     * Removes from this list all of the elements whose index is between
     * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
     * Shifts any succeeding elements to the left (reduces their index).
     * This call shortens the list by {@code (toIndex - fromIndex)} elements.
     * (If {@code toIndex==fromIndex}, this operation has no effect.)
     * 
     * 删除fromIndex到toIndex之间的全部元素
     * 
     * @throws IndexOutOfBoundsException if {@code fromIndex} or
     *         {@code toIndex} is out of range
     *         ({@code fromIndex < 0 ||
     *          fromIndex >= size() ||
     *          toIndex > size() ||
     *          toIndex < fromIndex})
     */
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        /*
         * 利用 System.arraycopy() 进行元素拷贝，再让失去价值的元素置为 null
         */
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);		// 删除后，list 的长度
        for (int i = newSize; i < size; i++) {				// 清除失去价值的元素
            elementData[i] = null;
        }
        size = newSize;
    }

    /**
     * 
     * - 提供给 get()、remove() 等方法：检查给出的索引值 index 是否越界(大于或等于 list.size)
     * 注：该方法并没有检查 index 是否合法（如小于 0，这个是由数组类型自己检查的）
     */
    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 提供给 add() 和 add() 进行数组越界检查的方法
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 返回异常消息，用于传给 IndexOutOfBoundsException
     */
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

    /**
     * 移除 list 中和 c 中共有的元素
     * - 若实例化 Collection 的类不是 ArrayList，则删除肯定失败
     * 
     * @param c 
     * @return true ？ 若 c 和 list 有公有元素，删除成功(或list元素个数有改变) ： 没有公有元素，删除失败
     * @throws ClassCastException
     * @throws NullPointerException 若 c 为 null 时
     * @see Collection#contains(Object)
     */
    public boolean removeAll(Collection c) {
        Objects.requireNonNull(c);				// 当 c == null，则改行抛出空指针异常
        return batchRemove(c, false);
    }

    /**
     * 只保留 list 和 集合 c 中公有的元素：和 removeAll() 功能相反
     * @param c 
     * @return true ？ list 元素个数有改变
     * @throws ClassCastException 
     * @throws NullPointerException 
     * @see Collection#contains(Object)
     */
    public boolean retainAll(Collection c) {
        Objects.requireNonNull(c);
        return batchRemove(c, true);
    }

    /**
     * 批量删除
     * @param c
     * @param complement 是否取补集
     * @return
     */
    private boolean batchRemove(Collection c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;
        boolean modified = false;
        try {
            for (; r < size; r++)
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // Preserve behavioral compatibility with AbstractCollection,
            // even if c.contains() throws.
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
                // clear to let GC do its work
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }

    /**
     * 序列化函数
     * @serialData 
     */
    private void writeObject(ObjectOutputStream s) throws IOException{
        int expectedModCount = modCount;
        s.defaultWriteObject();

        // 写入ArrayList大小 
        s.writeInt(size);

        // 写入存储的元素
        for (int i=0; i

2.3 ArrayList 特别注意

在对ArrayList进行分析的过程中，发现 ArrayList 有很多需要仔细考虑的重点。基本上，刚刚的代码里都写上了这些点。但是还是总结一下。如下所示：

(1) ArrayList 基于数组实现，其内存储元素的数组为 elementData

elementData 的声明为：transient Object[] elementData;

(2) ArrayList 中EMPTY_ELEMENTDATA 和 DEFAULTCAPACITY_EMPTY._ELEMENTDATA 的使用

这两个常量，使用场景不同。前者是用在用户通过 ArrayList(int initialCapacity) 该构造方法直接指定初试容量为 0 时，后者是用户直接使用无参构造创建 ArrayList 时。

(3) ArrayList 默认容量为 10。

调用无参构造新建一个 ArrayList 时，其 elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA, 当第一次使用 add() 添加元素时，ArrayList的容量会为 10。

minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);

(4) ArrayList 的扩容计算为 newCapacity = oldCapacity + (oldCapacity >> 1); 且扩容并非是无限制的，有内存限制、虚拟机限制。

(5) ArrayList 的 toArray() 方法和 subList() 方法，在源数据和子数据之间的区别

• toArray()：对该方法返回的数组，进行操作（增删改查）都不会影响源数据(ArrayList中elementData)。二者之间是不会相互影响的
• subList()：对返回的子集合，进行操作(增删改查)都会影响父集合。而且若是对父集合中进行删除操作（仅仅在删除子集合的首个元素）时，会抛出异常 java.util.ConcurrentModificationException

(6) 对 ArrayList 进行操作(如 add()、clear())后，即使 elementData 实际上的长度 > 其内元素个数，但是再直接打印该list时，显示结果还是[x,x,x] (注：x 代表其内实际(或有效)存储的元素)

对于 elementData 中存储情况和直接打印list (即System.out.println(list))结果不一致的原因，是因为 AbstractCollection 中对 toString() 进行了定义。代码如下：

 public String toString() {
        Iterator it = iterator();
        if (! it.hasNext())
            return "[]";

        StringBuilder sb = new StringBuilder();
        sb.append('[');
        for (;;) {
            E e = it.next();
            sb.append(e == this ? "(this Collection)" : e);
            if (! it.hasNext())
                return sb.append(']').toString();
            sb.append(',').append(' ');
        }
    }

(7) ArrayList 中 源码关于 toArray() 官方 bug 的问题

在源码中，对于 toArray() 有一个官方 bug，对于这个的说明，请看 官方bug 6260652

Note: 前往 bascker/javaworld 获取更多 Java 知识