ArrayList源码解析
1.总体概览
ArrayList的继承体系:
- 蓝色的是继承关系
- 绿色虚线是实现关系
ArrayList的定义:
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
2.属性分析
默认初始值大小为10
不同版本的jdk定义的初始值大小似乎是不同的,这里使用的是jdk1.8.0_171
private static final int DEFAULT_CAPACITY = 10;
private static final Object[] EMPTY_ELEMENTDATA = {};
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
transient Object[] elementData;
ArrayList的大小
private int size;
定义一个指定初始值大小的ArrayList
如果指定容量大于零,就构建一个对象的数组(这里也可以看出ArrayList底层存储结构是数组);如果指定容量等于零,就等于上面定义的空数组;否则抛异常
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);
}
}
构造一个不指定容量的空数组
当新建一个ArrayList而不指定容量时,默认为空
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
定义一个包含指定集合的ArrayList
将C转为数组,并赋值给集合长度
如果数组的长度不为0,且c.toArray()返回的不是Object[],重新复制
如果数组长度位0,令其等于空数组
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实例的容量调整为列表的当前大小,可以使用此操作来最小化ArrayList实例的存储
如果size等于0,置集合为空集合,否则按size修改集合的容量
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}
增加此ArrayList实例的容量,以确保它至少可以容纳由minCapacity参数指定的元素数
如果集合是空集合,minExpand为0,非空minExpand为10
如果minCapacity大于minExpand的时候,调用ensureExplicitCapacity(minCapacity)进行扩容
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);
}
}
确保需要扩容的大小
如果minCapacity大于此时集合的长度,调用grow(minCapacity)进行扩容
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
扩容方法
默认扩容为原来长度的1.5倍
如果扩容后还不够,那就扩容为需要的大小
如果扩容后的长度比数组的最大长度(Integer.MAX_VALUE - 8 = 2147483639)还大,令其等于MAX_VALUE = 2147483647进行扩容
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 = 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;
}
计算集合长度
public int size() {
return size;
}
判断集合是否为空,即判断size是否为0
public boolean isEmpty() {
return size == 0;
}
判断集合是否包含某个对象,即判断对象在集合中的位置是否大于等于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;
}
从后往前找出集合中某个对象的下标
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();
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);
}
}
将集合转为数组,调用的是数组的Arrays.copyOf()方法
public Object[] toArray() {
return Arrays.copyOf(elementData, size);
}
将集合转为指定类型的数组
public <T> T[] toArray(T[] a) {
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;
}
返回指定下标的对象
会先调用rangeCheck(index)方法对指定下标的位置进行检查,如果大于集合的size,抛出异常
public E get(int index) {
rangeCheck(index);
return elementData(index);
}
private void rangeCheck(int index) {
if (index >= size)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
对指定下标位置空间进行赋值,返回该下标赋值之前的对象
同样会调用rangeCheck(index)方法对指定下标的位置进行检查,如果大于集合的size,抛出异常
public E set(int index, E element) {
rangeCheck(index);
E oldValue = elementData(index);
elementData[index] = element;
return oldValue;
}
添加一个对象
先按当前长度加1调用ensureCapacityInternal(size + 1)进行扩容后,在集合末尾添加元素
总是在集合末尾添加元素且没有进行重复元素的判断,这里可以看出ArrayList集合是有序且重复的
public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
根据calculateCapacity(elementData, minCapacity)计算的结果确保需要扩容的实际大小,此处并不是计算的结果是多少就扩容多少
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
计算集合再添加元素时实际需要的大小
如果集合在添加元素之前是空集合,且此次扩容量不大于10则返回10;否则返回指定大小
private static int calculateCapacity(Object[] elementData, int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity);
}
return minCapacity;
}
在指定位置添加元素
首先调用rangeCheckForAdd(int index)方法对该指定位置进行判断,其次对size+1进行是否扩容进行判断,然后将指定位置后面的元素向后移一个位置后将该添加的元素放到指定的位置上,并将size+1
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++;
}
对执行下标进行合法性判断,确保指定的这个下标不大于集合长度且不小于0
private void rangeCheckForAdd(int index) {
if (index > size || index < 0)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
移除指定位置的元素并返回删除之前的元素
会将集合长度减1,将指定位置后面的元素向前移一位
这里可以看出ArrayList每次加减元素都可能要对其它元素进行移动,所以ArrayList不适合频繁增删的场景
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;
}
移除指定元素
先查出来元素所在位置,再调用fastRemove(index)方法移除
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;
}
将另一个集合全部添加到该集合中
会在添加操作之前对假设添加后集合的长度进行检查,不够进行扩容
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;
}
在指定位置将另一个集合全部添加进去
先对指定位置的合法性进行校验,然后确保是否扩容
先将指定位置后面的元素后移所添加集合的长度个位置,再将添加集合放进来
此处看出这个在指定位置将另一个集合全部添加进去的操作真的是很费经了
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;
}
移除本集合中包含指定集合的所有元素
先对指定集合的引用做合法性判断,再调用batchRemove()方法进行移除操作
public boolean removeAll(Collection<?> c) {
Objects.requireNonNull(c);
return batchRemove(c, false);
}
batchRemove()方法,根据布尔值complement移除一个集合内包含或者不包含另一个集合的元素
假设complement为false,即移除集合内不包含另一个集合的元素
设置两个变量r和w初始值为0,从r开始遍历本集合,如果c集合包含第r个元素,将这个元素放置到w的位置上,然后将w加1
遍历结束之后如果r不是集合的长度(在try中可能抛出异常,比如C是空集合),将集合中r之后的元素复制到从w开始的位置之后
如果w不等于集合的长度,将w之后的元素置为空,让GC收集内存
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;
}
移除本集合内不包含另一个集合的元素
先判断另一个集合是否是空,然后调用batchRemove()方法进行移除操作
public boolean retainAll(Collection<?> c) {
Objects.requireNonNull(c);
return batchRemove(c, true);
}
从集合的指定位置开始返回一个列表迭代器
public ListIterator<E> listIterator(int index) {
if (index < 0 || index > size)
throw new IndexOutOfBoundsException("Index: "+index);
return new ListItr(index);
}
返回一个包含集合全部元素的列表迭代器
public ListIterator<E> listIterator() {
return new ListItr(0);
}
返回一个包含集合全部元素的迭代器
public Iterator<E> iterator() {
return new Itr();
}