集合之ArrayList源码学习
ArrayList是日常开发经常用到的数据结构,底层是用数组实现的List,相当于单纯的数组相比,ArrayList有动态扩容的能力并提供了很多动态数组的方法。
继承关系
ArrayList继承了AbstractList,实现了List, RandomAccess, Cloneable, java.io.Serializable等接口。
ArrayList实现了List,提供了基础的添加、删除、查找、遍历等操作。
ArrayList实现了RandomAccess,提供了随机访问的能力。
ArrayList实现了Cloneable,可以被克隆。
ArrayList实现了Serializable,可以被序列化。
属性
private static final int DEFAULT_CAPACITY = 10;
//空的数组,这种是通过new ArrayList(0)创建时用的是这个空数组。
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
*也是空数组,这种是通过new ArrayList()创建时用的是这个空数组,
*与EMPTY_ELEMENTDATA的区别是在添加第一个元素时使用这个空数组的会初始化为DEFAULT_CAPACITY(10)个元素。
**/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
//真正存放元素的地方,使用transient是为了不序列化这个字段。
transient Object[] elementData; // non-private to simplify nested class access
//真正存储元素的个数,不代表elementData的大小
private int size;
ArrayList底层是一个Object数组,存储元素的大小有专门的size字段计算,因为存储元素的elementData数组是动态扩容的,可能没有存储数组。
属性定义了两个空数组EMPTY_ELEMENTDATA 和DEFAULTCAPACITY_EMPTY_ELEMENTDATA ,EMPTY_ELEMENTDATA 用在构造器为new ArrayList(0)创建时用的是这个空数组,DEFAULTCAPACITY_EMPTY_ELEMENTDATA用在不传参构造使用。在扩容的时DEFAULTCAPACITY_EMPTY_ELEMENTDATA 默认是扩展为10,EMPTY_ELEMENTDATA 无这个特性
elementData方法被transient 标识。使用transient是为了不序列化这个字段。ArrayList实现序列化反序列化方法writeObject、readObject
//序列化
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException{
// 防止序列化期间有修改
int expectedModCount = modCount;
// 写出非transient非static属性
s.defaultWriteObject();
// 写出元素个数
s.writeInt(size);
// 依次写出元素
for (int i=0; i<size; i++) {
s.writeObject(elementData[i]);
}
// 期间有修改,则抛出异常
if (modCount != expectedModCount) {
throw new ConcurrentModificationException();
}
}
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// 声明为空数组
elementData = EMPTY_ELEMENTDATA;
// 读入非transient非static属性
s.defaultReadObject();
// 读入元素个数,没什么用,只是因为写出的时候写了size属性,读的时候也要按顺序来读
s.readInt();
if (size > 0) {
// 计算容量
int capacity = calculateCapacity(elementData, size);
SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);
// 检查是否需要扩容
ensureCapacityInternal(size);
Object[] a = elementData;
// 依次读取元素到数组中
for (int i=0; i<size; i++) {
a[i] = s.readObject();
}
}
}
查看writeObject()方法可知,先调用s.defaultWriteObject()方法,再把size写入到流中,再把元素一个一个的写入到流中。
一般地,只要实现了Serializable接口即可自动序列化,writeObject()和readObject()是为了自己控制序列化的方式,这两个方法必须声明为private,在java.io.ObjectStreamClass#getPrivateMethod()方法中通过反射获取到writeObject()这个方法。
在ArrayList的writeObject()方法中先调用了s.defaultWriteObject()方法,这个方法是写入非static非transient的属性,在ArrayList中也就是size属性。同样地,在readObject()方法中先调用了s.defaultReadObject()方法解析出了size属性。
elementData定义为transient的优势,自己根据size序列化真实的元素,而不是根据数组的长度序列化元素,减少了空间占用。
常用的构造方法
ArrayList(int initialCapacity)构造方法
传入初始容量,大于0就初始化elementData为对应大小,如果等于0就使用EMPTY_ELEMENTDATA空数组,如果小于0抛出异常。
public ArrayList(int initialCapacity) {
if (initialCapacity > 0) {
// 初始容量大于0,初始化elementData的数组大小
this.elementData = new Object[initialCapacity];
} else if (initialCapacity == 0) {
// 初始容量等于0,使用空数组EMPTY_ELEMENTDATA
this.elementData = EMPTY_ELEMENTDATA;
} else {
// 小于0则抛出异常
throw new IllegalArgumentException("Illegal Capacity: " + initialCapacity);
}
}
ArrayList()构造方法
不传初始容量,初始化为DEFAULTCAPACITY_EMPTY_ELEMENTDATA空数组。会在后续的扩容时判断是DEFAULTCAPACITY_EMPTY_ELEMENTDATA的话就扩容为10;
public ArrayList() {
// 无参构造方法,数组elementData赋值为有默认容器大小标识的空数组
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
ArrayList(Collection<? extends E> c)构造方法
传入集合并初始化elementData,这里会使用拷贝把传入集合的元素拷贝到elementData数组中,如果元素个数为0,则初始化为EMPTY_ELEMENTDATA空数组。
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)、add(int index, E element)、addAll(Collection<? extends E> c)等。
add(E e)方法
添加元素到数组尾部,平均时间复杂度为O(n)
public boolean add(E e) {
// 校验是否需要扩容
ensureCapacityInternal(size + 1);
// 把元素插入到最后一位
elementData[size++] = e;
return true;
}
扩容机制详解
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
private static int calculateCapacity(Object[] elementData, int minCapacity) {
//若当前的元素数组是DEFAULTCAPACITY_EMPTY_ELEMENTDATA,则日容器大小为10
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity);
}
return minCapacity;
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
//扩容
grow(minCapacity);
}
private void grow(int minCapacity) {
// overflow-conscious code
int oldCapacity = elementData.length;
// 新容量为旧容量的1.5倍
int newCapacity = oldCapacity + (oldCapacity >> 1);
// 如果新容量发现比需要的容量还小,则以需要的容量为准
if (newCapacity - minCapacity < 0)
newCapacity = minCapacity;
// 如果新容量已经超过最大容量了,则使用最大容量
if (newCapacity - MAX_ARRAY_SIZE > 0)
newCapacity = hugeCapacity(minCapacity);
// 拷贝出来一个新数组,扩容完成
elementData = Arrays.copyOf(elementData, newCapacity);
}
ArrayList扩容机制:
- 根据当前elementData的组数大小判断是否需要扩容,在数组可用空间不足的情况下扩容
- 当数组是DEFAULTCAPACITY_EMPTY_ELEMENTDATA时,初始容器大小为10
- 新容量是老容量的1.5倍(oldCapacity + (oldCapacity >> 1)),若加的容量比需要的容量还小,则以需要的容量为准
- 创建新容量的数组并把老数组拷贝到新数组
add(int index, E element)方法
添加元素到指定位置,平均时间复杂度为O(n)。
public void add(int index, E element) {
// 判断是数组下标是否越界
rangeCheckForAdd(index);
// 判断是否需要扩容
ensureCapacityInternal(size + 1);
// 将index位置及其之后的元素往后挪一位,则index位置处就空出来了
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
// 元素插入到index的位置
elementData[index] = element;
// 大小增1
size++;
}
private void rangeCheckForAdd(int index) {
if (index > size || index < 0)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
addAll(Collection<? extends E> c)方法
将一个集合添加到ArrayList中
public boolean addAll(Collection<? extends E> c) {
// 集合c转为数组
Object[] a = c.toArray();
int numNew = a.length;
// 判断是否需要扩容
ensureCapacityInternal(size + numNew);
// c中元素全部拷贝到数组的最后
System.arraycopy(a, 0, elementData, size, numNew);
// 大小增加c的大小
size += numNew;
// 如果c不为空就返回true,否则返回false
return numNew != 0;
}
删除元素
ArrayList提供了多个元素删除的方法:
remove(int index):删除指定下标位置元素
remove(Object o)、fastRemove(int index):删除指定元素
removeAll(Collection<?> c)、retainAll(Collection<?> c)、batchRemove(Collection<?> c, boolean complement)等等
remove(int index)
删除指定下标位置的元素,并整理数组。时间复杂度为O(n)
public E remove(int index) {
// 检查是否越界
rangeCheck(index);
modCount++;
// 获取index位置的元素
E oldValue = elementData(index);
// 如果index不是最后一位,则将index之后的元素往前挪一位
int numMoved = size - index - 1;
if (numMoved > 0)
//数组拷贝,index只有的元素往前挪一位
System.arraycopy(elementData, index+1, elementData, index, numMoved);
// 删除最后一个元素,帮助GC
elementData[--size] = null; // clear to let GC do its work
// 返回删除的值
return oldValue;
}
remove(Object o)、fastRemove(int index)
找出指定元素值第一次出现的位置,然后快速删除该位置的元素,时间复杂度为O(n)
public boolean remove(Object o) {
if (o == null) {
// 遍历数组,找到元素第一次出现的位置,并将其快速删除
for (int index = 0; index < size; index++)
// 如果要删除的元素为null,则以null进行比较,使用==
if (elementData[index] == null) {
fastRemove(index);
return true;
}
} else {
// 遍历数组,找到元素第一次出现的位置,并将其快速删除
for (int index = 0; index < size; index++)
// 使用equals()方法
if (o.equals(elementData[index])) {
fastRemove(index);
return true;
}
}
return false;
}
private void fastRemove(int index) {
// 相对于remove方法,少了一个越界校验、
modCount++;
// 判断index是不是最后一位,index为最后一位的话,不能挪动。不是的话需要把后面的元素往前挪一位
int numMoved = size - index - 1;
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index, numMoved);
// 将最后一个元素删除,帮助GC
elementData[--size] = null; // clear to let GC do its work
}
retainAll(Collection<?> c)方法
求两个集合的交集。
public boolean retainAll(Collection<?> c) {
// 集合c不能为null
Objects.requireNonNull(c);
// 调用批量删除方法,这时complement传入true,表示删除不包含在c中的元素
return batchRemove(c, true);
}
/**
* 批量删除元素
* complement为true标识删除c中不包含的元素
* complement为false表示删除c中包含的元素
*/
private boolean batchRemove(Collection<?> c, boolean complement) {
final Object[] elementData = this.elementData;
// 使用读写两个指针同时遍历数组
// 读指针每次自增1,写指针放入元素的时候才加1
// 这样不需要额外的空间,只需要在原有的数组上操作就可以了
int r = 0, w = 0;
boolean modified = false;
try {
// 遍历整个数组,如果c中包含该元素,则把该元素放到写指针的位置(以complement为准)
for (; r < size; r++)
if (c.contains(elementData[r]) == complement)
elementData[w++] = elementData[r];
} finally {
// 正常来说r最后是等于size的,除非c.contains()抛出了异常
if (r != size) {
// 如果c.contains()抛出了异常,则把未读的元素都拷贝到写指针之后
System.arraycopy(elementData, r,
elementData, w,
size - r);
w += size - r;
}
if (w != size) {
// 将写指针之后的元素置为空,帮助GC
for (int i = w; i < size; i++)
elementData[i] = null;
modCount += size - w;
// 新大小等于写指针的位置(因为每写一次写指针就加1,所以新大小正好等于写指针的位置)
size = w;
modified = true;
}
}
// 有修改返回true
return modified;
}
removeAll(Collection<?> c)
求两个集合的单方向差集,只保留当前集合中不在c中的元素,不保留在c中不在当前集体中的元素。
public boolean removeAll(Collection<?> c) {
// 集合c不能为空
Objects.requireNonNull(c);
// 同样调用批量删除方法,这时complement传入false,表示删除包含在c中的元素
return batchRemove(c, false);
}
元素查询、遍历
get(int index)
获取指定索引位置的元素,时间复杂度为O(1)。
public E get(int index) {
// 是否越界
rangeCheck(index);
// 返回数组index位置的元素
return elementData(index);
}
private void rangeCheck(int index) {
if (index >= size)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
E elementData(int index) {
return (E) elementData[index];
}
indexOf(Object o)、lastIndexOf
查询指定元素所在的下标位置。存在返回下标位置,不存在返回-1
//找出元素第一次出现在数组中的下标位置
public int indexOf(Object o) {
if (o == null) {
//从0开始遍历数组,找出第一个满足条件的下标并返回。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;
}
迭代器Iterator
ArrayList迭代器方法iterator()方法。可见next方法使用元素遍历。变更游标实现数组遍历
private class Itr implements Iterator<E> {
int cursor; // index of next element to return
int lastRet = -1; // index of last element returned; -1 if no such
int expectedModCount = modCount;
Itr() {}
public boolean hasNext() {
return cursor != size;
}
@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];
}
public void remove() {
if (lastRet < 0)
throw new IllegalStateException();
checkForComodification();
try {
ArrayList.this.remove(lastRet);
cursor = lastRet;
lastRet = -1;
expectedModCount = modCount;
} catch (IndexOutOfBoundsException ex) {
throw new ConcurrentModificationException();
}
}
@Override
@SuppressWarnings("unchecked")
public void forEachRemaining(Consumer<? super E> consumer) {
Objects.requireNonNull(consumer);
final int size = ArrayList.this.size;
int i = cursor;
if (i >= size) {
return;
}
final Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length) {
throw new ConcurrentModificationException();
}
while (i != size && modCount == expectedModCount) {
consumer.accept((E) elementData[i++]);
}
// update once at end of iteration to reduce heap write traffic
cursor = i;
lastRet = i - 1;
checkForComodification();
}
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
}
总结
- ArrayList底层使用数组存储元素,当数组长度不够时进行扩容,扩容为原来的1.5倍。
- ArrayList支持随机访问,可以通过元素下标快速定位查询数据,时间复杂度O(1)。
- ArrayList提供了多种添加元素方法,在队尾加入时间复杂度为O(1),在指定位置添加需要挪动元素位置为O(n)。
- ArrayList删除元素跟添加相似,队尾删除O(1),队中删除要挪动元素时间复杂度为O(n)。
- ArrayList提供了两个集合交集、并集、单向差集的方法。retainAll(Collection<? extends E> c)、addAll(Collection<? extends E> c)、removeAll(Collection<? extends E> c)
- ArrayList是线程不安全的,当多个线程操作时可能存在线程不安全问题。