ArrayList 的扩容机制
- 1. 类结构
- 1.1. 继承
- 1.2. 实现关系
- 2. 构造函数
- 2.1. 无参构造函数
- 前置
- 构造函数
- 2.2. 有参构造函数
- 前置
- 构造函数
- 总结
- 3. add方法
- 3.1. add(E e)
- 3.2. add(int index, E element)
首先,我们要明确的是ArrayList 是基于 Array 数组实现的动态List类。
1. 类结构
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
分析:
1.1. 继承
- AbstractList
这里有一个多态的思想,在接口中全都是抽象的方法,而抽象类中可以有抽象方法,还可以有具体的实现方法,正是利用了这一点,让AbstractList是实现接口中一些通用的方法,而具体的类,如ArrayList就继承这个AbstractList类,拿到一些通用的方法,然后自己在实现一些自己特有的方法。
1.2. 实现关系
- List
实际上,实现List接口并没有什么作用,因为在AbstractList中就已经实现了这个接口。 开发的作者其实有说道:这其实是个错误,写这代码的时候觉得这个会有用处,但是其实并没什么用。 - RandomAccess
它的作用就是用来快速随机存取,有关效率的问题,在实现了该接口的话,那么使用普通的for循环来遍历,性能更高。
没有实现该接口的话,使用Iterator来迭代,这样性能更高,例如linkedList。
这个标记性只是为了让我们知道我们用什么样的方式去获取数据性能更好。 - Cloneable
可以使用Object.Clone()方法。 - Serializable
序列化接口,表明该类可以被序列化。
2. 构造函数
2.1. 无参构造函数
前置
/**
* 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.
* translation :数组缓冲区,存储数组列表中的元素。数组列表的容量是这个数组缓冲区的长度。任何空数组列表,
* 元素数据== DEFAULTCAPACITY_EMPTY_ELEMENTDATA当添加第一个元素时,将扩展为DEFAULT_CAPACITY。
*/
transient Object[] elementData;
// non-private to simplify nested class access
// translation : 非私有以简化嵌套类访问
/**
* 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.
* 共享空数组实例,用于默认大小的空实例。我们将其与EMPTY_ELEMENTDATA区分开来,以便知道在添加第一个元素时* 膨胀多少。
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
以下代码说明了ArrayList的初始化长度为10:
/**
* Default initial capacity. 初始化长度为10
*/
private static final int DEFAULT_CAPACITY = 10;
构造函数
/**
* Constructs an empty list with an initial capacity of ten.
* 构造一个初始容量为10的空列表。-- 在这指明了ArrayList的初始长度为10
*/
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
2.2. 有参构造函数
这里只列举了一种常用:
前置
/**
* Shared empty array instance used for empty instances.
* 用于空实例的共享空数组实例。
*/
private static final Object[] EMPTY_ELEMENTDATA = {};
构造函数
/**
* Constructs an empty list with the specified initial capacity.
* 构造具有指定初始容量的空列表。
*
* @param initialCapacity the initial capacity of the list
* initialCapacity列表的初始容量,实际就是长度
* @throws IllegalArgumentException if the specified initial capacity is negative
* 如果指定的初始容量为负数,则异常
*/
public ArrayList(int initialCapacity) {
if (initialCapacity > 0) {
// 大于0时,构造一个initialCapacity长度的数组Array
this.elementData = new Object[initialCapacity];
} else if (initialCapacity == 0) {
// 等于0时,空实例
this.elementData = EMPTY_ELEMENTDATA;
} else {
// 负数时,异常
throw new IllegalArgumentException("Illegal Capacity: "+ initialCapacity);
}
}
总结
在ArrayList中,构造函数实际上就只做了一件事,就是初始化了该容器的一个大小,但是它的本质上还是一个Array,在源码中就叫做 elementData。
3. add方法
3.1. add(E e)
直接在尾部添加元素:
/**
* Appends the specified element to the end of this list.
* 将指定的元素追加到此列表的末尾。
*
* @param e element to be appended to this list
* 要添加到该列表的E元素
* @return <tt>true</tt> (as specified by {@link Collection#add})
*/
public boolean add(E e) {
// 确定内部容量是否够了,size是数组中数据的个数,因为要添加一个元素,所以size+1,先判断size+1 // 的这个个数数组能否放得下,就在这个方法中去判断是否数组.length是否够用了。
ensureCapacityInternal(size + 1); // Increments modCount!! -- 增量
elementData[size++] = e;
return true;
}
// 确定内部容量
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
/*第一种情况:由于elementData初始化时是空的数组,那么第一次add的时候,minCapacity=size+1; 也就minCapacity=1,在上一个方法(确定内部容量ensureCapacityInternal)就会判断出是空的数 组,就会给将minCapacity=10,到这一步为止,还没有改变elementData的大小。
第二种情况:elementData不是空的数组了,那么在add的时候,minCapacity=size+1;也就是 minCapacity代表着elementData中增加之后的实际数据个数,拿着它判断elementData的length是 否够用,如果length不够用,那么肯定要扩大容量,不然增加的这个元素就会溢出。
*/
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
private static int calculateCapacity(Object[] elementData, int minCapacity) {
// 判断初始化的elementData是不是空的数组,也就是没有长度
/** 因为如果是空的话,minCapacity=size+1;其实就是等于1,空的数组没有长度就存放不了,所以就将 * minCapacity变成10,也就是默认大小,但是带这里,还没有真正的初始化这个elementData的大小。
* DEFAULT_CAPACITY=10
*/
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity);
}
return minCapacity;
}
/**
* 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;
//将扩充前的elementData大小给oldCapacity
int newCapacity = oldCapacity + (oldCapacity >> 1);
//newCapacity就是1.5倍的oldCapacity
if (newCapacity - minCapacity < 0)
/**这句话就是适应于elementData就空数组的时候,length=0,那么oldCapacity=0,
newCapacity=0,所以这个判断成立,在这里就是真正的初始化elementData的大小了,就是为10.前
面的工作都是准备工作。*/
newCapacity = minCapacity;
if (newCapacity - MAX_ARRAY_SIZE > 0)
/**如果newCapacity超过了最大的容量限制,就调用hugeCapacity,也就是将能给的最大值给
newCapacity
*/
newCapacity = hugeCapacity(minCapacity);
// minCapacity is usually close to size, so this is a win:
elementData = Arrays.copyOf(elementData, newCapacity);
// 新的容量大小已经确定好了,就copy数组,改变容量大小咯。
}
//用来赋最大值。
private static int hugeCapacity(int minCapacity) {
if (minCapacity < 0) // overflow
throw new OutOfMemoryError();
/**如果minCapacity都大于MAX_ARRAY_SIZE,那么就Integer.MAX_VALUE返回,反之将MAX_ARRAY_SIZE返
回。因为maxCapacity是三倍的minCapacity,可能扩充的太大了,就用minCapacity来判断了。*/
/**Integer.MAX_VALUE:2147483647 MAX_ARRAY_SIZE:2147483639 也就是说最大也就能给到第一个数值。 还是超过了这个限制,就要溢出了。相当于arraylist给了两层防护。*/
return (minCapacity > MAX_ARRAY_SIZE) ?
Integer.MAX_VALUE :
MAX_ARRAY_SIZE;
}
3.2. add(int index, E element)
指定下标添加元素:
/**
* Inserts the specified element at the specified position in this
* list. Shifts the element currently at that position (if any) and
* any subsequent elements to the right (adds one to their indices).
* 将指定的元素插入到此列表中的指定位置。将当前位置的元素(如果有的话)和随后的元素向右移动(给它们的下 * 标加1)。
* @param index index at which the specified element is to be inserted
* @param element element to be inserted
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
public void add(int index, E element) {
// 检查index也就是插入的位置是否合理,不能超出size和小于0
rangeCheckForAdd(index);
// 与add(E e)方法一致
ensureCapacityInternal(size + 1); // Increments modCount!!
//这个方法就是用来在插入元素之后,要将index之后的元素都往后移一位,
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
//在目标位置上存放元素
elementData[index] = element;
// size+1
size++;
}
System.arraycopy(…):就是将elementData在插入位置后的所有元素往后面移一位。
/**
* A version of rangeCheck used by add and addAll.
* 一个由add和addAll使用的rangeCheck版本
*/
private void rangeCheckForAdd(int index) {
if (index > size || index < 0)
//插入的位置肯定不能大于size 和小于0 如果是,就报这个越界异常
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}