ArrayList源码解析(jdk1.8)

时间:2022-05-19 19:37:10

概述

ArrayList是基于数组实现的,它可以动态的增加和减少元素,灵活的设置数组的大小。

构造方法

分析该类,我们从构造方法中开始:

private static final int DEFAULT_CAPACITY = 10;

transient Object[] elementData;

private static final Object[] 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() {
this.elementData = DEFAULTCAPACITY_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;
}
}

重载了三个构造方法,在构造方法中都是初始化了数组对象elementData,该数组就是用来存储集合中的元素。默认情况下,该数组中存储元素为空。

注:elementData被关键字transient修饰。

Java的serialization提供了一种持久化对象实例的机制。当持久化对象时,可能有一个特殊的对象数据成员,我们不想用serialization机制来保存它。为了在一个特定对象的一个域上关闭serialization,可以在这个域前加上关键字transient。

添加元素add/addAll

ArrayList使用add方法来添加元素,如:

public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}

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++;
}

add也使用了方法重载,我们使用第一个方法直接在数组末尾添加一个元素。第二个方法用于在指定位置上添加该元素。我们分别来分析:
在add(E e)中,首先会执行ensureCapacityInternal方法:

private void ensureCapacityInternal(int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
}

ensureExplicitCapacity(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;
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;
}
  1. 在ensureCapacityInternal中,首先来判断数组elementData是否为空数组,如果是的话,比较传入的参数大小和系统默认的容量大小10,取其最大值;
  2. 将上面得到的最大值作为参数,传入ensureExplicitCapacity方法中。如果传入的参数大于数组的长度,那么就执行grow方法;
  3. 获取新的容量值newCapacity,将重新生成elementData对象并且将旧的elementData数据拷贝过来。

在add(int index, E element)方法中:
1. 首先通过方法rangeCheckForAdd来判断index的合法性;
2. 然后同样执行ensureCapacityInternal方法,逻辑与上面一致;
3. 使用系统方法将index之后的数据赋值到数组中来,留出index位置;
4. 将element赋值到index位置中;

ArrayList使用addAll方法来添加元素,如:

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;
}

ArrayList使用addAll可以将整个集合添加进来,
在addAll(Collection

删除元素remove/removeAll

ArrayList使用remove方法来添加元素,如:

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;
}

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索引值来删除对应的数组元素,另一个是通过存储的对象来删除对象。

通过索引index来删除元素:
1. 首先通过rangeCheck来判断index的合法性;
2. 将index之后的数据copy到elementData中来;
3. elementData数量减一;

通过Object对象来删除元素:

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
}
  1. o为空时,通过遍历elementData中的元素,将elementData数组中为空的元素全部删除;
  2. o不为空时,遍历elementData中的元素,将elementData中等于o的数据删除;

其他常用的操作get/clear/forEach/contains

public E get(int index) {
rangeCheck(index);

return elementData(index);
}

直接通过index获取elementData数组的元素;

public void clear() {
modCount++;

// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;

size = 0;
}

遍历elementData数组,将元素都置为null,设置size为0;

@Override
public void forEach(Consumer<? super E> action) {
Objects.requireNonNull(action);
final int expectedModCount = modCount;
@SuppressWarnings("unchecked")
final E[] elementData = (E[]) this.elementData;
final int size = this.size;
for (int i=0; modCount == expectedModCount && i < size; i++) {
action.accept(elementData[i]);
}
if (modCount != expectedModCount) {
throw new ConcurrentModificationException();
}
}

遍历数组elementData,然后将其中元素通过Consumer暴露外部接收;

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;
}

遍历数组取出对应的元素,如果存在返回中对应的index值,否则返回-1。

总结:
1. ArrayList基于数组方式实现,动态改变数组的容量大小,可以通过下标索引直接查找到指定位置的元素,因此查找效率高,但每次插入或删除元素,就要大量地移动元素,插入删除元素的效率低;
2. 构造方法中,无参构造方法构造的ArrayList的容量默认为10,带有Collection参数的构造方法,将Collection转化为数组赋给ArrayList的实现数组elementData。
3. 在查找给定元素索引值等的方法中,源码都将该元素的值分为null和不为null两种情况处理,ArrayList中允许元素为null。
4. 线程不安全;