源码解读之 ArrayList
ArrayList 的特点
- ArrayList 使用 Object[] elementData; 数组来存储对象；
- ArrayList 使用 size 字段来确定 elementData 数组中存在多少个不为 null 的值来表示集合的大小。
- modCount 继承自 AbstractList 类，用来表示集合的修改次数。
- 添加元素时（add(E e)方法）扩容机制如下：
- int newCapacity = oldCapacity + (oldCapacity >> 1);
- 在原有容量的基础上，右移 1 位再加上原来的容量。（右移 1 位就是除以 2 的 1 次方，右移 2 位就是除以 2 的 2 次方）
- 比如原来的容量为 4，扩容后的容量 = 4 + （4 / 2）= 6. 相对于原来的容量 4 来说，就是扩容了 6 / 4 = 1.5 倍。
- 在某个位置添加元素时（add(int index, E element)），数组中元素的复制机制如下：
- 判断容量是否足够，不够时扩容；
- 复制原来数组中 index 前面的所有元素到新数组，然后空一个位置（就是 index 所在的位置），再把原来数组中 index 位置及后面的所有元素复制到新数组；
- 最后，把新添加的元素保存到新数组的 index 的位置，完成元素的添加。
- 清空集合时（clear() 方法），for 循环变量 elementData 数组，然后把每一项的引用都指向 null 对象，size 字段设置为 0，完成清空操作；
- elementData 数组一旦扩容，即使使用 clear() 清空集合，虽然 size 为 0，但是 数组 elementData 的长度依然不会减少，尽管数组里面的每一项都指向 null。如果需要将 elementData 缩减为 size 的大小，使用 trimToSize() 方法，清除数组中冗余的位置。
ArrayList 的类结构
java
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
private static final long serialVersionUID = 8683452581122892189L;
/**
* Default initial capacity.
*/
private static final int DEFAULT_CAPACITY = 10;
/**
* Shared empty array instance used for empty instances.
*/
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 = {};
/**
* The array buffer into which the elements of the ArrayList are stored.
* The capacity of the ArrayList is the length of this array buffer. Any
* empty ArrayList with elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA
* will be expanded to DEFAULT_CAPACITY when the first element is added.
*
* 用来存储对象的数组
*/
transient Object[] elementData; // non-private to simplify nested class access
/**
* The size of the ArrayList (the number of elements it contains).
*
* 集合的大小，一般情况下 Object[] elementData >= size，elementData 中多余的位置存储的值为 null
* @serial
*/
private int size;
}ArrayList 的构造函数
java
public ArrayList() {
this.elementData = DEFAULTCAPACITY_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);
}
}
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) 方法
java
public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
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 static int calculateCapacity(Object[] elementData, int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity);
}
return minCapacity;
}
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
// 扩容方法，来保证添加的元素能够有足够的容量存放这个元素。
private void grow(int minCapacity) {
// overflow-conscious code
int oldCapacity = elementData.length;
// 在原有容量的基础上，右移 1 位再加上原来的容量。（右移 1 位就是除以 2 的 1 次方，右移 2 位就是除以 2 的 2 次方）
// 比如原来的容量为 4，扩容后的容量 = 4 + （4 / 2）= 6. 相对于原来的容量 4 来说，就是扩容了 6 / 4 = 1.5 倍。
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;
}add(int index, E element) 方法
java
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++;
}set(int index, E element) 方法
java
public E set(int index, E element) {
rangeCheck(index);
E oldValue = elementData(index);
elementData[index] = element;
return oldValue;
}get(int index) 方法
java
public E get(int index) {
rangeCheck(index);
return elementData(index);
}remove(int index) 方法
java
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;
}clear() 方法
java
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}size() 方法
java
public int size() {
return size;
}add(E e) 方法
java
// 一般情况下 Object[] elementData >= size，elementData 中多余的位置存储的值为 null，就造成了 elementData 位置冗余，使用 trimToSize 方法就可以清除这些冗余，使 elementData 的长度等于 size 的大小。
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}