ArrayList简介
ArrayList是基于数组实现的,是一个动态数组,其容量能自动增长,类似于C语言中的动态申请内存,动态增长内存。
ArrayList不是线程安全的,只能用在单线程环境下,多线程环境下可以考虑用Collections.synchronizedList(List l)函数返回一个线程安全的ArrayList类,也可以使用concurrent并发包下的CopyOnWriteArrayList类。
ArrayList实现了Serializable接口,因此它支持序列化,能够通过序列化传输,实现了RandomAccess接口,支持快速随机访问,实际上就是通过下标序号进行快速访问,实现了Cloneable接口,能被克隆。
ArrayList源码剖析
ArrayList的源码如下(加入了比较详细的注释):
public class ArrayList
extends AbstractList
implements List
, RandomAccess, Cloneable, java.io.Serializable
{
// 序列版本号
private static final long serialVersionUID = 8683452581122892189L;
// ArrayList基于该数组实现,用该数组保存数据
private transient Object[] elementData;
// ArrayList中实际数据的数量
private int size;
// ArrayList带容量大小的构造函数
public ArrayList(int initialCapacity) {
super();
if (initialCapacity < 0)// 抛出异常
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
//容量大小满足则新建一个数组
this.elementData = new Object[initialCapacity];
}
// ArrayList无参构造函数。默认容量是10。
public ArrayList() {
this(10);
}
// 创建一个包含collection的ArrayList
public ArrayList(Collection
c) {
elementData = c.toArray();
size = elementData.length;
// 集合内的元素复制到element中
if (elementData.getClass() != Object[].class)
elementData = Arrays.copyOf(elementData, size, Object[].class);
}
// 将当前容量值设为实际元素个数
public void trimToSize() {
// 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的
modCount++;
int oldCapacity = elementData.length;
if (size < oldCapacity) {
elementData = Arrays.copyOf(elementData, size);
}
}
// 确定ArrarList的容量。
// 若ArrayList的容量不足以容纳当前的全部元素,设置 新的容量=“(原始容量x3)/2 + 1”
public void ensureCapacity(int minCapacity) {
//1.判断是否需要操作容量
if (minCapacity > 0)
ensureCapacityInternal(minCapacity);
}
private void ensureCapacityInternal(int minCapacity) {
// 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的
modCount++;
//2.判断是否需要增加容量
if (minCapacity - elementData.length > 0)
grow(minCapacity);// 增加容量
}
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
// 动态增加容量
private void grow(int minCapacity) {
int oldCapacity = elementData.length;
// 默认增加原始容量的一半
int newCapacity = oldCapacity + (oldCapacity >> 1);
//判断新增加是否大于要增加容量大小
if (newCapacity - minCapacity < 0)
//如果还不够,则直接将minCapacity设置为当前容量
newCapacity = minCapacity;
if (newCapacity - MAX_ARRAY_SIZE > 0)
newCapacity = hugeCapacity(minCapacity);
//将数组重新拷贝到elementData
elementData = Arrays.copyOf(elementData, newCapacity);
}
private static int hugeCapacity(int minCapacity) {
if (minCapacity < 0)
throw new OutOfMemoryError();
return (minCapacity > MAX_ARRAY_SIZE) ?
Integer.MAX_VALUE :
MAX_ARRAY_SIZE;
}
// 返回ArrayList的实际大小
public int size() {
return size;
}
//返回ArrayList是否为空
public boolean isEmpty() {
return size == 0;
}
//是否包含元素o
public boolean contains(Object o) {
return indexOf(o) >= 0;
}
//正向查找,元素o第一次出现的下标 返回元素的索引值 没有就返回-1
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;
}
// 反向查找,元素o最后一次出现的下标 返回元素的索引值 没有就返回-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;
}
// 克隆函数
public Object clone() {
try {
ArrayList
v = (ArrayList
) super.clone(); // 将当前ArrayList的全部元素拷贝到v中 v.elementData = Arrays.copyOf(elementData, size); v.modCount = 0; return v; } catch (CloneNotSupportedException e) { throw new InternalError(); } } // ArrayList内元素复制到数组,并返回这个数组 public Object[] toArray() { return Arrays.copyOf(elementData, size); } public
T[] toArray(T[] a) { // 若数组a的大小 < ArrayList的元素个数; // 则新建一个T[]数组,数组大小是“ArrayList的元素个数”,并将“ArrayList”全部拷贝到新数组中 并返回 if (a.length < size) return (T[]) Arrays.copyOf(elementData, size, a.getClass()); // 若数组a的大小 >= ArrayList的元素个数; // 则将ArrayList的全部元素都拷贝到数组a中。 System.arraycopy(elementData, 0, a, 0, size); if (a.length > size) a[size] = null; return a; } //获取index位置元素 不抛出异常 E elementData(int index) { return (E) elementData[index]; } // 获取index位置的元素值 public E get(int index) { rangeCheck(index); // 可抛出异常 return elementData(index); } //更新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); //动态控制集合大小 是否增加容量 elementData[size++] = e; return true; } // 将e添加到ArrayList的指定位置 public void add(int index, E element) { rangeCheckForAdd(index); // 可抛出异常 ensureCapacityInternal(size + 1); //动态控制集合大小 是否增加容量 //增加需要拷贝数组 System.arraycopy(elementData, index, elementData, index + 1, size - index); //给index复制 elementData[index] = element; //数组容量增大1 size++; } //删除index位置元素 public E remove(int index) { rangeCheck(index); // 可抛出异常 // 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的 modCount++; E oldValue = elementData(index); int numMoved = size - index - 1; //判断是否是最后一位 if (numMoved > 0) //需要对数组进行拷贝 System.arraycopy(elementData, index+1, elementData, index, numMoved); //将最后一个下标值设置为null elementData[--size] = null; //返回被删除的值 return oldValue; } //删除元素o 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; } // 快速删除第index个元素 private void fastRemove(int index) { // 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的 modCount++; int numMoved = size - index - 1; //判断是否是最后一位 if (numMoved > 0) //需要对数组进行拷贝 System.arraycopy(elementData, index+1, elementData, index, numMoved); //将最后一个下标值设置为null elementData[--size] = null; // Let gc do its work } // 清空ArrayList,将全部的元素设为null public void clear() { // 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的 modCount++; //循环将所有值都设置为空 size设为0 for (int i = 0; i < size; i++) elementData[i] = null; size = 0; } //添加集合c元素到ArrayList中 public boolean addAll(Collection
c) { Object[] a = c.toArray(); int numNew = a.length; ensureCapacityInternal(size + numNew); //动态增加数组大小 System.arraycopy(a, 0, elementData, size, numNew); //将数组拷贝 size += numNew; //设置size return numNew != 0; } //index位置开始插入集合c的元素 public boolean addAll(int index, Collection
c) { rangeCheckForAdd(index); //可抛出异常 Object[] a = c.toArray(); int numNew = a.length; ensureCapacityInternal(size + numNew); //动态增加数组大小 int numMoved = size - index; if (numMoved > 0) System.arraycopy(elementData, index, elementData, index + numNew, numMoved); System.arraycopy(a, 0, elementData, index, numNew); size += numNew; //设置size return numNew != 0; } // 删除fromIndex到toIndex之间的全部元素。 protected void removeRange(int fromIndex, int toIndex) { // 将“修改统计数”+1,该变量主要是用来实现fail-fast机制的 modCount++; int numMoved = size - toIndex; // 移动元素数量 //移动 System.arraycopy(elementData, toIndex, elementData, fromIndex, numMoved); int newSize = size - (toIndex-fromIndex); // 更新size //将后面元素设置为Null while (size != newSize) elementData[--size] = null; } //是负数的时候抛异常 private void rangeCheck(int index) { if (index >= size) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } //判断下标合法性 抛异常 private void rangeCheckForAdd(int index) { if (index > size || index < 0) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } //越界输出信息 private String outOfBoundsMsg(int index) { return "Index: "+index+", Size: "+size; } //差集 public boolean removeAll(Collection
c) { return batchRemove(c, false); } //交集 public boolean retainAll(Collection
c) { return batchRemove(c, true); } //差集交集具体实现 private boolean batchRemove(Collection
c, boolean complement) { final Object[] elementData = this.elementData; int r = 0, w = 0; boolean modified = false; try { for (; r < size; r++) if (c.contains(elementData[r]) == complement) // true 交集,false差集 elementData[w++] = elementData[r]; } finally { // Preserve behavioral compatibility with AbstractCollection, // even if c.contains() throws. if (r != size) { System.arraycopy(elementData, r, elementData, w, size - r); w += size - r; } if (w != size) { // 垃圾回收 for (int i = w; i < size; i++) elementData[i] = null; modCount += size - w; size = w; modified = true; } } return modified; } //输出流和输入流 // 将ArrayList的“容量,所有的元素值”都写入到输出流中 private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException{ int expectedModCount = modCount; s.defaultWriteObject(); s.writeInt(elementData.length); // Write out all elements in the proper order. for (int i=0; i
listIterator(int index) { if (index < 0 || index > size) throw new IndexOutOfBoundsException("Index: "+index); return new ListItr(index); } //获取所有元素的迭代器,该迭代器,可以向前也可以先后遍历,可以更新元素 public ListIterator
listIterator() { return new ListItr(0); } //获取所有元素的迭代器 ,只可以向后遍历元素 public Iterator
iterator() { return new Itr(); } //内部类实现Itr迭代器 只能够向后遍历 private class Itr implements Iterator
{ int cursor; int lastRet = -1; int expectedModCount = modCount; public boolean hasNext() { // 是否结束 return cursor != size; } @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]; // 返回当前元素 } // 删除 public void remove() { if (lastRet < 0) // 非法 throw new IllegalStateException(); checkForComodification(); try { ArrayList.this.remove(lastRet); // 删除 cursor = lastRet; lastRet = -1; expectedModCount = modCount; } catch (IndexOutOfBoundsException ex) { throw new ConcurrentModificationException(); } } // 检测运行记录最大值 final void checkForComodification() { if (modCount != expectedModCount) throw new ConcurrentModificationException(); } } //ListItr 迭代器,继承Itr,并增加了前驱遍历、更新元素的方法 private class ListItr extends Itr implements ListIterator
{ ListItr(int index) { super(); cursor = index; } public boolean hasPrevious() { // 是否有前驱 return cursor != 0; } public int nextIndex() { // 下一个位置 return cursor; } public int previousIndex() { // 前驱id return cursor - 1; } @SuppressWarnings("unchecked") public E previous() { // 前驱元素 checkForComodification(); int i = cursor - 1; if (i < 0) throw new NoSuchElementException(); Object[] elementData = ArrayList.this.elementData; if (i >= elementData.length) throw new ConcurrentModificationException(); cursor = i; return (E) elementData[lastRet = i]; } public void set(E e) { // 设置元素 if (lastRet < 0) throw new IllegalStateException(); checkForComodification(); try { ArrayList.this.set(lastRet, e); } catch (IndexOutOfBoundsException ex) { throw new ConcurrentModificationException(); } } public void add(E e) { // 添加元素 checkForComodification(); try { int i = cursor; ArrayList.this.add(i, e); cursor = i + 1; lastRet = -1; expectedModCount = modCount; } catch (IndexOutOfBoundsException ex) { throw new ConcurrentModificationException(); } } }
几点总结
关于ArrayList的源码,给出几点比较重要的总结:
1、注意扩充容量的方法ensureCapacity。ArrayList在每次增加元素(可能是1个,也可能是一组)时,都要调用该方法来确保足够的容量。当容量不足以容纳当前的元素个数时,就设置新的容量为旧的容量的1.5倍加1,如果设置后的新容量还不够,则直接新容量设置为传入的参数(也就是所需的容量),而后用Arrays.copyof()方法将元素拷贝到新的数组(详见下面的第3点)。从中可以看出,当容量不够时,每次增加元素,都要将原来的元素拷贝到一个新的数组中,非常之耗时,也因此建议在事先能确定元素数量的情况下,才使用ArrayList,否则建议使用LinkedList。
2、ArrayList的实现中大量地调用了Arrays.copyof()和System.arraycopy()方法。我们有必要对这两个方法的实现做下深入的了解。
首先来看Arrays.copyof()方法。它有很多个重载的方法,但实现思路都是一样的,我们来看泛型版本的源码:
public static <T> T[] copyOf(T[] original, int newLength) {
return (T[]) copyOf(original, newLength, original.getClass());
}
很明显调用了另一个copyof方法,该方法有三个参数,最后一个参数指明要转换的数据的类型,其源码如下:
public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
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;
}
这里可以很明显地看出,该方法实际上是在其内部又创建了一个长度为newlength的数组,调用System.arraycopy()方法,将原来数组中的元素复制到了新的数组中。
下面来看System.arraycopy()方法。该方法被标记了native,调用了系统的C/C++代码,在JDK中是看不到的,但在openJDK中可以看到其源码。该函数实际上最终调用了C语言的memmove()函数,因此它可以保证同一个数组内元素的正确复制和移动,比一般的复制方法的实现效率要高很多,很适合用来批量处理数组。Java强烈推荐在复制大量数组元素时用该方法,以取得更高的效率。
3、注意ArrayList的两个转化为静态数组的toArray方法。
第一个,Object[] toArray()方法。该方法有可能会抛出java.lang.ClassCastException异常,如果直接用向下转型的方法,将整个ArrayList集合转变为指定类型的Array数组,便会抛出该异常,而如果转化为Array数组时不向下转型,而是将每个元素向下转型,则不会抛出该异常,显然对数组中的元素一个个进行向下转型,效率不高,且不太方便。
第二个,<T> T[] toArray(T[] a)方法。该方法可以直接将ArrayList转换得到的Array进行整体向下转型(转型其实是在该方法的源码中实现的),且从该方法的源码中可以看出,参数a的大小不足时,内部会调用Arrays.copyOf方法,该方法内部创建一个新的数组返回,因此对该方法的常用形式如下:
public static Integer[] vectorToArray2(ArrayList<Integer> v) {
Integer[] newText = (Integer[])v.toArray(new Integer[0]);
return newText;
}
4、ArrayList基于数组实现,可以通过下标索引直接查找到指定位置的元素,因此查找效率高,但每次插入或删除元素,就要大量地移动元素,插入删除元素的效率低。
5、在查找给定元素索引值等的方法中,源码都将该元素的值分为null和不为null两种情况处理,ArrayList中允许元素为null。