JDK 8 ArrayList 源码解析

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/Insert_day/article/details/89256634

【本文是为了梳理知识的总结性文章,总结了一些自认为相关的重要知识点,只为巩固记忆以及技术交流,忘批评指正。其中参考了很多前辈的文章,包括图片也是引用,如有冒犯,侵删。】

0 存储结构

从底层实现来看,Array是数组实现的,与数组不同的是,其容量是可以改变的。集合扩容的时候会创建更大的数组空间,把原有数据复制到新数组中。ArrayList支持对元素的快速随机访问,但是插入和删除 时速度通常很慢,因为这个过程很有可能需要移动其他元素。

1 类定义

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable

2 静态常量

    // 默认初始容量大小
    private static final int DEFAULT_CAPACITY = 10;

    // 空数组(用于空实例)
    private static final Object[] EMPTY_ELEMENTDATA = {};

    // 用于默认大小空实例的共享空数组实例。
    // 我们把它从EMPTY_ELEMENTDATA数组中区分出来,以知道在添加第一个元素时容量需要增加多少。
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    // 数组能够分配的理论上的最大值
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

3 属性

    /**
     * 保存ArrayList数据的数组
     */
    transient Object[] elementData; // non-private to simplify nested class access

    /**
     * ArrayList 所包含的元素个数
     */
    private int size;

4 构造函数

主要用于初始化数组。

    /**
     * 带初始容量参数的构造函数。
     */
    public ArrayList(int initialCapacity) {
        // initialCapacity > 0,则直接创建相应长度的数组
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            // 使用EMPTY_ELEMENTDATA表示创建了空数组
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

    /**
     * 默认构造函数,使用DEFAULTCAPACITY_EMPTY_ELEMENTDATA表示为空数组.
     * 当添加第一个元素后才会真正分配一个长度为10的数组
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    /**
     * 按照它们由集合的迭代器返回的顺序,构造一个包含指定集合的元素的列表。
     */
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        // 如果指定集合元素个数不为0
        if ((size = elementData.length) != 0) {
            // 判断c.toArray 是否返回Object类型的数组,不是的话用Arrays.copyOf复制
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // 用空数组代替
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

 

5 常用方法

add方法

  1. 确保数组能够放下该元素,容量不够则扩容;
  2. 将指定的元素追加到此列表的末尾
public boolean add(E e) {
        // 判断是否需要扩容,需要则使用grow方法扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 将指定的元素追加到此列表的末尾
        elementData[size++] = e;
        return true;
    }

 判断是否需要扩容,需要则调用grow()方法扩容

    // 得到最小扩容量
    private void ensureCapacityInternal(int minCapacity) {
        // elementData  == DEFAULTCAPACITY_EMPTY_ELEMENTDATA表示目前数组长度是默认长度10
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            // 看新增一个节点后长度是否比默认长度大
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        ensureExplicitCapacity(minCapacity);
    }
    
    //判断是否需要扩容
    private void ensureExplicitCapacity(int minCapacity) {
        // 新增属于结构性修改
        modCount++;
        
        // 如果比当前数组长度大,则需要扩容
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

扩容方法

  1. 确定新容量的大小,首先扩大到1.5倍,如果不够用则直接使用所需的容量;
  2. 如果所需容量超过了理论上分配的最大值,则使用最大容量;
  3. 复制数组到新容量的新数组中。
    // ArrayList扩容方法
    private void grow(int minCapacity) {
        // oldCapacity为旧容量,newCapacity为新容量
        int oldCapacity = elementData.length;
        // 新容量为救容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 新容量还是不满足要求,则直接使用minCapacity作为新容量
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        // 新容量如果大于ArrayList所定义的最大容量,则将其设置为MAX_ARRAY_SIZE
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // 使用复制Arrays.copyOf 复制到新数组
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

数组复制方法

源码中有时候会用Arrays.copyOf()方法,有时候会用System.arraycopy()方法进行数组复制,其实Arrays.copyOf()方法底层是调用了System.arraycopy()方法,而System.arraycopy()方法是一个Native方法。

Arrays.copyOf(T[] original, int newLength)方法

复制指定的original 数组,以使长度为newLength。
原数组中有效的值将包含在新数组中,新数组多出来的部分为null。

底层实现调用了 System.arraycopy(original, 0, copy, 0, Math.min(original.length, newLength));

System.arraycopy(Object src,  int  srcPos, Object dest, int destPos,int length)方法

将原数组src从原数组起始位置srcPos复制到目的数组dest的destPos位置,复制长度为length。

参数 说明
src 原数组
srcPos 原数组起始位置
dest 目标数组
destPos 目标数组的起始位置
length 要复制的数组元素的数目
// Arrays.copy方法源码
public static <T> T[] copyOf(T[] original, int newLength) {
        return (T[]) copyOf(original, newLength, original.getClass());
    }

// 底层使用了使用System.arraycopy()方法,将旧数组数据复制到新数组
public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        // 声明一个长度为newLength的新数组
        @SuppressWarnings("unchecked")
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
        //
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }

// 是一个native方法
public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos,
                                        int length);

get方法

  1. 简单检查index是否大于数组长度;
  2. 直接返回该元素。
    /**
     * 返回 ArrayList 中指定位置的元素。
     */
    public E get(int index) {
        // 对index进行数组边界检查
        rangeCheck(index);
        // 直接返回该位置的元素
        return elementData(index);
    }
    
    // 只检查了是否大于数组长度
    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

remove方法

  1. 索引边界检查
  2. 自增修改次数
  3. 将index上的元素保存到oldValue
  4. 将index上的元素都往前移动一位
  5. 将最后面的一个元素置空,好让垃圾回收器回收
  6. 将原来的值oldValue返回
// 删除该ArrayList指定位置的元素
public E remove(int index) {
        // 边界检查
        rangeCheck(index);

        modCount++;
        E oldValue = elementData(index);
        // 计算需要移动的元素个数
        int numMoved = size - index - 1;
        // 将index后面的元素向前移动一位 
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        // 将最后一位置为null,帮助GC
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

remove指定对象方法

  1. 根据对象是否为空有两种处理逻辑;
  2. 移除对象为空则依次查找第一个为null的对象,然后进行移除;
  3. 移除对象不为空则依次查找,找到相等的元素进行移除。
// 移除指定对象
public boolean remove(Object o) {
        // 根据对象是否为空有两种处理逻辑
        // 移除对象为空则依次查找第一个为null的对象
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
        // 移除对象不为空则依次查找相对的元素进行移除
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

// 跳过检查直接移除指定位置的元素,逻辑和remove(int 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; // clear to let GC do its work
    }

最佳实践

  1. 预估使用场景所需的容量,并设置为初始值,防止多次扩容,影响性能(尤其在数据量大的时候);
  2.  

参考文献

  1. https://zhuanlan.zhihu.com/p/34443888
  2. 《码出高效 Java开发手册》

猜你喜欢

转载自blog.csdn.net/Insert_day/article/details/89256634