JDK1.8中ArrayList的实现原理及源码分析

Posted 2022-05-22 ly570

一、概述

             ArrayList是Java开发中使用比较频繁的一个类，通过对源码的解读，可以了解ArrayList的内部结构以及实现方法，清楚它的优缺点，以便我们在编程时灵活运用。

二、源码分析

2.1 类结构

 JDK1.8源码中的ArrayList类结构定义如下：

public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
其中：

实现了List接口是一个数组队列拥有了List基本的增删改查功能
实现了RandomAccess接口拥有随机读写的功能
实现了Cloneable接口可以被克隆
实现了Serializable接口并重写了序列化和反序列化方法，使得ArrayList可以拥有更好的序列化的性能
2.2 成员变量和几个构造方法 

/**
* 定义序列化ID，主要是为了表示不同的版本的兼容性
*/
private static final long serialVersionUID = 8683452581122892189L;

/**
* 默认的数组存储容量(ArrayList底层是数组结构)
*/
private static final int DEFAULT_CAPACITY = 10;

/**
* 当指定数组的容量为0时使用这个常量赋值
*/
private static final Object[] EMPTY_ELEMENTDATA = ;

/**
* 默认空参构造函数时使用这个常量赋值
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = ;

/**
* 真正存放数据的对象数组，transient标识不被序列化
*/
transient Object[] elementData; // non-private to simplify nested class access

/**
* 数组中的真实元素个数，该值小于或等于elementData.length
*/
private int size;
/**
* 修改次数
*/
protected transient int modCount = 0;

/**
* 构造函数一：指定了容量的大小
* @param initialCapacity
*/
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);



/**
* 构造函数二：默认空参构造函数
*/
public ArrayList()
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;


/**
* 构造函数三:传入集合参数的构造函数
*
* @param c the collection whose elements are to be placed into this list
* @throws NullPointerException if the specified collection is null
*/
public ArrayList(Collection<? extends E> c)
elementData = ((ArrayList<?>) 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;


2.3 常用方法

往ArrayList中加入元素：add（E e）以及相关方法
/**
* Appends the specified element to the end of this list.
*
* @param e element to be appended to this list
* @return <tt>true</tt> (as specified by @link Collection#add)
*/
public boolean add(E e)
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;

private void ensureCapacityInternal(int minCapacity)
/**
* 如果原来的空数组，则比较加入的个数与默认个数(10)比较，取较大值
*/
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);


ensureExplicitCapacity(minCapacity);

private void ensureExplicitCapacity(int minCapacity)
modCount++;

/**
* 判断数组真实元素个数加1后的长度与当前数组长度大小关系，如果小于0，返回，如果大于0，则
* 调用grow（minCapacity）方法
*/
if (minCapacity - elementData.length > 0)
grow(minCapacity);

/**
* Increases the capacity to ensure that it can hold at least the
* number of elements specified by the minimum capacity argument.
*
* @param minCapacity the desired minimum capacity
*/
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);

public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]>
newType)
@SuppressWarnings("unchecked")
T[] copy = ((Object)newType == (Object)Object[].class)
? (T[]) new Object[newLength]
: (T[]) Array.newInstance(newType.getComponentType(), newLength);
System.arraycopy(original, 0, copy, 0,
Math.min(original.length, newLength));
return copy;

分析： 

ensureCapacityInternal（size+1）方法，在该方法中首先判断了当前数组是否是空数组，如果是则比较加入的个数与默认个数(10)比较，取较大值，否则调用2方法。
ensureExplicitCapacity(int minCapacity)方法，在该方法中首先是对modCount+1，判断数组真实元素个数加1后的长度与当前数组长度大小关系，如果小于0，返回，如果大于0，则调用3方法。
grow(minCapacity)方法，使用 oldCapacity + (oldCapacity >> 1)是当前数组的长度变为原来的1.5倍，再与扩容后的长度以及扩容的上限值进行对比，然后调用4方法。
Arrays.copyOf(elementData, newCapacity)方法，该方法的底层就是调用System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength))方法，把旧数据的数据拷贝到扩容后的新数组里面，返回新数组
然后再把新添加的元素赋值给扩容后的size+1的位置里面。
   往指定位置插入元素add（int idnex,E element）
源码如下：

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

从源码中可以看出，与add(E e)方法大致一致，主要的差异是增加了一行代码：System.arraycopy(elementData, index, elementData, index + 1, size - index)，从index位置开始以及之后的数据，整体拷贝到index+1开始的位置，然后再把新加入的数据放在index这个位置，而之前的数据不需要移动。（这些动作比较消耗性能）

java.lang.System.arraycopy(Object src, int srcPos, Object dest, int destPos, int length)，参数含义如下：

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

移除（根据下标移除和根据元素移除）
源码如下：

public E remove(int index)
rangeCheck(index);
//记录修改的次数
modCount++;
E oldValue = elementData(index);
//获取要移动元素的个数
int numMoved = size - index - 1;
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
//把size-1的位置的元素赋值为null,方便GC回收
elementData[--size] = null;


return oldValue;

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方法与add正好是一个相反的操作，移除一个元素，会影响到一批数字的位置移动，所以也是比较耗性能。核心代码都是调用了java.lang.System.arraycopy(Object src, int srcPos, Object dest, int destPos, int length)方法

查询
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 void clear()
modCount++;

// 将每个元素至为null，便于gc回收
for (int i = 0; i < size; i++)
elementData[i] = null;

size = 0;

 是否包含
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就不存在。

三、总结

      基于数组实现的List在随机访问和遍历的效率比较高，但是往指定位置加入元素或者删除指定位置的元素效率比较低。
---------------------