文章目录
1. 简介
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable {}
ArrayList 底层是通过一个动态数组来实现的。
它实现了 List 接口,提供了基础的添加、删除、遍历等操作;实现了 RandomAccess 接口,标识该类具有随机访问的能力;实现了 Cloneable, java.io.Serializable 接口,表示该类可以被克隆和序列化。
此外,它还继承了 AbstractList 抽象类,该抽象类实现了 List 接口中大多数的方法,帮助其子类最大程度地减少了实现 List 接口所需的工作。
ArrayList 不是同步的;它允许存储包括 null 在内的所有对象元素;除了实现 List 接口的所有方法外,它还另外提供一些方法用来操作其内部的数组大小。
因为它支持随机访问,即通过索引访问元素,查询的时间复杂度为 O(1);它支持添加元素到尾部以及从尾部删除元素,平均时间复杂度也是 O(1),但它添加元素到中间以及删除中间元素会比较慢,因为要搬移元素,平均时间复杂度为 O(n);
支持求并集,调用 addAll(Collection<? extends E> c) 方法即可;支持求交集,调用 retainAll(Collection<? extends E> c) 方法即可;支持求单向差集,调用 removeAll(Collection<? extends E> c) 方法即可。
ArrayList 的扩容机制:ArrayList 内部使用了一个 Object 类型的并且被 transient 修饰的数组 elementData 来存储元素,当数组长度不够时会调用 grow() 方法进行扩容,每次扩容都会增加一半的空间,并且它不会进行缩容;每个 ArrayList 实例都有一个容量,该容量是指用来存储列表元素的数组的大小,默认初始容量为 10,随着 ArrayList 中元素的增加,它的容量也会不断地自动增长;在每次添加新的元素时,ArrayList 都会检查是否需要进行扩容操作,如果需要,那么在扩容操作时需要将数据拷贝到新的数组,所以如果我们知道具体业务的数据量的话,那么当我们在构造 ArrayList 时可以给 ArrayList 指定一个初始容量,这样就可以减少扩容次数。
其实每次扩容并不是一定就是 1.5 倍增长,grow() 方法:首先让新容量等于旧容量的 1.5 倍,然后判断新容量是否大于实际需求的容量,若小于则以实际容量为准,另外,如果新容量的值大于最大容量 MAX_ARRAY_SIZ,则以最大容量为准
elementData 设置成了 transient,那 ArrayList 是怎么把元素序列化的呢 ?首先,transient 用来表示一个域不是该对象序行化的一部分,当一个对象被序行化的时候,transient 修饰的变量不会被序列化;默认的序列化,也就是只实现 Serializable 接口的情况下,如果 elementData 不被 transient 修饰,那么 ArrayList 序列化的时候会将整个 elementData 进行序列化,因为 ArrayList 的扩容机制,elementData 数组会保留有一部分空间,这一部分空间是没有存储元素的,所以默认序列化的话,会导致这一部分空元素也一起被序列化,占用了一些没必要的空间,多少会影响性能;解决方案就是用 transient 修饰 elementData,并重写 writeObject() 和 readObject() 来实现自定义序列化,这两个方法必须声明为 private,writeObject() 会直接将 size 和 element 写入到 ObjectOutputStream 中;反序列化时调用 readObject(),然后从 ObjectInputStream 中获取 size 和 element,并恢复到 elementData,这样子,就可以根据 size 来序列化真实的元素,而不是根据数组的长度序列化元素,减少了空间占用。
Array 和 ArrayList 有何区别 ?什么时候更适合用 Array ?Array 可以容纳基本类型和对象,而 ArrayList 只能容纳对象;Array 是固定大小的,而 ArrayList 不是;适合使用 Array 的场景:如果列表的大小已经指定,大部分情况下是存储和遍历它们;用于遍历基本数据类型;使用多维数组。
ArrayList 扩容时为什么是 1.5 倍 ?因为 1.5 倍的扩容可以说是最好的倍数。一次性扩容太大 (例如 2.5 倍) 可能会浪费更多的内存 ( 1.5 倍最多浪费 33%,而 2.5 倍最多会浪费 60%,3.5倍则会浪费 71%……)。但是一次性扩容太小,就可能需要多次对数组重新分配内存,对性能消耗比较严重。所以 1.5 倍刚刚好,既能满足性能需求,也不会造成很大的内存消耗
2. 常用方法
- boolean add(Element e):增加指定元素到列表尾部
- void add(int index, Element e):增加指定元素到列表指定位置
- boolean addAll(Collection<? extends E> c):将指定collection中的所有元素插入到ArrayList中
- boolean addAll(int index, Collection<? extends E> c):从指定的位置开始,将指定collection 中的所有元素插入到ArrayList中
- void clear():从列表中删除所有元素
- E remove(int index):删除列表中指定位置的元素
- boolean removeIf(Predicate<? super E> filter):根据重写Predicate类的test方法选择删除集合中的元素
- boolean removeAll(Collection<?> c):移除ArrayList中Collection所包含的所有元素
- boolean remove(Object o):移除ArrayList中首次出现的指定元素(如果存在则移除并返回true,否则返回false)
- E get(int index):获取列表中指定位置处的元素
- Object[] toArray():获取一个数组,数组中所有元素是列表中的元素.(即将列表转换为一个数组)
- T[] toArray(T[] a):构造一个数组
- List subList(int fromIndex, int toIndex):获取从 fromIndex 到 toIndex - 1 位置的元素
- E set(int index, E element):将列表中指定位置上的元素替换成新元素
- boolean contains(Object o):如果列表包含指定元素,返回true
- int indexOf(Object o):返回元素在列表中第一次出现的位置,如果返回-1,表示列表中没有这个元素
- int lastIndexOf(Object o):返回元素在列表中最后一次出现的位置,如果返回-1,表示列表中没有这个元素
- boolean isEmpty():返回true表示列表中没有任何元素. 判断逻辑是size == 0
- int size():返回列表长度(列表包含元素的个数)
3. 源码分析 (JDK 1.8)
1. 继承体系
2. 属性
//序列化ID
private static final long serialVersionUID = 8683452581122892189L;
/**
* 默认容,即通过 new ArrayList() 创建时的默认容量
*/
private static final int DEFAULT_CAPACITY = 10;
/**
* 空数组,如果传入的容量为 0 时使,即通过 new ArrayList(0) 创建时用的是这个空数组
*/
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
* 空数组,传传入容量时使用,通过new ArrayList()创建时用的是这个空数组,
* 与EMPTY_ELEMENTDATA的区别是在添加第一个元素时使用这个空数组的会初始化为DEFAULT_CAPACITY(10)个元素
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
/**
* 存储元素的数组
* 至于没有使用private修饰,后面注释是写的“为了简化嵌套类的访问”,
* 但是实测加了private嵌套类一样可以访问
*/
transient Object[] elementData; // non-private to simplify nested class access
/**
* 集合中元素的个数,即真正存储元素的个数,而不是elementData数组的长度
*/
private int size;
/**
* 最大容量,Integer.MAX_VALUE = 0x7fffffff,即 2^31
*/
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
3. 构造器
- ArrayList(int initialCapacity)
public ArrayList(int initialCapacity) { if (initialCapacity > 0) { // 如果传入的初始容量大于0,就新建一个数组存储元素 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()
public ArrayList() { // 如果没有传入初始容量,则使用空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA // 使用这个数组是在添加第一个元素的时候会扩容到默认大小10 this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA; }
- ArrayList(Collection<? extends E> c)
为什么c.toArray();返回的有可能不是Object[]类型呢?请看下面的代码:/** * 把传入集合的元素初始化到ArrayList中 */ public ArrayList(Collection<? extends E> c) { // 集合转数组 elementData = c.toArray(); if ((size = elementData.length) != 0) { // 检查c.toArray()返回的是不是Object[]类型,如果不是,重新拷贝成Object[].class类型 if (elementData.getClass() != Object[].class) elementData = Arrays.copyOf(elementData, size, Object[].class); } else { // 如果c的空集合,则初始化为空数组EMPTY_ELEMENTDATA this.elementData = EMPTY_ELEMENTDATA; } }
public class ArrayTest { public static void main(String[] args) { Father[] fathers = new Son[]{}; // 打印结果为class [Lcom.coolcoding.code.Son; System.out.println(fathers.getClass()); List<String> strList = new MyList(); // 打印结果为class [Ljava.lang.String; System.out.println(strList.toArray().getClass()); } } class Father {} class Son extends Father {} class MyList extends ArrayList<String> { /** * 子类重写父类的方法,返回值可以不一样 * 但这里只能用数组类型,换成Object就不行 * 应该算是java本身的bug */ @Override public String[] toArray() { // 为了方便举例直接写死 return new String[]{"1", "2", "3"}; } }
4. 其他方法
1. 添加元素
- add(E e):添加元素到末尾,平均时间复杂度为O(1)
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++; //修改次数 +1,用于 Fail-Fast 机制 if (minCapacity - elementData.length > 0) // 扩容 grow(minCapacity); }
private void grow(int minCapacity) { 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); }
- add(int index, E element):添加元素到指定位置,平均时间复杂度为O(n)
public void add(int index, E element) { // 检查是否越界 rangeCheckForAdd(index); // 检查是否需要扩容 ensureCapacityInternal(size + 1); // 将inex及其之后的元素往后挪一位,则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):将集合 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; }
2. 获取元素
- 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]; }
3. 删除元素
- remove(int index):删除指定索引位置的元素,时间复杂度为O(n)
public E remove(int index) { // 检查是否越界 rangeCheck(index); modCount++; //修改次数 +1,用于 Fail-Fast 机制 // 获取index位置的元素 E oldValue = elementData(index); // 如果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 // 返回旧值 return oldValue; }
- remove(Object o):删除第一个指定元素值的元素,时间复杂度为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++) // 如果要删除的元素不为null,则进行比较,使用equals()方法 if (o.equals(elementData[index])) { fastRemove(index); return true; } } return false; }
该方法的大概步骤就是:找到第一个等于指定元素值的元素,如果指定元素值为 null 则用 == 比较,否则用 equals() 比较;需要注意的是,这里的删除方法使用了快速删除,快速删除与前面的删除方法的区别在于:快速删除省略了越界检查的步骤。private void fastRemove(int index) { // 少了一个越界的检查 modCount++; //修改次数 +1,用于 Fail-Fast 机制 // 如果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 }
- removeAll(Collection<?> c):求两个集合的单方向差集,只保留当前集合中不在 c 中的元素,不保留在 c 中不在当前集体中的元素
public boolean removeAll(Collection<?> c) { // 集合c不能为空 Objects.requireNonNull(c); // 同样调用批量删除方法,这时complement传入false,表示删除包含在c中的元素 return batchRemove(c, false); }
求单向差集的方法其底层其实就是对在 c 中的元素进行了批量删除操作:首先遍历 elementData 数组;如果元素不在 c 中,则把这个元素添加到 elementData 数组的 w 位置并将 w 位置往后移一位;遍历完之后,w 之前的元素都是 c 中没有的,w 之后(包含)的元素是两者共有的;将 w 之后(包含)的元素置为 null,方便 GC 回收。/** * 批量删除元素 * 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为准) // 如果是求交集的方法,这里是:如果c中包含该元素,则把该元素放到写指针的位置 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; }
4. 求交集
- retainAll(Collection<?> c):求两个集合的交集
求交集的方法其底层其实就是对不在 c 中的元素进行了批量删除操作:首先遍历 elementData 数组;如果元素在 c 中,则把这个元素添加到 elementData 数组的 w 位置并将 w 位置往后移一位;遍历完之后,w 之前的元素都是两者共有的,w 之后(包含)的元素不是两者共有的;将 w 之后(包含)的元素置为 null,方便 GC 回收。public boolean retainAll(Collection<?> c) { // 集合c不能为null Objects.requireNonNull(c); // 调用批量删除方法,这时complement传入true,表示删除不包含在c中的元素 return batchRemove(c, true); }
5. ArrayList 中的自定义序列化
- writeObject(java.io.ObjectOutputStream s):
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException{ // 防止序列化期间有修改 int expectedModCount = modCount; // 写出非transient非static属性(会写出size属性) s.defaultWriteObject(); // 写出元素个数 s.writeInt(size); // 依次写出元素 for (int i=0; i<size; i++) { s.writeObject(elementData[i]); } // 如果有修改,抛出异常 if (modCount != expectedModCount) { throw new ConcurrentModificationException(); } }
- readObject(java.io.ObjectInputStream s):
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException { // 声明为空数组 elementData = EMPTY_ELEMENTDATA; // 读入非transient非static属性(会读取size属性) 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 定义为 transien t的优势,自己根据 size 序列化真实的元素,而不是根据数组的长度序列化元素,减少了空间占用。
4. Fail-Fast 机制
Fail - Fast 机制,即快速失败机制,是 java 集合(Collection)中的一种错误检测机制。当在迭代集合的过程中该集合在结构上发生改变的时候,就有可能会发生 fail-fast,即抛出 ConcurrentModificationException 异常。fail-fast 机制并不保证在不同步的修改下一定会抛出异常,它只是尽最大努力去抛出,所以这种机制一般仅用于检测 bug
常见的 java 集合中就可能出现 fail-fast 机制,比如 ArrayList,HashMap。在多线程和单线程环境下都有可能出现快速失败
因为 ArrayList 不是线程安全的,所以当在迭代 ArrayList 的过程中该集合在结构上发生改变的时候,就会抛出 ConcurrentModificationException,这就是所谓 fail-fast 策略
这一策略在源码中的实现是通过 modCount 域,modCount 顾名思义就是修改次数,对 ArrayList 内容的修改都将增加这个值,在迭代器初始化过程中会将这个值赋给迭代器的 expectedModCount。在迭代过程中,判断 modCount 跟 expectedModCount 是否相等,如果不相等就表示已经有其他线程修改了 ArrayList
fail-fast 与 fail-safe 有什么区别 ?java.util.concurrent 中的集合类都为 fail-safe 的。当检测到正在遍历的集合的结构被改变时,fail-fast 迭代器抛出 ConcurrentModificationException,而 fail-safe 迭代器从不抛出 ConcurrentModificationException