ArrayList 源码理解分析和使用

文章目录

• 1. ArrayList添加元素、三种遍历方法
• 2. ArrayList源码的成员变量
• 3. ArrayList源码的三种构造函数
• 4. ArrayList的所有源码及分析注释
• 5.补充知识：Arrays.copyOf的源码，是用System.arraycopy实现的。

1. ArrayList添加元素、三种遍历方法

最快的是第三种遍历方法，即通过索引遍历

public void printArrayList(){
List<Float> arrayList = new ArrayList<>();

//添加元素
arrayList.add((float)1.0);
arrayList.add((float)2.0);

List<Float> arrayList = new ArrayList<>();
arrayList.add((float)1.0);
arrayList.add((float)2.0);

//遍历方法1
System.out.println("\n遍历方法1");
Iterator iterator = arrayList.iterator();
for(;iterator.hasNext();){
System.out.print(iterator.next() + ", ");
}

//遍历方法2
System.out.println("\n遍历方法2");
for(Float data:arrayList){
System.out.print(data + ", ");
}

//遍历方法3（随机访问法，使用索引，这种最快）
System.out.println("\n遍历方法3");
for(int i = 0; i < arrayList.size(); i++){
System.out.print(arrayList.get(i) + ", ");
}
}

2. ArrayList源码的成员变量

（1） ArrayList，为数组队列，容量可动态增长。
（2） ArrayList 继承了AbstractList抽象类，实现了List接口。提供了相关的添加、删除、修改、遍历等功能。
（3） ArrayList 实现了RandmoAccess接口，即随机访问功能。RandmoAccess是java中用来被List实现，为List提供快速访问功能的（快速随机访问：指在ArrayList中，可以通过元素的序号快速获取元素对象）。
（4） ArrayList 实现了Cloneable接口，即覆盖了函数clone()，能被克隆，且为深层复制。
（5） ArrayList 实现java.io.Serializable接口，这意味着ArrayList支持序列化，能通过序列化去传输。
（6） ArrayList为非线程安全！！建议在单线程中才使用ArrayList，在多线程中可选择Vector 或 copyOnWriteArrayList。
（7）elementData，“Object[]类型的数组”，如果用构造函数ArrayList()来创建ArrayList，则容量默认是10。elementData数组的大小会根据ArrayList容量的增长而动态的增长，具体的增长方式参考源码中的ensureCapacity()函数。

public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
// 序列版本号
private static final long serialVersionUID = 8683452581122892189L;

//默认初始化容量为10
private static final int DEFAULT_CAPACITY = 10;

//空数组实例：用于生成空实例
private static final Object[] EMPTY_ELEMENTDATA = {};

//空数组实例：默认大小的空实例.
//与 EMPTY_ELEMENTDATA 区分开来，即添加第一个元素时要多少容量
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

//数组缓冲区：用于存储arraylist的元素。
//Arraylist的容量 等于 该数组缓冲区的长度。
//elementData是个动态数组，能通过构造函数 ArrayList(int initialCapacity)来执行它的初始容量为initialCapacity；
//如果通过不含参数的构造函数ArrayList()来创建ArrayList，则elementData的容量默认是DEFAULT_CAPACITY = 10;
transient Object[] elementData; // non-private to simplify nested class access

// ArrayList 实际包含的元素个数
private int size;
}

3. ArrayList源码的三种构造函数

//构造函数1。创建初始容量为initialCapacity的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);
}
}

//构造函数2。默认初始容量为10
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

//构造函数3. 创建一个包含collection的ArrayList
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;
}
}

4. ArrayList的所有源码及分析注释

(1) 当ArrayList容量不足以容纳全部元素时，ArrayList会重新设置容量：新的容量=“原始容量x3/2 + 1”。
(2) ArrayList的克隆函数：将全部元素克隆到一个新数组中。
(3) ArrayList实现java.io.Serializable的方式。当写入到输出流时，先写入“容量”，再依次写入“每一个元素”；当读出输入流时，先读取“容量”，再依次读取“每一个元素”。

package java.util;

public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
// 序列版本号
private static final long serialVersionUID = 8683452581122892189L;

//默认初始化容量为10
private static final int DEFAULT_CAPACITY = 10;

//空数组实例：用于生成空实例
private static final Object[] EMPTY_ELEMENTDATA = {};

//缺省空对象数组，与 EMPTY_ELEMENTDATA 区分开来，即添加第一个元素时要多少容量
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

//数组缓冲区：用于存储arraylist的元素。
//Arraylist的容量 等于 该数组缓冲区的长度。
//elementData是个动态数组，能通过构造函数 ArrayList(int initialCapacity)来执行它的初始容量为initialCapacity；
//如果通过不含参数的构造函数ArrayList()来创建ArrayList，则elementData的容量默认是DEFAULT_CAPACITY = 10;
transient Object[] elementData; // non-private to simplify nested class access

// ArrayList 实际包含的元素个数
private int size;

// 最大数组容量
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

// ArrayList带容量大小的构造函数。
public ArrayList(int initialCapacity) {
super();
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
// 新建一个数组
this.elementData = new Object[initialCapacity];
}

// ArrayList构造函数。说明：当未指定初始化大小时，会给elementData赋值为空集合。添加元素时再设置容量
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

// 创建一个包含collection的ArrayList
public ArrayList(Collection<? extends E> c) {
elementData = c.toArray();
size = elementData.length;
// c.toArray might (incorrectly) not return Object[] (see 6260652)
if (elementData.getClass() != Object[].class)
elementData = Arrays.copyOf(elementData, size, Object[].class);
}

// 设置 当前容量值 = 实际元素个数
public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}

// 确定ArrarList的容量。
// 若ArrayList的容量不足以容纳当前的全部元素，设置 新的容量=“(原始容量x3)/2 + 1”
public void ensureCapacity(int minCapacity) {
// 将“修改统计数”+1
modCount++;
int oldCapacity = elementData.length;
// 若当前容量不足以容纳当前的元素个数，设置 新的容量=“(原始容量x3)/2 + 1”
if (minCapacity > oldCapacity) {
Object oldData[] = elementData;
int newCapacity = (oldCapacity * 3)/2 + 1;
if (newCapacity < minCapacity)
newCapacity = minCapacity;
elementData = Arrays.copyOf(elementData, newCapacity);//
}
}

// 添加元素e
public boolean add(E e) {
// 确定ArrayList的容量大小
ensureCapacity(size + 1);  // Increments modCount!!
// 添加e到ArrayList中
elementData[size++] = e;
return true;
}

// 返回ArrayList的实际大小
public int size() {
return size;
}

// 返回ArrayList是否包含Object(o)
public boolean contains(Object o) {
return indexOf(o) >= 0;
}

// 返回ArrayList是否为空
public boolean isEmpty() {
return size == 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;
}

// 反向查找(从数组末尾向开始查找)，返回元素(o)的索引值
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;
}

// 返回ArrayList的Object数组
public Object[] toArray() {
return Arrays.copyOf(elementData, size);
}

// 返回ArrayList的模板数组。所谓模板数组，即可以将T设为任意的数据类型
public <T> T[] toArray(T[] a) {
// 若数组a的大小 < ArrayList的元素个数；
// 则新建一个T[]数组，数组大小是“ArrayList的元素个数”，并将“ArrayList”全部拷贝到新数组中
if (a.length < size)
return (T[]) Arrays.copyOf(elementData, size, a.getClass());

// 若数组a的大小 >= ArrayList的元素个数；
// 则将ArrayList的全部元素都拷贝到数组a中。
System.arraycopy(elementData, 0, a, 0, size);
if (a.length > size)
a[size] = null;
return a;
}

// 获取index位置的元素值
public E get(int index) {
RangeCheck(index);

return (E) elementData[index];
}

// 设置index位置的值为element
public E set(int index, E element) {
RangeCheck(index);

E oldValue = (E) elementData[index];
elementData[index] = element;
return oldValue;
}

// 将e添加到ArrayList中
public boolean add(E e) {
ensureCapacity(size + 1);  // Increments modCount!!
elementData[size++] = e;
return true;
}

// 将e添加到ArrayList的指定位置
public void add(int index, E element) {
if (index > size || index < 0)
throw new IndexOutOfBoundsException(
"Index: "+index+", Size: "+size);

ensureCapacity(size+1);  // Increments modCount!!
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
elementData[index] = element;
size++;
}

// 删除ArrayList指定位置的元素
public E remove(int index) {
RangeCheck(index);

modCount++;
E oldValue = (E) elementData[index];

int numMoved = size - index - 1;
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
elementData[--size] = null; // Let gc do its work

return oldValue;
}

// 删除ArrayList的指定元素
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;
}

// 快速删除第index个元素
private void fastRemove(int index) {
modCount++;
int numMoved = size - index - 1;
// 从"index+1"开始，用后面的元素替换前面的元素。
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
// 将最后一个元素设为null
elementData[--size] = null; // Let gc do its work
}

// 删除元素
public boolean remove(Object o) {
if (o == null) {
for (int index = 0; index < size; index++)
if (elementData[index] == null) {
fastRemove(index);
return true;
}
} else {
// 便利ArrayList，找到“元素o”，则删除，并返回true。
for (int index = 0; index < size; index++)
if (o.equals(elementData[index])) {
fastRemove(index);
return true;
}
}
return false;
}

// 清空ArrayList，将全部的元素设为null
public void clear() {
modCount++;

for (int i = 0; i < size; i++)
elementData[i] = null;

size = 0;
}

// 将集合c追加到ArrayList中
public boolean addAll(Collection<? extends E> c) {
Object[] a = c.toArray();
int numNew = a.length;
ensureCapacity(size + numNew);  // Increments modCount
System.arraycopy(a, 0, elementData, size, numNew);
size += numNew;
return numNew != 0;
}

// 从index位置开始，将集合c添加到ArrayList
public boolean addAll(int index, Collection<? extends E> c) {
if (index > size || index < 0)
throw new IndexOutOfBoundsException(
"Index: " + index + ", Size: " + size);

Object[] a = c.toArray();
int numNew = a.length;
ensureCapacity(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;
}

// 删除fromIndex到toIndex之间的全部元素。
protected void removeRange(int fromIndex, int toIndex) {
modCount++;
int numMoved = size - toIndex;
System.arraycopy(elementData, toIndex, elementData, fromIndex,
numMoved);

// Let gc do its work
int newSize = size - (toIndex-fromIndex);
while (size != newSize)
elementData[--size] = null;
}

private void RangeCheck(int index) {
if (index >= size)
throw new IndexOutOfBoundsException(
"Index: "+index+", Size: "+size);
}

// 克隆函数
public Object clone() {
try {
ArrayList
4000
<E> v = (ArrayList<E>) super.clone();
// 将当前ArrayList的全部元素拷贝到v中
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();
}
}

// java.io.Serializable的写入函数
// 将ArrayList的“容量，所有的元素值”都写入到输出流中
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException{
// Write out element count, and any hidden stuff
int expectedModCount = modCount;
s.defaultWriteObject();

// 写入“数组的容量”
s.writeInt(elementData.length);

// 写入“数组的每一个元素”
for (int i=0; i<size; i++)
s.writeObject(elementData[i]);

if (modCount != expectedModCount) {
throw new ConcurrentModificationException();
}

}

// java.io.Serializable的读取函数：根据写入方式读出
// 先将ArrayList的“容量”读出，然后将“所有的元素值”读出
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in size, and any hidden stuff
s.defaultReadObject();

// 从输入流中读取ArrayList的“容量”
int arrayLength = s.readInt();
Object[] a = elementData = new Object[arrayLength];

// 从输入流中将“所有的元素值”读出
for (int i=0; i<size; i++)
a[i] = s.readObject();
}
}

5.补充知识：Arrays.copyOf的源码，是用System.arraycopy实现的。

//copyOf() 把original数组copy到一个新数组中，并返回新数组，newLength是新数组的长度
public static int[] copyOf(int[] original, int newLength) {
int[] copy = new int[newLength];

//其中，Math.min(original.length, newLength)表示copy的长度
System.arraycopy(original, 0, copy, 0, Math.min(original.length, newLength));

return copy;
}