ArrayList源码分析(基于JDK8)

本文介绍

1、ArrayList相关面试题。
2、ArrayList基本信息。
3、ArrayList属性和方法。
4、ArrayList的总结。
5、ArrayList最佳实践。

相关面试题

ArrayList 插入删除一定慢么?
ArrayList 是如何扩容的?
ArrayList允许空值和重复元素吗?
ArrayList 的遍历和LinkedList遍历性能比较如何?

学习过Java的多多少少都会对ArrayList有一些了解,先不要急于往下看内容,先把上面几个小测试题写写,能写多少尽量写多少。

概述

ArrayList是一种变长的集合类,基于定长数组实现。因底层数据结构是数组,它是占据一块连续的内存空间,所以它也有数组的缺点,空间效率不高。同样底层数据结构是数组,直接通过下标查找元素时,时间复杂度为O(1)。根据元素内容查找时,时间复杂度为O(n)。
ArrayList 允许空值和重复元素,当往 ArrayList 中添加的元素数量大于其底层数组容量时,其会通过扩容机制重新生成一个更大的数组。
ArrayList 是非线程安全类,并发环境下,多个线程同时操作 ArrayList,会引发不可预知的错误。

ArrayList类关系图

ArrayList 继承AbstractList,实现了List, RandomAccess, Cloneable, java.io.Serializable接口。
ArrayList 实现List接口,即提供相关的添加、删除、修改、遍历功能。
ArrayList 实现RandmoAccess接口,即提供随机访问功能。
ArrayList 实现Cloneable接口,即覆盖了函数clone(),能被克隆
ArrayList 实现Serializable接口,这意味着ArrayList支持序列化

下面让我们翻开ArrayList的源代码,看看一些常用的方法属性,以及一些需要注意的地方。

属性

ArrayList属性主要就是当前数组长度size,以及存放数组的对象elementData数组,除此之外还有一个经常用到的属性就是从AbstractList继承过来的modCount属性,代表ArrayList集合的修改次数。

public class ArrayList extends AbstractList implements List, RandomAccess, Cloneable, Serializable {
    // 序列化id
    private static final long serialVersionUID = 8683452581122892189L;
    // 默认初始的容量
    private static final int DEFAULT_CAPACITY = 10;
    // 一个空对象
    private static final Object[] EMPTY_ELEMENTDATA = {};
    // 一个空对象,如果使用默认构造函数创建,则默认对象内容默认是该值
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    // 当前数据对象存放地方,当前对象不参与序列化
    transient Object[] elementData;
    // 当前数组长度
    private int size;
    // 数组最大长度
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
}

一些测试

最大容量测试
添加值测试

构造函数

无参构造函数

如果不传入参数,则使用默认无参构建方法创建ArrayList对象,如下:

public ArrayList() {
    // 将空串赋值给elementData
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

注意:此时我们创建的ArrayList对象中的elementData中的长度是0,size是0,当进行第一次add的时候,elementData将会修改成默认的长度:10

带int类型的构造函数

如果传入参数,则代表指定ArrayList的初始数组长度,传入参数如果是大于等于0,则使用用户的参数初始化,如果用户传入的参数小于0,则抛出异常,构造方法如下:

public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) { // 如果初始容量大于0,则新建一个长度为initialCapacity的Object数组.
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) { // 如果容量为0,直接将EMPTY_ELEMENTDATA赋值给elementData
        this.elementData = EMPTY_ELEMENTDATA;
    } else { // 容量小于0,直接抛出异常,把所有情况都考虑周到
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}

带Collection对象的构造函数

public ArrayList(Collection c) {
    // 将collection对象转换成数组,然后将数组的地址的赋给elementData
    elementData = c.toArray();
    // 因size代表的是集合元素数量,所以通过别的集合来构造ArrayList时,要给size赋值
    if ((size = elementData.length) != 0) {
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        if (elementData.getClass() != Object[].class) // 当c.toArray出错,没有返回Object[],将集合c中的元素到elementData数组中
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        //如果集合c元素数量为0,则将空数组EMPTY_ELEMENTDATA赋值给elementData 
        // replace with empty array.
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

add方法

add的方法有两个,一个是带一个参数的,一个是带两个参数的,下面我们一个个讲解。

add(E e) 方法

add主要的执行逻辑如下:
1)确保数组已使用长度(size)加1之后足够存下 下一个数据
2)修改次数modCount 标识自增1,如果当前数组已使用长度(size)加1后的大于当前的数组长度,则调用grow方法,增长数组,grow方法会将当前数组的长度变为原来容量的1.5倍。

添加元素方法入口:

public boolean add(E e) {
    // 确保数组已使用长度(size)加1之后足够存下 下一个数据
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 在数组末尾存放新的元素,并修改size
    elementData[size++] = e;
    // 成功返回true
    return true;
}

确保添加的元素有地方存储,当第一次添加元素的时候this.size+1 的值是1,所以第一次添加的时候会将当前elementData数组的长度变为10:

private void ensureCapacityInternal(int minCapacity) {
    // 判断数组是否是用默认构造函数初始化的
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    }

    ensureExplicitCapacity(minCapacity);
}

将修改次数(modCount)自增1,判断是否需要扩充数组长度,判断条件就是用当前所需的数组最小长度与数组的长度对比,如果大于0,则增长数组长度。

private void ensureExplicitCapacity(int minCapacity) {
    // 修改modCount
    modCount++;

    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

如果当前的数组已使用空间(size)加1之后 大于数组长度,则增大数组容量,扩大为原来的1.5倍。

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    int newCapacity = oldCapacity + (oldCapacity >> 1); // 默认扩容为原大小的1.5位
    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);
}

add(int index, E element)方法

这个方法其实和上面的add类似,该方法可以按照元素的位置,指定位置插入元素,具体的执行逻辑如下:
1)确保数插入的位置小于等于当前数组长度,并且不小于0,否则抛出异常
2)确保数组已使用长度(size)加1之后足够存下 下一个数据
3)修改次数(modCount)标识自增1,如果当前数组已使用长度(size)加1后的大于当前的数组长度,则调用grow方法,增长数组
4)grow方法会将当前数组的长度变为原来容量的1.5倍。
5)确保有足够的容量之后,使用System.arraycopy 将需要插入的位置(index)后面的元素统统往后移动一位。
6)将新的数据内容存放到数组的指定位置(index)上

public void add(int index, E element) {
    // 范围检查
    rangeCheckForAdd(index);

    // Increments modCount!!
    ensureCapacityInternal(size + 1); 

    // 将index位置开始的数据 向后移动一位 
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    elementData[index] = element;
    size++;
}

注意:使用该方法的话将导致指定位置后面的数组元素全部重新移动,即往后移动一位。

get方法

返回指定位置上的元素,数组下标从0开始。

public E get(int index) {
    // 检查范围,判断下标是否越界
    rangeCheck(index);
    // 返回数组下标对应内容
    return elementData(index);
}

E elementData(int index) {
    return (E) elementData[index];
}

set方法

确保set的位置小于当前数组的长度(size)并且大于0,获取指定位置(index)元素,然后放到oldValue存放,将需要设置的元素放到指定的位置(index)上,然后将原来位置上的元素oldValue返回给用户。

public E set(int index, E element) {
    // 检查范围,判断下标是否越界
    rangeCheck(index);

    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}

contains方法

调用indexOf方法,遍历数组中的每一个元素作对比,如果找到对于的元素,则返回true,没有找到则返回false。

public boolean contains(Object o) {
    return indexOf(o) >= 0;
}

// for循环寻找值,null做为特殊值区别开来查找
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;
}

remove方法

根据索引remove

public E remove(int index) {
    // 检查索引有没有越界
    rangeCheck(index);
    // 自增修改次数
    modCount++;
    // 暂存旧值
    E oldValue = elementData(index);

    // 将指定位置(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;
}

注意:调用这个方法不会缩减数组的长度,只是将最后一个数组元素置空而已。

根据对象remove

循环遍历所有对象,得到对象所在索引位置,然后调用fastRemove方法,执行remove操作

// 循环查找元素,找到后移除该元素
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;
}

定位到需要remove的元素索引,先将index后面的元素往前面移动一位(调用System.arraycooy实现),然后将最后一个元素置空。

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
}

clear方法

添加操作次数(modCount),将数组内的元素都置空,等待垃圾收集器收集,不减小数组容量。

public void clear() {
    modCount++;

    // clear to let GC do its work
    for (int i = 0; i < size; i++)
        elementData[i] = null; //将所有元素置null

    size = 0;
}

sublist方法

我们看到代码中是创建了一个ArrayList 类里面的一个内部类SubList对象,传入的值中第一个参数时this参数,其实可以理解为返回当前list的部分视图,真实指向的存放数据内容的地方还是同一个地方,如果修改了sublist返回的内容的话,那么原来的list也会变动。

public List subList(int fromIndex, int toIndex) {
    // 范围检查
    subListRangeCheck(fromIndex, toIndex, size);
    return new SubList(this, 0, fromIndex, toIndex);
}

trimToSize方法

将elementData中空余的空间(包括null值)去除,例如:数组长度为10,其中只有前三个元素有值,其他为空,那么调用该方法之后,数组的长度变为3.

public void trimToSize() {
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
          ? EMPTY_ELEMENTDATA
          : Arrays.copyOf(elementData, size);
    }
}

iterator方法

interator方法返回的是一个内部类,由于内部类的创建默认含有外部的this指针,所以这个内部类可以调用到外部类的属性。

public Iterator iterator() {
    return new Itr();
}

一般的话,调用完iterator之后,我们会使用iterator做遍历,这里使用next做遍历的时候有个需要注意的地方,就是调用next的时候,可能会引发ConcurrentModificationException,当修改次数,与期望的修改次数(调用iterator方法时候的修改次数)不一致的时候,会发生该异常,详细我们看一下代码实现:

@SuppressWarnings("unchecked")
public E next() {
    checkForComodification();
    int i = cursor;
    if (i >= size)
        throw new NoSuchElementException();
    Object[] elementData = ArrayList.this.elementData;
    if (i >= elementData.length)
        throw new ConcurrentModificationException();
    cursor = i + 1;
    return (E) elementData[lastRet = i];
}

expectedModCount这个值是在用户调用ArrayList的iterator方法时候确定的,但是在这之后用户add,或者remove了ArrayList的元素,那么modCount就会改变,那么这个值就会不相等,将会引发ConcurrentModificationException异常,这个是在多线程使用情况下,比较常见的一个异常。

final void checkForComodification() {
    if (modCount != expectedModCount)
        throw new ConcurrentModificationException();
}

System.arraycopy 方法

参数 说明
src 原数组
srcPos 原数组
dest 目标数组
destPos 目标数组的起始位置
length 要复制的数组元素的数目

Arrays.copyOf方法

original - 要复制的数组
newLength - 要返回的副本的长度
newType - 要返回的副本的类型

其实Arrays.copyOf底层也是调用System.arraycopy实现的源码如下:

//基本数据类型(其他类似byte,short···)
public static int[] copyOf(int[] original, int newLength) {
    int[] copy = new int[newLength];
    System.arraycopy(original, 0, copy, 0,
                     Math.min(original.length, newLength));
    return copy;
}

总结

ArrayList总体来说比较简单,不过ArrayList还有以下一些特点:
ArrayList自己实现了序列化和反序列化的方法,因为它自己实现了 private void writeObject(java.io.ObjectOutputStream s)和 private void readObject(java.io.ObjectInputStream s) 方法
ArrayList基于数组方式实现,无容量的限制(会扩容)
添加元素时可能要扩容(所以最好预判一下),删除元素时不会减少容量(若希望减少容量,trimToSize()),删除元素时,将删除掉的位置元素置为null,下次gc就会回收这些元素所占的内存空间。
add(int index, E element):添加元素到数组中指定位置的时候,需要将该位置及其后边所有的元素都整块向后复制一位
get(int index):获取指定位置上的元素时,可以通过索引直接获取(O(1))
remove(Object o):需要遍历数组
remove(int index):不需要遍历数组,只需判断index是否符合条件即可,效率比remove(Object o)高
contains(E):需要遍历数组
使用iterator遍历可能会引发多线程异常

最佳实践

1、适合用于查询修改多,增加删除少的业务中。如:后台管理系统数据分页展示页面、商城商品分页展示页面,从数据库中查询一批数据后需由容器装载传输到前端。此时用ArrayList来装载商品数据最适合不过。
2、创建容器时指定初始容器大小,如:后台管理系统数据分页展示页面,一页展示15条数据,如果不指定容器大小,默认10,查询15条数据还需要扩一次容,累不累?
3、new ArrayList时增加泛型,目的是为了安全。如以下代码

// 添加泛型的list
List list = new ArrayList();
list.add("a");
list.add("b");
list.add("c");
list.add(1);// 此处会报编译错误

// 未添加范型的list
List list1 = new ArrayList();
list1.add("a"); // 编译通过
list1.add(1); // 编译通过
list1.add(0.5f); // 编译通过
image.png

引文

ArrayList源码分析(基于JDK8)
https://blog.csdn.net/fighterandknight/article/details/61240861

面试必备:ArrayList源码解析(JDK8)
https://blog.csdn.net/zxt0601/article/details/77281231

你可能感兴趣的:(ArrayList源码分析(基于JDK8))