Java集合之ArrayList常用方法解析

  最近正准备回顾一下Java，所以在此做一些记录。

ArrayList作为Java的基础集合，因支持动态的扩容而经常被使用，下面记录一下其常用方法的实现

1. add(E e) 在集合末尾新增一个元素

 /**
     * 添加一个元素
     *
     * @param e 所要添加的元素
     * @return
     */
    public boolean add(E e) {
        //将会进行判断数组是否是要扩容，需要的话将会进行扩容
        ensureCapacityInternal(size + 1);
        //存放元素，size表示当前集合中元素的个数
        elementData[size++] = e;
        return true;
    }

/**
     * 判断该集合是否满足最小容量并进行扩容
     * @param minCapacity 最小容量
     */
    private voidensureCapacityInternal (int minCapacity) {
        if (elementData == EMPTY_ELEMENTDATA) {
            //如果本来就是空数组，则根据默认值和当前所需的最小容量取一个最大值作为新数组的大小
            //DEFAULT_CAPACITY = 10， 所以如果新建一个没有指定大小的集合，添加第一个元素后集合大小变成10
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        //扩容
        ensureExplicitCapacity(minCapacity);
    }

 /**
     * 判断当前集合大小是否需要扩容
     * @param minCapacity 最小容量
     */
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // 如果最小容量大于当前数组大小，则进行真正的扩容操作
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

 /**
     * 真正的扩容操作
     *
     * @param minCapacity 最小容量
     */
    private void grow(int minCapacity) {
        // 获取旧数组的值
        int oldCapacity = elementData.length;
        //先将旧数组扩充1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //判断旧数组扩充1.5倍是否够用，不够就使用传入的最小容量
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //判断是否为超大数组 MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // 使用Arrays.copyOf来生成新的数组
        // 里面也是新创建了一个数组，使用System.arraycopy将旧数组的数据迁移到新数组中
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

 /**
     *  超大数组的判断
     *
     * @param minCapacity
     * @return
     */
    private static int hugeCapacity(int minCapacity) {
        //判断minCapacity是否已经溢出了，超过了int的最大值
        if (minCapacity < 0)
            throw new OutOfMemoryError();
        //超过MAX_ARRAY_SIZE则返回int最大值，否则返回MAX_ARRAY_SIZE
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

 2.add(int index, E element) 在指定位置添加元素

 /**
     * 指定位置添加元素
     *
     * @param index 指定元素的位置
     * @param element 添加的元素
     */
    public void add(int index, E element) {
        //判断需要插入的位置是否越界
        rangeCheckForAdd(index);
        //和add一样的扩容操作
        ensureCapacityInternal(size + 1);
        //直接使用了System.arraycopy，将指定位置之后的元素往后移动一位
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        //插入指定的元素
        elementData[index] = element;
        //元素个数增加
        size++;
    }

 /**
     * 判断指定的位置是否越界
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

3.get(int index）获取指定位置的元素

/**
     * 获取指定位置处的元素
     *
     * @param  index 指定的位置
     * @return 返回该位置的元素
     */
    public E get(int index) {
        //判断是否越界
        rangeCheck(index);
        //获取元素
        return elementData(index);
    }

private void rangeCheck(int index) {
        //判断是否超出
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

4.remove(int index) 删除指定位置的元素 

 /**
     * 删除指定位置的元素
     *
     * @param index 指定的位置
     * @return 返回删除的元素
     */
    public E remove(int index) {
        //判断指定的位置是否越界
        rangeCheck(index);

        modCount++;
        //获取到该元素
        E oldValue = elementData(index);

        //计算需要移动的元素个数
        int numMoved = size - index - 1;
        //使用System.arraycopy将删除位置之后的元素往前移动
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //元素个数减1并制设置空
        elementData[--size] = null;

        return oldValue;
    }

5.remove(Object o) 删除指定元素

 /**
     * 删除指定元素，只删除从头开始第一个匹配的
     *
     * @param o 需要删除的元素
     */
    public boolean remove(Object o) {
        //判断是否为null
        if (o == null) {
            //遍历
            for (int index = 0; index < size; index++)
                //判断是否为null
                if (elementData[index] == null) {
                    //删除
                    fastRemove(index);
                    return true;
                }
        } else {
            //不为null也是遍历
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    //删除
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

 /*
     * 删除指定位置元素
     * 和remove方法差不多，只是少了越界判断和旧元素的返回
     */
    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;
    }

6.indexOf(Object o) 查询指定元素的位置  lastIndexOf也一样，只是从尾部开始遍历

  /**
     * 查询指定元素的位置
     * @param o 指定的元素
     * @return 所在位置索引
     */
    public int indexOf(Object o) {
        //判断元素值是否为null
        if (o == null) {
            //从头开始遍历
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            //不为null，从头开始遍历
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

7.set(int index, E element) 设置指定位置的元素值

 /**
     * 设置指定位置的元素值
     *
     * @param index 指定的位置
     * @param element 元素值
     * @return 返回旧值
     */
    public E set(int index, E element) {
        //判断是否越界
        rangeCheck(index);
        //通过索引设置新值
        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

 private void rangeCheck(int index) {
        //判断是否超出
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

8.retainAll(Collection<?> c) 求两个集合的交集

 /**
     * 求两个集合的交集
     * @param c
     * @return
     */
    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++)
                //根据complement的值保留元素
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // r != size 应该是上面的循环抛出异常了
            //正常循环应该r == size
            //将异常之后的数据保留
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            //w！=size，说明集合数量有变动
           // 清空一些元素值并重新设置size大小
            if (w != size) {
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }                            

总结一下

1.ArrayList作为集合，根据索引查询的速度最快，如果需要查询指定元素，需要遍历，并不会很快

2.ArrayList使用的时候最好指定集合大小，否则插入操作多的话会经常需要扩容，需要进行数组的复制，比较慢

3.ArrayList的删除元素和插入指定位置的元素会存在部分元素迁移的情况，如果数据量大也会有影响