ArrayList源码及原理学习记录

ArrayList源码及原理学习

ArrayList的底层数据结构是一个Object类型的数组。非线程安全。非线程安全原因：添加ArrayList分两步，一添加数据，二ArrayList的size加1，这两步操作不具有原子性，在线程轮转时分离会出现错误。

一、继承关系

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

ArrayList继承AbstractList抽象类，实现List接口规范。继承RandomAccess(随机访问)、Cloneable(可拷贝)、Serizlizable(可序列化)接口。

二、属性

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    private static final long serialVersionUID = 8683452581122892189L;

    //构造时未指定ArrayList数组长度时的默认数组容量
    private static final int DEFAULT_CAPACITY = 10;

    //构造时指定数组容量为0时将该空数组赋值给elementData数组，和其他ArrayList共享
    private static final Object[] EMPTY_ELEMENTDATA = {};

    //构造时未指定数组容量时将该空数组赋值给elementData数组，和其他ArrayList共享
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //ArrayList的底层数据结构，存放实际数据元素
    transient Object[] elementData; // non-private to simplify nested class access

    //存储实际ArrayList数据元素个数
    private int size;

	//ArrayList最大容量0xffff ffff-8
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
}

三、构造方法

ArrayList有三种构造方法

1.有参构造方法

// 参数为int类型，指定创建数组的容量
public ArrayList(int initialCapacity) {
	// 判断initialCapacity参数是否符合合法
    if (initialCapacity > 0) {
    	// new一个Object类型数组赋值给elementData
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
    	// 构造指定数组容量为0，将EMPTY_ELEMENTDATA赋值给elementData
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
    	// initialCapacity<0，抛出异常(非法容量)
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}

该参数不是创建的ArrayList数组的实际长度，而是数组的容量，表示可以存储的数据元素个数。创建ArrayList时需要在内存上获取一段连续的内存。当实际长度超出容量时，数组需要扩容。

public static void main(String[] args){
    List<String> list=new ArrayList<String>(10);
    System.out.println(list.size());
}

输出结果为0

2.无参构造方法

public ArrayList() {
	// 直接将空数组 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 赋值给elementData
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

3.集合类型参数构造方法

public ArrayList(Collection<? extends E> c) {
	// 将参数中的集合转换为数组赋值给elementData
    elementData = c.toArray();
    // 比较参数集合是否为空，如果不为空判断是否成功将参数集合转换为Object类型的数组，顺便给size赋值
    if ((size = elementData.length) != 0) {
        // 如果转换成功，则复制转换成功的Object类型数组
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        // 如果为空仍然赋值空数组给elementData
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

四、ArrayList中的一些方法

1.add方法

添加方法有两种，一种是直接在列表尾部添加数据元素，另一种是在列表中间插入数据元素。两种方法都首先判断ArrayList容量是否足够添加数据元素，不够则扩容；然后存入数据，最后size+1。

public boolean add(E e) {
	// 判断ArraryList是否需要扩容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 底层数据结构赋值，并size+1
    elementData[size++] = e;
    return true;
}

public void add(int index, E element) {
	// 判断指定位置index是否合法，如果不合法则抛出异常
    rangeCheckForAdd(index);

	// 判断是否需要扩容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    //将下标从index开始到最后的所有元素向后复制一个位置。
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 赋值并size+1
    elementData[index] = element;
    size++;
}

private void rangeCheckForAdd(int index) {
    if (index > size || index < 0)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

2.get方法

获取ArrayList指定位置的元素的值,并返回一个向下转型的值。这里索引范围检查只检查了是否大于size而没有<0。

public E get(int index) {
	// 判断index是否合法
    rangeCheck(index);
	//返回数据
    return elementData(index);
}

private void rangeCheck(int index) {
    if (index >= size)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

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

3.set方法

更改指定位置的数据，可以返回旧数据

public E set(int index, E element) {
    rangeCheck(index);

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

4.remove方法

remove方法有两种。一种传索引值，一种传Object对象。

public E remove(int index) {
	// 检查索引
    rangeCheck(index);

	// 结构性修改计数器加1。属性从AbstractList继承，供迭代器检查列表是否有修改
    modCount++;
    E oldValue = elementData(index);

	// 计算需要向前拷贝集合数据的大小
    int numMoved = size - index - 1;
    if (numMoved > 0)
    	// 向前拷贝数据一个位置
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // elementData最后一个元素位置指向null，被删对象内存等待GC
    elementData[--size] = null; // clear to let GC do its work

    return oldValue;
}

public boolean remove(Object o) {
	// 判断传入值是否为null
    if (o == null) {
    	// 删除值为null的数据元素，有null返回true，没有返回false
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
            	// fastRemove是ArrayList私有的删除方法，没有索引检查和返回值，速度更快
                fastRemove(index);
                return true;
            }
    } else {
    	// 删除值为传入参数的数据元素，有null返回true，没有返回false
        for (int index = 0; index < size; index++)
            if (o.equals(elementData[index])) {
                fastRemove(index);
                return true;
            }
    }
    return false;
}

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
}

从源码可以看出传入对象删除需要遍历整个列表，直到查找到目标才会根据索引删除数据。效率比传入索引的删除慢。

5.indexOf方法

从头开始查找与传入元素相等的元素，分元素是否为空2种情况。当元素为空时使用==判断地址为空的元素。不为空时用equals查找值相等的元素。

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;
    }

还有一个lastIndexOf方法，作用与indexOf相同，就是反着从数组查找。

public int lastIndexOf(Object o) {
    if (o == null) {
        for (int i = size-1; i >= 0; i--)
            if (elementData[i]==null)
                return i;
    } else {
        for (int i = size-1; i >= 0; i--)
            if (o.equals(elementData[i]))
                return i;
    }
    return -1;
}

6.sort方法

List的排序方法，需要传入一个比较器。

public void sort(Comparator<? super E> c) {
    final int expectedModCount = modCount;
    Arrays.sort((E[]) elementData, 0, size, c);
    if (modCount != expectedModCount) {
        throw new ConcurrentModificationException();
    }
    modCount++;
}

使用

public static void main(String[] args){
    Student s1=new Student("1001","学生1",20);
    Student s2=new Student("1002","学生2",9);
    Student s3=new Student("1003","学生3",18);
    Student s4=new Student("1004","学生4",15);
    List<Student> students=new ArrayList<Student>();
    students.add(s1);
    students.add(s2);
    students.add(s3);
    students.add(s4);
    students.sort(new Comparator<Student>() {
        // 匿名类
        @Override
        public int compare(Student o1, Student o2) {
            return o1.getAge()-o2.getAge();
        }
    });
    for (Student stu:students){
        System.out.println(stu.getStuName()+","+stu.getAge());
    }
}

结果

五、扩容的机制

扩容主要发生在向ArrayList添加元素的时候，add()添加新元素时必须确保集合的容量能添加下新的元素。
首先调用ensureCapacityInternal(minCapacity);方法确定需要的最小容量minCapacity=size+1。size是原本ArrayList容量加上新添加的1个容量就是能添加成功的最小容量。在该方法中先判断elementData是否为空数组，如果是，则最小实际容量和默认容量比较值，较大的值传入ensureExplicitCapacity(minCapacity);方法。

private void ensureCapacityInternal(int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    }

    ensureExplicitCapacity(minCapacity);
}

然后在该方法判断是否需要扩容，并且结构性修改计数器加一(add方法的)。如果需要扩容则调用grow(minCapacity);方法，不需要则返回add()方法完成添加。

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;

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

最后确定新的容量大小并扩容。首先将原容量扩大1.5倍，如果新容量超出最大容量会报出异常。将新的容量与最小实际容量比较，如果新容量足够，则按新容量扩容；如果不够，则按最小实际容量扩容。扩容通过Arrays.copyOf(elementData, newCapacity);方法扩容，原理是按新容量重新申请一个数组，并将原数据拷贝到新数组下。

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // 扩大1.5倍
    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);
}