JDK8中ArrayList的工作原理剖析

ArrayList也是在Java开发中使用频率非常高的一个类，内部是基于数组的动态管理的方式来实现的。数组在内存里面是一块连续的存储空间，其优势是基于下标的随机访问和遍历是非常高效的。

JDK8源码中的ArrayList类结构定义如下：

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

（1）继承了AbstractList实现了List接口是一个数组队列拥有了List基本的的增删改查功能

（2）实现了RandomAccess接口拥有随机读写的功能

（3）实现了Cloneable接口可以被克隆

（4）实现了Serializable了接口并重写了序列化和反序列化方法，使得ArrayList可以拥有更好的序列化的性能。



ArrayList中的成员变量和几个构造方法如下：

````java
 //定义的序列化id，主要是为了标识不同版本的兼容性    
 private static final long serialVersionUID = 8683452581122892189L;
 //默认的数组存储容量
  private static final int DEFAULT_CAPACITY = 10;
  //当指定数组的容量为0的时候使用这个变量赋值
  private static final Object[] EMPTY_ELEMENTDATA = {};
  //默认的实例化的时候使用此变量赋值
  private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
  //真正存放数据的对象数组，并不被序列化
  transient Object[] elementData;
  //数组中的真实元素个数它小于或等于elementData.length
  private int size;
  //数组中最大存放元素的个数 
  private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    //构造函数一，如果指定容量就分配指定容量的大小
    //没有指定就使用EMPTY_ELEMENTDATA赋值
      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);
        }
    }    
    
    //构造函数二，使用默认的DEFAULTCAPACITY_EMPTY_ELEMENTDATA赋值
        public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    
    //构造一个传入的集合，作为数组的数据
        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;
        }
    }


````

在了解了它的成员变量和构造函数之后，我们再来看下几个常用的方法：

（一）添加

添加有两个方法，第一个add(E e)方法的调用链涉及5个方法，分别如下：

````
  //1
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }
    
    //2
        private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }
    //3
        private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
    
    //4
        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);
    }
    
    //5
        private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }
    
````

这里一步步分析，在调用了add(E e)的方法第一步，我们看到了它调用了ensureCapacityInternal(size + 1)方法，在这个方法里面首先判断了数组是不是一个长度为0的空数组，如果是的话就给它容量赋值为默认的容量大小也就是10，然后调用了ensureExplicitCapacity方法，这个方法里面记录了modCount+1之后，并判断了当前的容量是否小于数组当前的长度，如果大于当前数组的长度就开始进行扩容操作调用方法 grow(minCapacity)，扩容的长度是增加了原来数组数组的一半大小，然后并判断了是否达到了数组扩容的上限并赋值，接着把旧数组的数据拷贝到扩容后的新数组里面再次赋值给旧数组，最后把新添加的元素赋值给了扩容后的size+1的位置里面。


接着看第2个add方法：

````
    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方法，参数含义如下：

（原数组,原数组的开始位置，目标数组，目标数组的的开始位置，拷贝的个数)

(注：如果想了解关于Java里面数组拷贝的几种方式，请参考我的上一篇文章。)

这里面主要是给指定位置添加一个元素，ArrayList首先检查是否索引越界，如果没有越界，就检查是否需要扩容，然后将index位置之后的所有数据，整体拷贝到index+1开始的位置，然后就可以把新加入的数据放到index这个位置，而index前面的数据不需要移动，在这里我们可以看到给指定位置插入数据ArrayList是一项大动作比较耗性能。




（二）移除

（1）根据下标移除

````java
    public E remove(int index) {
        //检查是否越界
        rangeCheck(index);
        //记录修改次数
        modCount++;
        //获取移除位置上的值
        E oldValue = elementData(index);
        //获取要移动元素的个数
        int numMoved = size - index - 1;
        if (numMoved > 0)
        //拷贝移动的所有数据到index位置上
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //把size-1的位置的元素赋值null，方便gc
        elementData[--size] = null; // clear to let GC do its work
        //最终返回旧的数据
        return oldValue;
    }
````

（2）根据元素移除

````
    public boolean remove(Object o) {
    //等于null值的移除
        if (o == null) {
         //遍历数组
            for (int index = 0; index < size; index++)
            //找到集合里面第一个等于null的元素
                if (elementData[index] == null) {
                //然后移除
                    fastRemove(index);
                    return true;
                }
        } else {
        //非null情况下，遍历每一个元素通过equals比较
            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
    }

````

remove方法与add(int index, E element)正好是一个相反的操作过程，移除一个元素，会影响到一批数据的位置移动，所以也是比较耗性能的。


（三）查询

````
    public E get(int index) {
      //检查是否越界
        rangeCheck(index);
        //返回指定位置上的元素
        return elementData(index);
    }
````

（四）修改

````
    public E set(int index, E element) {
    //检查是否越界
        rangeCheck(index);
        //获取旧的元素值
        E oldValue = elementData(index);
        //新元素赋值
        elementData[index] = element;
        //返回旧的元素值
        return oldValue;
    }
````

（五）清空方法

````
    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }
````

clear方法是把每个元素的值赋值为null，便于gc回收


（六）瘦身方法

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

该方法主要将数组空间缩减，去掉数组里面的null值。
Arrays.copyOf方法参数含义：（原数组，拷贝的个数）

（七）是否包含

````java
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }
    
        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;
    }
````

这里面主要是分两种情况null值的遍历和非null的遍历遍历，如果查询到就返回下标位置，否则就返回-1，然后与0相比，大于0就存在，小于0就是不存在。


总结：


本文介绍了JDK8中的ArrayList的工作原理和常用方法分析，此外ArrayList非线程安全，所以需要多线程的场景下，请使用jdk自带并发List结构或者Guava，Apache Common等工具包提供的List集合。基于数组实现的List在随机访问和遍历的效率比较高，但在插入指定和删除指定元素的时候效率比较低，而这正好和链表相反，链表的的查询和随机遍历效率较低，但插入和删除指定位置元素的效率比较高，这也是为什么HashMap中同时使用两种数据结构来优势互补的原因。



有什么问题可以扫码关注微信公众号：我是攻城师(woshigcs)，在后台留言咨询。 技术债不能欠，健康债更不能欠， 求道之路，与君同行。