java集合之ArrayList源码分析

1.简介

ArrayList集合是我们用的最多的一个集合类之一,也是java集合框架中比较重要的一个类,它继承了AbstractList，实现了List接口，是一个长度可变的集合，提供了增删除改查的功能，底层实现是--数组。它除了实现了List接口，还实现了RandomAccess, Cloneable, Serializable等接口

RandomAccess：

下面是jdk的注解翻译 List 实现所使用的标记接口，用来表明其支持快速（通常是固定时间）随机访问。此接口的主要目的是允许一般的算法更改其行为，从而在将其应用到随机或连续访问列表时能提供良好的性能。 将操作随机访问列表的最佳算法（如 ArrayList ）应用到连续访问列表（如 LinkedList ）时，可产生二次项的行为。如果将某个算法应用到连续访问列表，那么在应用可能提供较差性能的算法前，鼓励使用一般的列表算法检查给定列表是否为此接口的一个 instanceof ，如果需要保证可接受的性能，还可以更改其行为。 现在已经认识到，随机和连续访问之间的区别通常是模糊的。例如，如果列表很大时，某些 List 实现提供渐进的线性访问时间，但实际上是固定的访问时间。这样的 List 实现通常应该实现此接口。 强调：JDK中推荐的是对List集合尽量要实现RandomAccess接口 如果集合类是RandomAccess的实现，则尽量用for(int i = 0; i < size; i++) 来遍历而不要用Iterator迭代器来遍历。

Cloneable：说明可被复制

Serializable：说明能被序列化

2.看源码

ArrayList底层使用的是java数组来存储集合的元素，类型是Object类

 private transient Object[] elementData;

来表示集合的元素个数

private int size;

ArrayList集合有不同的构造函数

会默认创建一个数组长度为10的集合 
public ArrayList() {
        this(10);
    }
创建一个自定义数组长度的集合，并且传入的值不能小于0
public ArrayList(int initialCapacity) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
    }
//一个集合类为参数
public ArrayList(Collection c) {
        //将传入的集合类转换为数组类型赋值给elementData
        elementData = c.toArray();
       //当前集合的长度也等传入集合的长度
        size = elementData.length;
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
      //如果传入的集合类型不等于Object类型
        if (elementData.getClass() != Object[].class)
         //通过Arrays.copOf（）方法返回一个Object类型的数组，并赋值给elementData
        elementData = Arrays.copyOf(elementData, size, Object[].class);
    }

由于有可能表示集合长度的size和表示集合容量的elementDate长度不一样，然后在不需要添加元素的情况下，可以使用此方法减小elementData的大小 
public void trimToSize() {
        modCount++;
        int oldCapacity = elementData.length;
        if (size < oldCapacity) {
            elementData = Arrays.copyOf(elementData, size);
        }
    }

底下的代码是在需要扩容的情况下，给elementData数组扩容，默认扩容是原数组长度*1.5

 public void ensureCapacity(int minCapacity) {
        if (minCapacity > 0)
            ensureCapacityInternal(minCapacity);
    }
    //需要扩容 调用 grow（）方法
    private void ensureCapacityInternal(int minCapacity) {
        modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;//ArrayList设置的最大容量
    
private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
       //对原数组长度进行扩容，已1.5倍的倍数扩容
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果扩容后的数组长度还不够，那么已传入的参数为数组扩容的数值 minCa
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //ArrayList设置了数组的最大容量，如果没超出用Arrays.copyOf()进行复制，不够的元素使用null
        //如果超出了调用hugeCapactity（）检查是否溢出，如果没有溢出返回合适的数组扩容长度值，然后进行数组复制
        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);
    }

//检查是否溢出,并返回一个合适的数组扩容长度值
private static int hugeCapacity(int minCapacity) {
      if (minCapacity < 0) // overflow
      throw new OutOfMemoryError(); 
     return (minCapacity > MAX_ARRAY_SIZE) ?
     Integer.MAX_VALUE : MAX_ARRAY_SIZE;
} 

检查集合是否为空，为空返回true

public boolean isEmpty() {
        return size == 0;
    }

查询该集合是否包含传入的参数，包含返回true

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

返回给定元素在集合中第一次出现的角标，如不存在返回-1

首先检查o是否为null，如果为null，就返回集合中第一个null元素的位置；如果不为null，就是用equals函数进行相等性检查。之所以这样，是因为如果直接对null调用equals方法，会抛出空指针异常。同时也不能循环遍历数组中的元素调用equals方法检查是否相等，因为ArrayList集合中允许有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;
    }

返回给定元素在集合中最后一次出现的角标，如不存在返回-1，原理和上一样

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

集合复制，本质上就是使用Arrays类进行元素复制

  public Object clone() {
        try {
            @SuppressWarnings("unchecked")
                ArrayList v = (ArrayList) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError();
        }
    }

获取元素

public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }
    也是操作的数组

 @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }

将给定位置的元素替换为给定元素，返回替换前的元素
public E set(int index, E element) {
        rangeCheck(index);

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

添加元素，添加前先判断是否需要对数组进行扩容，并对数组长度加一

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  //在集合长度+1的情况下，是否需要对数组进行扩容
        elementData[size++] = e;
        return true;
    }

在给定位置添加给定元素，使用System类型进行数组拷贝，也需要判断是否需要扩容

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

//将数据拷贝到新数组中,属性:源数据,从哪个角标开始,目标数据源,,目标数组的起始位置，拷贝长度

System.arraycopy(elementData, index, elementData, index + 1, size - index); elementData[index] = element; size++; }

删除给定角标的元素，原理也是 使用System类型进行数组拷贝，然后返回被删除的元素

public E remove(int index) {
        rangeCheck(index);

        modCount++;//这个是属性来自父类AbstractList，是用来记录列表已被结构修改的次数
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // Let gc do its work

        return oldValue;
    }

删除集合中给定的元素，循环数组比较数组中的值和给定值，找出给定元素的角标，然后调用删除方法，没有找到就返回false

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

 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; // Let gc do its work
    }

清空集合的数据，也很简单，只是循环数据，将数组中的每个元素都赋值为null

  public void clear() {
        modCount++;
        // Let gc do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;
        size = 0;
    }

基本上整个ArrayList的简单增删改查,大家也都理解了，也能自己实现个简单ArrayList了