从源码理解ArrayList.java
package java.util;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.UnaryOperator;
/**
* 可变数组实现了List接口,实现了所有列表操作,允许空值null。还提供了操作数组大小的方法用以内部使用。
* 除了不支持并发访问,这个类完全等同于Vector
* 以下几个操作都是常数时间:size、isEmpty、get、set、iterator和listIterator
* add操作均摊时间为常数时间
* 其他操作是线性时间,常数因子比LinkedList实现小。
* 每个ArrayList实例都有一个capacity。capacity是list中用于保存元素的数组大小。大于等于list的Size。
* 添加元素后,capacity自增。
*
* 应用可以在添加大量元素之前,通过ensureCapacity操作提升容量,这样可以减少因为容量增长造成的内存重新分配。
* 该实现不支持并发。多线程下需要外部同步:List list = Collections.synchronizedList(new ArrayList(...));
*
* 迭代器iterator和listIterator都是快速失败(fail-fast)的
* 并发访问下行为未定。
*/
/**
* 支持泛型,继承自AbstractList,实现了List、RandomAccess、Cloneable、java.io.Serializable接口
* AbstractList提供了List接口的默认实现(个别方法为抽象方法)
* List接口定义了列表必须实现的方法
* RandomAccess是一个标记接口,接口内没有定义任何内容
* 实现了Cloneable接口的类,可以调用Object.clone()方法返回该对象的浅拷贝
* 通过实现java.io.Serializable接口以启用其序列化功能。未实现此接口的类将无法使其任何状态序列化或 反序列化。
* 序列化接口没有方法或字段,仅用于标识可序列化的语义。
*/
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
private static final long serialVersionUID = 8683452581122892189L;
/**
* 默认初始容量.
*/
private static final int DEFAULT_CAPACITY = 10;
/**
* 所有空实例共享的空数组实例.
*/
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
* 存储ArrayList元素的数组,为空时指向EMPTY_ELEMENTDATA
*/
transient Object[] elementData; // non-private to simplify nested class access
/**
* ArrayList的大小
*/
private int size;
/**
* 构造一个具有指定初始容量的空list
* @param initialCapacity the initial capacity of the list
* @throws IllegalArgumentException if the specified initial capacity
* is negative
*/
public ArrayList(int initialCapacity) {
super();
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
this.elementData = new Object[initialCapacity];
}
/**
* 构造一个具有初始容量10的空list
*/
public ArrayList() {
super();
this.elementData = EMPTY_ELEMENTDATA;
}
/**
* 构造一个包含指定集合中元素的list,按照迭代器返回的顺序
* @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 = c.toArray();
size = elementData.length;
// c.toArray might (incorrectly) not return Object[] (see 6260652)
//返回若不是Object[]将调用Arrays.copyOf方法将其转为Object[]
if (elementData.getClass() != Object[].class)
elementData = Arrays.copyOf(elementData, size, Object[].class);
}
/**
* 将ArrayList实例的容量裁剪到list当前大小Size。
* 应用程序使用该操作降低ArrayList实例占用的存储
* 因为清空等一些操作只改变参数而没有释放空间
*/
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = Arrays.copyOf(elementData, size);
}
}
/**
* 提升ArrayList实例的容量,确保它可以保存至少minCapacity的元素
* @param minCapacity the desired minimum capacity
*/
public void ensureCapacity(int minCapacity) {
//如果数组当前为空,添加元素时最小增长容量为DEFAULT_CAPACITY
//否则,增长容量大于0即可
int minExpand = (elementData != EMPTY_ELEMENTDATA)
// any size if real element table
? 0
// larger than default for 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 == EMPTY_ELEMENTDATA) {
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
}
ensureExplicitCapacity(minCapacity);
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++; //list结构被改变的次数
// overflow-conscious code
//目标容量大于当前容量才增长
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
/**
* 数组可分配最大容量,有些虚拟机中会给数组保存头部,尝试分配更大的数组会导致内存溢出
*/
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
/**
* 提升容量,保证它可以存储指定参数个元素
* @param minCapacity the desired minimum capacity
*/
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
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;
}
/**
* Returns the number of elements in this list.
*
* @return the number of elements in this list
*/
public int size() {
return size;
}
/**
* Returns <tt>true</tt> if this list contains no elements.
*
* @return <tt>true</tt> if this list contains no elements
*/
public boolean isEmpty() {
//直接返回size是否等于0
return size == 0;
}
/**
* 若列表中包含该元素就返回true,更严格的说,是当且仅当列表只含有一个当前元素时返回true
* @param o element whose presence in this list is to be tested
* @return <tt>true</tt> if this list contains the specified element
*/
public boolean contains(Object o) {
//indexOf方法返回值与0比较来判断对象是否在list中
return indexOf(o) >= 0;
}
/**
* 通过遍历elementData数组来判断对象是否在list中,若存在,返回首次出现的index(【0,size-1】)
* 若不存在,返回-1
* 所以contains方法可以通过indexOf(Object)方法的返回值来判断对象是否被包含在list中
*/
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;
}
/**
* 返回的是传入对象在elementData数组中最后出现的index值,没有则是-1
*/
public int lastIndexOf(Object o) {
if (o == null) {
//从后向前遍历数组,若遇到object则返回index值,若没有遇到,返回-1
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实例的浅表副本(不复制这些元素本身)
* @return a clone of this <tt>ArrayList</tt> instance
*/
public Object clone() {
try {
//调用父类的clone方法返回一个对象的副本
ArrayList<?> v = (ArrayList<?>) super.clone();
//将返回对象的elementData数组的内容赋值为原对象elementData数组的内容
v.elementData = Arrays.copyOf(elementData, size);
//将副本的modCount设置为0
v.modCount = 0;
return v;
} catch (CloneNotSupportedException e) {
// this shouldn't happen, since we are Cloneable
throw new InternalError(e);
}
}
/**
* 返回一个包含列表中所有元素的数组
* 返回的数组是一个安全的数组,即没有列表中的引用,是一个全新申请的数组
* @return an array containing all of the elements in this list in
* proper sequence
*/
public Object[] toArray() {
//拷贝elementData从0到size-1位置的元素到新数组并返回
return Arrays.copyOf(elementData, size);
}
/**
* 返回一个包含列表所有元素的数组,若指定数组和列表大小合适,就在数组中返回元素,否则,重新申请数组空间
* 若指定数组空间有多余,则把紧跟在元素后面的位置设为null
* @param a the array into which the elements of the list are to
* be stored, if it is big enough; otherwise, a new array of the
* same runtime type is allocated for this purpose.
* @return an array containing the elements of the list
* @throws ArrayStoreException if the runtime type of the specified array
* is not a supertype of the runtime type of every element in
* this list
* @throws NullPointerException if the specified array is null
*/
@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
//如果传入数组的长度小于size,返回一个新的数组,大小为size,类型与传入数组相同
if (a.length < size)
// Make a new array of a's runtime type, but my contents:
return (T[]) Arrays.copyOf(elementData, size, a.getClass());
//否则,将elementData复制到传入数组并返回传入的数组
System.arraycopy(elementData, 0, a, 0, size);
//若传入数组长度大于size,把返回数组的第size个元素置为空
if (a.length > size)
a[size] = null;
return a;
}
// Positional Access Operations
@SuppressWarnings("unchecked")
E elementData(int index) {
return (E) elementData[index];