集合框架 （第 03 篇） 源码分析：ArrayList

一、集合框架源码分析

• 集合框架 （第 01 篇） 源码分析：Collection 框架总览
• 集合框架 （第 02 篇） 源码分析：Map 框架总览
• 集合框架 （第 03 篇） 源码分析：ArrayList
• 集合框架 （第 04 篇） 源码分析：LinkedList
• 集合框架 （第 05 篇） 源码分析：Map接口与其内部接口Entry
• 集合框架 （第 06 篇） 源码分析：哈希冲突(哈希碰撞)与解决算法
• 集合框架 （第 07 篇） 源码分析：jdk1.7版 HashMap
• 集合框架 （第 08 篇） 源码分析：HashMap、Hashtable、ConcurrentHashMap之间的区别
• 集合框架 （第 09 篇） 源码分析：jdk1.7版 ConcurrentHashMap
• 集合框架 （第 10 篇） 源码分析：二叉树、平衡二叉树、二叉查找树、AVL树、红黑树
• 集合框架 （第 11 篇） 源码分析：jdk1.8版 HashMap
• 集合框架 （第 12 篇） 源码分析：jdk1.8版 ConcurrentHashMap
• 集合框架 （第 13 篇） 源码分析：LinkedHashMap
• 集合框架 （第 14 篇） 源码分析：TreeMap
• 集合框架 （第 15 篇） 源码分析：Set 集合
• 集合框架 （第 16 篇） 源码分析：BlockingQueue 接口
• 集合框架 （第 17 篇） 源码分析：CopyOnWriteArrayList 与 CopyOnWriteArraySet

原文持续更新链接: https://github.com/about-cloud/JavaCore

正文

---

本文关注点

★★★★★本文重点：ArrayList自动扩容机制（1.5倍或1.5倍-1 扩容）

---

一、ArrayList

ArrayList是动态数组，其动态性体现在能够动态扩容 、动态缩容。（其原理是构建一个新Object数组，将原数组复制进去。借助 Arrays.copyOf(T[] original, int newLength)） 。

ArrayList继承关系

重要的属性

// 默认初始容量为 10（当ArrayList的容量低于9时才会用到）
private static final int DEFAULT_CAPACITY = 10;
// 存放数据的数组，数组的每个位置并不一定都填充数据，用transient修饰避免序列化、避免浪费资源
transient Object[] elementData;
// 记录实际存放的元素个数
private int size;
// 记录着ArrayList的修改次数,也就每次add或remove，它的值都会加1
protected transient int modCount = 0;

1.1、一般添加元素的方法 public boolean add(E e)

public boolean add(E e) {
    // modCount++，并且校验容量，不够用就扩容
    ensureCapacityInternal(size + 1);  // 增加 modCount
    // 将新元素添加到新数组size位置，并将size加1（千万不要理解成将新元素添加到size+1的位置）
    elementData[size++] = e;
    return true;
}

// 确保容量够用
private void ensureCapacityInternal(int minCapacity) {
    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);
}

本文重点方法★★★★★ ArrayList 扩容方法 grow(int minCapacity)

// 扩容方法
private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // ArrayList 的扩容是 1.5 倍 或 1.5 倍 - 1
    // oldCapacity为偶数按1.5倍扩容，oldCapacity为奇数按1.5倍-1扩容
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 该拷贝为深拷贝，将原来的数组复制到新的数组并返回新的数组
    elementData = java.util.Arrays.copyOf(elementData, newCapacity);
}

虽然上面的代码不多，但是添加元素遇到经常扩容的现象要格外留心，因为频繁的扩容势必带来频繁的数组拷贝，这会大大牺牲性能，所以有必要在 ArrayList 初始化时指定容量。初始化的容量也不要太大于实际存储容量，不然会造成空间浪费，所以都要权衡利弊。

1.2、在指定位子添加方法 public void add(int index, E element)

// 注意：在指定 index 位置添加元素，并不会覆盖该处的元素，而是 index位置及其之后的元素后移
public void add(int index, E element) {
    // 只要有index，必定会检查range
    rangeCheckForAdd(index);
    // 确保容量够用（否则就扩容）
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 这里是在指定位置index添加元素的关键：从index处，将数据后移 1 位，空出index处给新元素用
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 上一步已将index处的位置空出来，现在将新元素添加到index处
    elementData[index] = element;
    // 实际存储的元素数加1
    size++;
}

2.1、删除元素 public boolean remove(Object o)

public boolean remove(Object o) {
    // 两种情况，被删除的元素是否为 null
    // for 循环遍历、判断、删除（请注意：千万不要使用 foreach 进行删除！！！）
    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;
            }
    }
    // 如果删除了，返回为true，否则返回false。
    return false;
}

/*
 * Private remove method that skips bounds checking and does not
 * return the value removed.
 * 跳过边界检查的私有移除方法，并且不返回删除的值
 */
private void fastRemove(int index) {
    modCount++;
    int numMoved = size - index - 1;
    if (numMoved > 0)
        // 重点在这里，数据向前移动
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // 清除 size-1 位置上的元素（设置空引用），让GC去收集该元素，同时 size 减 1
    elementData[--size] = null; 
}

注意:

1. 如果存在多个对象o,仅仅删除距离 index = 0 处最近的一个元素;
2. 元素被删除后，该位置不会空出来，后面的元素会前移。

所以 ArrayList 适合读多删少场景。

3、重新设置指定index位置的元素值 public E set(int index, E element)

public E set(int index, E element) {
    // 有index，必检查
    rangeCheck(index);
    // 返回旧的（被重置的）元素
    E oldValue = elementData(index);
    // 直接把 index位置的元素覆盖掉行了
    elementData[index] = element;
    return oldValue;
}

4、获取指定index位置的元素 public E get(int index)

public E get(int index) {
   // 还是那句话，凡是遇到index索引，必检查
    rangeCheck(index);
    // 直接返回index的元素，数组查询还不快吗。
    return elementData(index);
}

E elementData(int index) {
    // 因为 ArrayList 本质上是个数组，直接通过index获取元素
    return (E) elementData[index];
}

5、判断元素是否存储 public boolean contains(Object o) 判断是否存在某个元素

public boolean contains(Object o) {
    // 简单粗暴，直接遍历查看index是否大于0
    return indexOf(o) >= 0;
}

// 查找元素是否存在，如果存在返回下标，否则返回 -1
public int indexOf(Object o) {
    // 遍历的时候分两种情况，是否为 null
    if (o == null) {
        for (int i = 0; i < size; i++)
            if (elementData[i]==null)
                return i;
    } else {
        for (int i = 0; i < size; i++)
            // 用 equals 判断值是否相等
            if (o.equals(elementData[i]))
                return i;
    }
    return -1;
}

---

二、ArrayList的亲兄弟 Vector

Vector 的大部分方法是被 synchronized 修饰的。
线程安全的ArrayList，几乎所有的方法都加 synchronized 修饰；

---

三、Stack

Stack 继承至 Vector，是一个后进先出LIFO的队列。
它实现了一个标准的 后进先出LIFO 的栈。

原文持续更新链接: https://github.com/about-cloud/JavaCore