详细解读ArrayList
详细解读ArrayList
为什么突然写这个呢，就是怕面试时候面试官问:"读过哪些源码，请详细描述一个你最熟悉的？"所以打算要吃透至少一个方面
ArrayList 简介
ArrayList 是一个数组队列，相当于 动态数组。与 Java 中的数组相比，它的容量能动态增长。它继承于 AbstractList，实现了 List, RandomAccess, Cloneable, java.io.Serializable 这些接口。
ArrayList 继承了 AbstractList，实现了 List。它是一个数组队列，提供了相关的添加、删除、修改、遍历等功能。
ArrayList 实现了 RandmoAccess 接口，即提供了随机访问功能。RandmoAccess 是 java 中用来被 List 实现，为 List 提供快速访问功能的。在 ArrayList 中，我们即可以通过元素的序号快速获取元素对象；这就是快速随机访问。稍后，我们会比较 List 的 “快速随机访问” 和“通过 Iterator 迭代器访问”的效率。
ArrayList 实现了 Cloneable 接口，即覆盖了函数 clone()，能被克隆。
ArrayList 实现 java.io.Serializable 接口，这意味着 ArrayList 支持序列化，能通过序列化去传输。
和 Vector 不同，ArrayList 中的操作不是线程安全的！所以，建议在单线程中才使用 ArrayList，而在多线程中可以选择 Vector 或者 CopyOnWriteArrayList。
下面让我们翻开 ArrayList 的源代码，看看一些常用的方法属性，以及一些需要注意的地方。
ArrayList 属性
ArrayList 属性主要就是当前数组长度 size，以及存放数组的对象 elementData 数组，除此之外还有一个经常用到的属性就是从 AbstractList 继承过来的 modCount 属性，代表 ArrayList 集合的修改次数。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, Serializable {
// 序列化id
private static final long serialVersionUID = 8683452581122892189L;
// 默认初始的容量
private static final int DEFAULT_CAPACITY = 10;
// 一个空对象
private static final Object[] EMPTY_ELEMENTDATA = new Object[0];
// 一个空对象，如果使用默认构造函数创建，则默认对象内容默认是该值
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = new Object[0];
// 当前数据对象存放地方，当前对象不参与序列化
transient Object[] elementData;
// 当前数组长度
private int size;
// 数组最大长度
private static final int MAX_ARRAY_SIZE = 2147483639;
// 省略方法。。
}
ArrayList 构造函数
无参构造函数
如果不传入参数，则使用默认无参构建方法创建 ArrayList 对象，如下：
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
注意：此时我们创建的 ArrayList 对象中的 elementData 中的长度是 1，size 是 0, 当进行第一次 add 的时候，elementData 将会变成默认的长度：10.
注意，ArrayList得到默认长度不是在对象初始化的时候，而是在第一次插入的时候
带 int 类型的构造函数
如果传入参数，则代表指定 ArrayList 的初始数组长度，传入参数如果是大于等于 0，则使用用户的参数初始化，如果用户传入的参数小于 0，则抛出异常，构造方法如下：
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);
}
}
带 Collection 对象的构造函数
1）将 collection 对象转换成数组，然后将数组的地址的赋给 elementData。
2）更新 size 的值，同时判断 size 的大小，如果是 size 等于 0，直接将空对象 EMPTY_ELEMENTDATA 的地址赋给 elementData
3）如果 size 的值大于 0，则执行 Arrays.copy 方法，把 collection 对象的内容（可以理解为深拷贝）copy 到 elementData 中。
注意：this.elementData = arg0.toArray(); 这里执行的简单赋值时浅拷贝，所以要执行 Arrays,copy 做深拷贝
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 方法
add 的方法有两个，一个是带一个参数的，一个是带两个参数的，下面我们一个个讲解。
add(E e) 方法
add 主要的执行逻辑如下：
1）确保数组已使用长度（size）加 1 之后足够存下 下一个数据
2）修改次数 modCount 标识自增 1，如果当前数组已使用长度（size）加 1 后的大于当前的数组长度，则调用 grow 方法，增长数组，grow 方法会将当前数组的长度变为原来容量的 1.5 倍。
3）确保新增的数据有地方存储之后，则将新元素添加到位于 size 的位置上。
4）返回添加成功布尔值。
添加元素方法入口：
public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
确保添加的元素有地方存储，当第一次添加元素的时候 this.size+1 的值是 1，所以第一次添加的时候会将当前 elementData 数组的长度变为 10：
private void ensureCapacityInternal(int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
}
ensureExplicitCapacity(minCapacity);
}
将修改次数（modCount）自增 1，判断是否需要扩充数组长度, 判断条件就是用当前所需的数组最小长度与数组的长度对比，如果大于 0，则增长数组长度。
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
如果当前的数组已使用空间（size）加 1 之后 大于数组长度，则增大数组容量，扩大为原来的 1.5 倍。
private void grow(int arg0) {
int arg1 = this.elementData.length;
int arg2 = arg1 + (arg1 >> 1);
if (arg2 - arg0 < 0) {
arg2 = arg0;
}
if (arg2 - 2147483639 > 0) {
arg2 = hugeCapacity(arg0);
}
this.elementData = Arrays.copyOf(this.elementData, arg2);
}
add(int index, E element) 方法
这个方法其实和上面的 add 类似，该方法可以按照元素的位置，指定位置插入元素，具体的执行逻辑如下：
1）确保数插入的位置小于等于当前数组长度，并且不小于 0，否则抛出异常
2）确保数组已使用长度（size）加 1 之后足够存下 下一个数据
3）修改次数（modCount）标识自增 1，如果当前数组已使用长度（size）加 1 后的大于当前的数组长度，则调用 grow 方法，增长数组
4）grow 方法会将当前数组的长度变为原来容量的 1.5 倍。
5）确保有足够的容量之后，使用 System.arraycopy 将需要插入的位置（index）后面的元素统统往后移动一位。
6）将新的数据内容存放到数组的指定位置（index）上
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++;
}
注意：使用该方法的话将导致指定位置后面的数组元素全部重新移动，即往后移动一位。
get 方法
返回指定位置上的元素，
public E get(int index) {
rangeCheck(index);
checkForComodification();
return ArrayList.this.elementData(offset + index);
}
set 方法
确保 set 的位置小于当前数组的长度（size）并且大于 0，获取指定位置（index）元素，然后放到 oldValue 存放，将需要设置的元素放到指定的位置（index）上，然后将原来位置上的元素 oldValue 返回给用户。
public E set(int index, E element) {
rangeCheck(index);
E oldValue = elementData(index);
elementData[index] = element;
return oldValue;
}
contains 方法
调用 indexOf 方法，遍历数组中的每一个元素作对比，如果找到对于的元素，则返回 true，没有找到则返回 false。
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;
}
remove 方法
根据索引 remove
1）判断索引有没有越界
2）自增修改次数
3）将指定位置（index）上的元素保存到 oldValue
4）将指定位置（index）上的元素都往前移动一位
5）将最后面的一个元素置空，好让垃圾回收器回收
6）将原来的值 oldValue 返回
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;
}
注意：调用这个方法不会缩减数组的长度，只是将最后一个数组元素置空而已。
注意ArrayList是可以保存null的
根据对象 remove
循环遍历所有对象，得到对象所在索引位置，然后调用 fastRemove 方法，执行 remove 操作
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;
}
定位到需要 remove 的元素索引，先将 index 后面的元素往前面移动一位（调用 System.arraycooy 实现），然后将最后一个元素置空。
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
}
clear 方法
添加操作次数（modCount），将数组内的元素都置空，等待垃圾收集器收集，不减小数组容量。
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
通过置null的方式，将栈上的引用置为null,消除对堆中对象的强引用，以便于gc对对象进行回收
sublist 方法
我们看到代码中是创建了一个 ArrayList 类里面的一个内部类 SubList 对象，传入的值中第一个参数时 this 参数，其实可以理解为返回当前 list 的部分视图，真实指向的存放数据内容的地方还是同一个地方，如果修改了 sublist 返回的内容的话，那么原来的 list 也会变动。
public List<E> subList(int arg0, int arg1) {
subListRangeCheck(arg0, arg1, this.size);
return new ArrayList.SubList(this, 0, arg0, arg1);
}
SubList内部类:
private static class SubList<E> extends AbstractList<E> implements RandomAccess {
private final ArrayList<E> root;
private final ArrayList.SubList<E> parent;
private final int offset;
private int size;
···
private SubList(ArrayList.SubList<E> parent, int fromIndex, int toIndex) {
this.root = parent.root;
this.parent = parent;
this.offset = parent.offset + fromIndex;
this.size = toIndex - fromIndex;
this.modCount = this.root.modCount;
}
public E get(int index) {
Objects.checkIndex(index, this.size);
this.checkForComodification();
return this.root.elementData(this.offset + index);
}
}
从上面可以看到，subList并不对数据进行拷贝，返回的依然是原数据的引用
trimToSize 方法
1）修改次数加 1
2）将 elementData 中空余的空间（包括 null 值）去除，例如：数组长度为 10，其中只有前三个元素有值，其他为空，那么调用该方法之后，数组的长度变为 3.
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}
目的是减少内存占用
iterator 方法
interator 方法返回的是一个内部类，由于内部类的创建默认含有外部的 this 指针，所以这个内部类可以调用到外部类的属性。
public Iterator<E> iterator() {
return new Itr();
}
一般的话，调用完 iterator 之后，我们会使用 iterator 做遍历，这里使用 next 做遍历的时候有个需要注意的地方，就是调用 next 的时候，可能会引发 ConcurrentModificationException，当修改次数，与期望的修改次数（调用 iterator 方法时候的修改次数）不一致的时候，会发生该异常，详细我们看一下代码实现：
@SuppressWarnings("unchecked")
public E next() {
checkForComodification();
int i = cursor;
if (i >= size)
throw new NoSuchElementException();
Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length)
throw new ConcurrentModificationException();
cursor = i + 1;
return (E) elementData[lastRet = i];
}
expectedModCount 这个值是在用户调用 ArrayList 的 iterator 方法时候确定的，但是在这之后用户 add，或者 remove 了 ArrayList 的元素，那么 modCount 就会改变，那么这个值就会不相等，将会引发 ConcurrentModificationException 异常，这个是在多线程使用情况下，比较常见的一个异常。
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
fail-fast 机制是 java 集合 (Collection) 中的一种错误机制。当多个线程对同一个集合的内容进行操作时，就可能会产生 fail-fast 事件。
例如：当某一个线程 A 通过 iterator 去遍历某集合的过程中，若该集合的内容被其他线程所改变了；那么线程 A 访问集合时，就会抛出 ConcurrentModificationException 异常，产生 fail-fast 事件。
System.arraycopy 方法
| 参数 | 说明 |
|---|---|
| src | 原数组 |
| srcPos | 原数组 |
| dest | 目标数组 |
| destPos | 目标数组的起始位置 |
| length | 要复制的数组元素的数目 |
Arrays.copyOf 方法
original - 要复制的数组
newLength - 要返回的副本的长度
newType - 要返回的副本的类型
其实 Arrays.copyOf 底层也是调用 System.arraycopy 实现的源码如下：
//基本数据类型（其他类似byte，short···）
public static int[] copyOf(int[] original, int newLength) {
int[] copy = new int[newLength];
System.arraycopy(original, 0, copy, 0,
Math.min(original.length, newLength));
return copy;
}
小结
ArrayList 总体来说比较简单，不过 ArrayList 还有以下一些特点：
- ArrayList 自己实现了序列化和反序列化的方法，因为它自己实现了 private void writeObject(java.io.ObjectOutputStream s) 和 private void readObject(java.io.ObjectInputStream s) 方法
- ArrayList 基于数组方式实现，无容量的限制（会扩容）
- 添加元素时可能要扩容（所以最好预判一下），删除元素时不会减少容量（若希望减少容量，trimToSize()），删除元素时，将删除掉的位置元素置为 null，下次 gc 就会回收这些元素所占的内存空间。
- 线程不安全
- add(int index, E element)：添加元素到数组中指定位置的时候，需要将该位置及其后边所有的元素都整块向后复制一位
- get(int index)：获取指定位置上的元素时，可以通过索引直接获取（O(1)）
- remove(Object o) 需要遍历数组
- remove(int index) 不需要遍历数组，只需判断 index 是否符合条件即可，效率比 remove(Object o) 高
- contains(E) 需要遍历数组
- 使用 iterator 遍历可能会引发多线程异常
浙公网安备 33010602011771号