ArrayList分析

Posted 2020-12-20 01000001-world

ArrayList继承自AbstractList，实现了List, RandomAccess, Cloneable, java.io.Serializable接口。ArrayList内部是一个动态数组，与Java中的数组相比，它的容量能动态增长。

简述

ArrayList 是容量可变的非线程安全列表，使用数组实现，集合扩容时会创建更大的数组，把原有数组复制到新数组。支持对元素的快速随机访问，但插入与删除速度很慢。ArrayList 实现了 RandomAcess 标记接口，如果一个类实现了该接口，那么表示使用索引遍历比迭代器更快。

elementData是 ArrayList 的数据域，被 transient 修饰，序列化时会调用 writeObject 写入流，反序列化时调用 readObject 重新赋值到新对象的 elementData。原因是 elementData 容量通常大于实际存储元素的数量，所以只需发送真正有实际值的数组元素。

size 是当前实际大小，elementData 大小大于等于 size。

*modCount *记录了 ArrayList 结构性变化的次数，继承自 AbstractList。所有涉及结构变化的方法都会增加该值。expectedModCount 是迭代器初始化时记录的 modCount 值，每次访问新元素时都会检查 modCount 和 expectedModCount 是否相等，不相等就会抛出异常。这种机制叫做 fail-fast，所有集合类都有这种机制。

首先了解ArrayList内部的属性

 1 // 序列化id
 2 private static final long serialVersionUID = 8683452581122892189L;
 3 //ArrayList的初始容量大小
 4 private static final int DEFAULT_CAPACITY = 10;
 5 //空对象数组
 6 private static final Object[] EMPTY_ELEMENTDATA = {};
 7 //空对象数组，如果使用默认构造函数创建，则默认对象内容默认是该值 
 8 private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
 9 //存放当前数据，不参与序列化
10 transient Object[] elementData;
11 //list大小
12 private int size;
13 //list最大长度
14 private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

elementData：这是个 Object 类型的数组，用于存储具体元素，其表示的数组的大小。
size：用来记录 ArrayList 当前元素个数，默认为 0。

ArrayList构造方法

//默认构造方法，将elementData初始化为DEFAULTCAPACITY_EMPTY_ELEMENTD（及空数组）
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    //指定容量的构造方法，传入参数小于0抛出异常，否则创建指定容量的
    public ArrayList(int initialCapacity) {
      if (initialCapacity > 0) {
          this.elementData = new Object[initialCapacity];
      } else if (initialCapacity == 0) {
          this.elementData = EMPTY_ELEMENTDATA;
      } else {
          throw new IllegalArgumentException("Illegal Capacity: "+initialCapacity);
      }
    }
    /**
    *传入参数为Collection对象，先调用toArray()方法将Collection对象转换为Object[]
    *更新size的值，同时判断size的大小，如果是size等于0，直接将空对象EMPTY_ELEMENTDATA的地址赋给elementData
    *如果size的值大于0，则执行Arrays.copy方法，把collection对象的内容（可以理解为深拷贝）copy到elementData中，代码注释toArray可能不是返回Object[]，所以进行深拷贝
    **/
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

在初始化时调用了 ArrayList 的构造方法，这个构造方法只做了一件事，将 elementData 初始化为空数组。
在初次调用 add 方法时，ArrayList 会进行第一次扩容，将 elementData 扩容成容量为 10 的数组，然后再添加元素。
当 ArrayList 已经达到当前最大容量，会再次第二次扩容，将 elementData 扩容成容量为 1原有容量的 1.5 倍），然后再添加元素

其中在构造法方法中，DEFAULTCAPACITY_EMPTY_ELEMENTDATA 由前文可知是一个内部常量，值为空数组，也被用来作为空数组的标识。在后面调用 add 方法时也是通过这个常量来判断是否第一次调用。

ArrayList的方法

// 添加元素之前先检查容量，若容量不足则调用grow()方法，然后将元素添加到队尾，返回true
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }
    /**
    *首先检查index是否在size范围之内，确保数组已使用长度（size）加1之后足够存下一个数据
    *然后将index之后的元素全部向后挪一位，再进行赋值
    **/
    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是否超出范围，然后返回指定元素值
    **/
    public E get(int index) {
        rangeCheck(index);
        return elementData(index);
    }
    /**
    *首先判断index是否超出范围，然后将指定索引的数组元素赋值
    **/
    public E set(int index, E element) {
        rangeCheck(index);
 
        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }
    /**
    *首先判断index是否超出范围，numMoved 计算移除元素后需要移动的元素个数
    *通过System.arraycopy方法将后面的元素前移一位，并将最后一为赋值为null，最后返回移除元素的值
    */
    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);
        elementData[--size] = null; // clear to let GC do its work
 
        return oldValue;
    }
 
    /**
    *需要遍历整个list去匹配移除元素的值
    */
    public boolean remove(Object o) {
        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;
    }
 
    /**
    *需要遍历整个list去匹配元素值，然后返回第一个匹配元素的索引值，否则返回-1
    */
    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

ArrayList的主要方法

//minCapacity 最小即为初始容量大小10
    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        ensureExplicitCapacity(minCapacity);
    }
 
    //需求长度大于现在长度，则扩充数组长度
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
    /**
    *首先将oldCapacity 右移一位缩小1/2，newCapacity 扩大为oldCapacity 的1.5倍
    *如果newCapacity不能满足需求，那就直接扩大为minCapacity大小
    *如果newCapacity超过list最大容量，则返回Interger类型最大值
    *最后更新elementData
    **/
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

ensureCapacityInternal (int miniCapacity): 用于判断是否第一次调用，通过构造方法里用来赋值的常量 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 判断。

第一次调用：将所需最小容量（即 miniCapacity）设置为 10，然后调用 ensureExplicitCapacity 方法进行扩容
非第一次调用：直接调用 ensureExplicitCapacity 方法进行扩容

ensureExplicitCapacity (int minCapacity): 用于判断是否需要扩容

modCount 主要是在调用 iterator 方法时用来防止 list 被修改，在这里可以忽略不计

grow (int miniCapacity): 实际扩容操作