说明:jdk版本1.8
- ArrayList默认容量为10
- 每次扩容为原来容量的1.5倍
- 底层使用Object数组实现
- ArrayList允许元素为null
- 不是线程安全
- ArrayList实现了Serializable接口,因此它支持序列
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
//默认容量10
private static final int DEFAULT_CAPACITY = 10;
//用于空实例的共享空数组实例
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
* Shared empty array instance used for default sized empty instances. We
* distinguish this from EMPTY_ELEMENTDATA to know how much to inflate when
* first element is added.
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
//ArrayList基于该数组实现,用该数组保存数据
//当一个对象被序行化的时候,transient修饰的变量的值是不包括在序行化的表示中的。
//实现序列化接口为啥还要禁止序列化呢?
// ArrayList在序列化的时候会调用writeObject,直接将size和element写入ObjectOutputStream;
// 反序列化时调用readObject,从ObjectInputStream获取size和element,再恢复到elementData。
//为什么不直接用elementData来序列化,而采用上诉的方式来实现序列化呢?
// 原因在于elementData是一个缓存数组,它通常会预留一些容量,等容量不足时再扩充容量,
// 那么有些空间可能就没有实际存储元素,采用上诉的方式来实现序列化时,
// 就可以保证只序列化实际存储的那些元素,而不是整个数组,从而节省空间和时间。
transient Object[] elementData; // non-private to simplify nested class access
//元素个数
private int size;
//指定容量构造函数
public ArrayList(int initialCapacity) {
if (initialCapacity > 0) {
this.elementData = new Object[initialCapacity];
} else if (initialCapacity == 0) {
this.elementData = EMPTY_ELEMENTDATA;
} else { //如果初始容量小于 0 则抛出异常
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
}
}
// ArrayList无参构造函数。默认容量是10。
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
// 创建一个包含collection的ArrayList
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;
}
}
//修改ArrayList实例的容量为实际元素个数
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}
// 确定ArrarList的容量。
public void ensureCapacity(int minCapacity) {
int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
// any size if not default element table
? 0
// larger than default for default empty table. It's already
// supposed to be at default size.
: DEFAULT_CAPACITY;
if (minCapacity > minExpand) {
ensureExplicitCapacity(minCapacity);
}
}
private void ensureCapacityInternal(int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
}
ensureExplicitCapacity(minCapacity);
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
//允许数组最大大小为 Integer.MAX_VALUE的值为0x7fffffff (转换十进制为2147483647 21亿)
//如果大于这个值,那么会导致OutOfMemoryError 请求的数组大小超过VM(虚拟机)限制。
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
/**
* 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;//当前数组大小
//扩容容量为原来的1.5倍, >>1 表示右移(相比除更快)相当于除以2 之前的jdk版本是/2
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);
}
private static int hugeCapacity(int minCapacity) {
if (minCapacity < 0) // overflow
throw new OutOfMemoryError();
return (minCapacity > MAX_ARRAY_SIZE) ?
Integer.MAX_VALUE :
MAX_ARRAY_SIZE;
}
//获取ArrayList大小
public int size() {
return size;
}
//判断是否为空
public boolean isEmpty() {
return size == 0;
}
//是否包含一个元素
public boolean contains(Object o) {
return indexOf(o) >= 0;
}
//返回列表中指定元素的第一次出现的索引,如果不包含该元素则返回-1
public int indexOf(Object o) {
if (o == null) { //ArrayList是允许为空的
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;
}
//返回ArrayList的浅复制 元素本身不会被复制
public Object clone() {
try {
java.util.ArrayList<?> v = (java.util.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(e);
}
}
//将列表所有元素转换成一个Object数组 这个方法作为数组和容器相关操作的桥梁。
public Object[] toArray() {
return Arrays.copyOf(elementData, size);
}
//将列表所有元素转换成一个泛型数组 这里的数组只能是引用类型数组,不能是基本数据类型数组
@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
// 若数组a的大小 < ArrayList的元素个数;
// 则新建一个T[]数组,数组大小是“ArrayList的元素个数”,并将“ArrayList”全部拷贝到新数组中
if (a.length < size)
// Make a new array of a's runtime type, but my contents:
return (T[]) Arrays.copyOf(elementData, size, a.getClass());
//将列表中的数据复制到
System.arraycopy(elementData, 0, a, 0, size);
if (a.length > size)
a[size] = null;
return a;
}
//根据索引定位元素并返回
@SuppressWarnings("unchecked")
E elementData(int index) {
return (E) elementData[index];
}
//根据下标索引返回元素
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 boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
//在指定索引位置插入元素
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++;
}
//根据索引移除元素并返回该元素 在移除后需要将索引后面的元素向左(前)移动
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);
elementData[--size] = null; // clear to let GC do its work
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;
}
//私有移除方法(根据索引),不会检查索引下标,没有返回值
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
}
//清空列表所有元素
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
//将集合c追加到ArrayList中
public boolean addAll(Collection<? extends E> c) {
Object[] a = c.toArray();
int numNew = a.length;
ensureCapacityInternal(size + numNew); // Increments modCount
System.arraycopy(a, 0, elementData, size, numNew);
size += numNew;
return numNew != 0;
}
//将集合增加到ArrayList指定位置中
public boolean addAll(int index, Collection<? extends E> c) {
rangeCheckForAdd(index);//对增加的索引验证
Object[] a = c.toArray();
int numNew = a.length;
ensureCapacityInternal(size + numNew); // Increments modCount
int numMoved = size - index;
if (numMoved > 0)
System.arraycopy(elementData, index, elementData, index + numNew,
numMoved);
System.arraycopy(a, 0, elementData, index, numNew);
size += numNew;
return numNew != 0;
}
//从这个列表中删除所有索引在 fromIndex (含)和 toIndex之间的元素。
protected void removeRange(int fromIndex, int toIndex) {
modCount++;
int numMoved = size - toIndex;
System.arraycopy(elementData, toIndex, elementData, fromIndex,
numMoved);
// clear to let GC do its work
int newSize = size - (toIndex-fromIndex);
for (int i = newSize; i < size; i++) {
elementData[i] = null;
}
size = newSize;
}
//检查索引是否越界
private void rangeCheck(int index) {
if (index >= size)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
//检查索引,用在add操作和addAll操作的时候
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) {
Objects.requireNonNull(c);
return batchRemove(c, false);
}
//从这个列表中删除所有。不包含在指定集合中的元素。 只保留列表和集合的交集
public boolean retainAll(Collection<?> c) {
Objects.requireNonNull(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)
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) {
// clear to let GC do its work
for (int i = w; i < size; i++)
elementData[i] = null;
modCount += size - w;
size = w;
modified = true;
}
}
return modified;
}
//实现ArrayList序列化
//将ArrayList的“容量,所有的元素值”都写入到输出流中
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException{
// Write out element count, and any hidden stuff
int expectedModCount = modCount;
s.defaultWriteObject();
// 写出大小
s.writeInt(size);
// 按顺序写出所有元素
for (int i=0; i<size; i++) {
s.writeObject(elementData[i]);
}
if (modCount != expectedModCount) {
throw new ConcurrentModificationException();
}
}
//反ArrayList序列化
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
elementData = EMPTY_ELEMENTDATA;
// Read in size, and any hidden stuff
s.defaultReadObject();
// 读取容量大小
s.readInt(); // ignored
if (size > 0) {
// be like clone(), allocate array based upon size not capacity
ensureCapacityInternal(size);
Object[] a = elementData;
// 按顺序读取每个元素
for (int i=0; i<size; i++) {
a[i] = s.readObject();
}
}
}
//从列表中的指定位置开始,返回列表中的元素(按正确顺序)的列表迭代器。
public ListIterator<E> listIterator(int index) {
if (index < 0 || index > size)
throw new IndexOutOfBoundsException("Index: "+index);
return new java.util.ArrayList.ListItr(index);
}
//返回列表中的列表迭代器(按适当的顺序)。
public ListIterator<E> listIterator() {
return new java.util.ArrayList.ListItr(0);
}
//以正确的顺序返回该列表中的元素的迭代器。
public Iterator<E> iterator() {
return new java.util.ArrayList.Itr();
}