死磕 Java集合之ArrayList源码分析

原创
2020/03/20 11:49
阅读数 1.4K

🖕点击上方蓝字“彤哥读源码关注,与彤哥一起畅游源码的海洋。

简介

ArrayList是一种以数组实现的List,与数组相比,它具有动态扩展的能力,因此也可称之为动态数组。

继承体系

ArrayList实现了List, RandomAccess, Cloneable, java.io.Serializable等接口。

ArrayList实现了List,提供了基础的添加、删除、遍历等操作。

ArrayList实现了RandomAccess,提供了随机访问的能力。

ArrayList实现了Cloneable,可以被克隆。

ArrayList实现了Serializable,可以被序列化。

源码解析

属性

  
  
  
  1. /**

  2. * 默认容量

  3. */

  4. private static final int DEFAULT_CAPACITY = 10;

  5. /**

  6. * 空数组,如果传入的容量为0时使用

  7. */

  8. private static final Object[] EMPTY_ELEMENTDATA = {};

  9. /**

  10. * 空数组,传传入容量时使用,添加第一个元素的时候会重新初始为默认容量大小

  11. */

  12. private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

  13. /**

  14. * 存储元素的数组

  15. */

  16. transient Object[] elementData; // non-private to simplify nested class access

  17. /**

  18. * 集合中元素的个数

  19. */

  20. private int size;

(1)DEFAULT_CAPACITY

默认容量为10,也就是通过new ArrayList()创建时的默认容量。

(2)EMPTY_ELEMENTDATA

空的数组,这种是通过new ArrayList(0)创建时用的是这个空数组。

(3)DEFAULTCAPACITY_EMPTY_ELEMENTDATA

也是空数组,这种是通过new ArrayList()创建时用的是这个空数组,与EMPTY_ELEMENTDATA的区别是在添加第一个元素时使用这个空数组的会初始化为DEFAULT_CAPACITY(10)个元素。

(4)elementData

真正存放元素的地方,使用transient是为了不序列化这个字段。

至于没有使用private修饰,后面注释是写的“为了简化嵌套类的访问”,但是楼主实测加了private嵌套类一样可以访问。

private表示是类私有的属性,只要是在这个类内部都可以访问,嵌套类或者内部类也是在类的内部,所以也可以访问类的私有成员。

(5)size

真正存储元素的个数,而不是elementData数组的长度。

ArrayList(int initialCapacity)构造方法

传入初始容量,如果大于0就初始化elementData为对应大小,如果等于0就使用EMPTY_ELEMENTDATA空数组,如果小于0抛出异常。

  
  
  
  1. public ArrayList(int initialCapacity) {

  2. if (initialCapacity > 0) {

  3. // 如果传入的初始容量大于0,就新建一个数组存储元素

  4. this.elementData = new Object[initialCapacity];

  5. } else if (initialCapacity == 0) {

  6. // 如果传入的初始容量等于0,使用空数组EMPTY_ELEMENTDATA

  7. this.elementData = EMPTY_ELEMENTDATA;

  8. } else {

  9. // 如果传入的初始容量小于0,抛出异常

  10. throw new IllegalArgumentException("Illegal Capacity: " + initialCapacity);

  11. }

  12. }

ArrayList()构造方法

不传初始容量,初始化为DEFAULTCAPACITY_EMPTY_ELEMENTDATA空数组,会在添加第一个元素的时候扩容为默认的大小,即10。

  
  
  
  1. public ArrayList() {

  2. // 如果没有传入初始容量,则使用空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA

  3. // 使用这个数组是在添加第一个元素的时候会扩容到默认大小10

  4. this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;

  5. }

ArrayList(Collection c)构造方法

传入集合并初始化elementData,这里会使用拷贝把传入集合的元素拷贝到elementData数组中,如果元素个数为0,则初始化为EMPTY_ELEMENTDATA空数组。

  
  
  
  1. /**

  2. * 把传入集合的元素初始化到ArrayList中

  3. */

  4. public ArrayList(Collection<? extends E> c) {

  5. // 集合转数组

  6. elementData = c.toArray();

  7. if ((size = elementData.length) != 0) {

  8. // 检查c.toArray()返回的是不是Object[]类型,如果不是,重新拷贝成Object[].class类型

  9. if (elementData.getClass() != Object[].class)

  10. elementData = Arrays.copyOf(elementData, size, Object[].class);

  11. } else {

  12. // 如果c的空集合,则初始化为空数组EMPTY_ELEMENTDATA

  13. this.elementData = EMPTY_ELEMENTDATA;

  14. }

  15. }

为什么 c.toArray();返回的有可能不是Object[]类型呢?请看下面的代码:

  
  
  
  1. public class ArrayTest {

  2. public static void main(String[] args) {

  3. Father[] fathers = new Son[]{};

  4. // 打印结果为class [Lcom.coolcoding.code.Son;

  5. System.out.println(fathers.getClass());

  6. List<String> strList = new MyList();

  7. // 打印结果为class [Ljava.lang.String;

  8. System.out.println(strList.toArray().getClass());

  9. }

  10. }

  11. class Father {}

  12. class Son extends Father {}

  13. class MyList extends ArrayList<String> {

  14. /**

  15. * 子类重写父类的方法,返回值可以不一样

  16. * 但这里只能用数组类型,换成Object就不行

  17. * 应该算是java本身的bug

  18. */

  19. @Override

  20. public String[] toArray() {

  21. // 为了方便举例直接写死

  22. return new String[]{"1", "2", "3"};

  23. }

  24. }

add(E e)方法

添加元素到末尾,平均时间复杂度为O(1)。

  
  
  
  1. public boolean add(E e) {

  2. // 检查是否需要扩容

  3. ensureCapacityInternal(size + 1);

  4. // 把元素插入到最后一位

  5. elementData[size++] = e;

  6. return true;

  7. }

  8. private void ensureCapacityInternal(int minCapacity) {

  9. ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));

  10. }

  11. private static int calculateCapacity(Object[] elementData, int minCapacity) {

  12. // 如果是空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA,就初始化为默认大小10

  13. if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {

  14. return Math.max(DEFAULT_CAPACITY, minCapacity);

  15. }

  16. return minCapacity;

  17. }

  18. private void ensureExplicitCapacity(int minCapacity) {

  19. modCount++;

  20. if (minCapacity - elementData.length > 0)

  21. // 扩容

  22. grow(minCapacity);

  23. }

  24. private void grow(int minCapacity) {

  25. int oldCapacity = elementData.length;

  26. // 新容量为旧容量的1.5倍

  27. int newCapacity = oldCapacity + (oldCapacity >> 1);

  28. // 如果新容量发现比需要的容量还小,则以需要的容量为准

  29. if (newCapacity - minCapacity < 0)

  30. newCapacity = minCapacity;

  31. // 如果新容量已经超过最大容量了,则使用最大容量

  32. if (newCapacity - MAX_ARRAY_SIZE > 0)

  33. newCapacity = hugeCapacity(minCapacity);

  34. // 以新容量拷贝出来一个新数组

  35. elementData = Arrays.copyOf(elementData, newCapacity);

  36. }

(1)检查是否需要扩容;

(2)如果elementData等于DEFAULTCAPACITY_EMPTY_ELEMENTDATA则初始化容量大小为DEFAULT_CAPACITY;

(3)新容量是老容量的1.5倍(oldCapacity + (oldCapacity >> 1)),如果加了这么多容量发现比需要的容量还小,则以需要的容量为准;

(4)创建新容量的数组并把老数组拷贝到新数组;

add(int index, E element)方法

添加元素到指定位置,平均时间复杂度为O(n)。

  
  
  
  1. public void add(int index, E element) {

  2. // 检查是否越界

  3. rangeCheckForAdd(index);

  4. // 检查是否需要扩容

  5. ensureCapacityInternal(size + 1);

  6. // 将inex及其之后的元素往后挪一位,则index位置处就空出来了

  7. System.arraycopy(elementData, index, elementData, index + 1,

  8. size - index);

  9. // 将元素插入到index的位置

  10. elementData[index] = element;

  11. // 大小增1

  12. size++;

  13. }

  14. private void rangeCheckForAdd(int index) {

  15. if (index > size || index < 0)

  16. throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

  17. }

(1)检查索引是否越界;

(2)检查是否需要扩容;

(3)把插入索引位置后的元素都往后挪一位;

(4)在插入索引位置放置插入的元素;

(5)大小加1;

addAll(Collection c)方法

求两个集合的并集。

  
  
  
  1. /**

  2. * 将集合c中所有元素添加到当前ArrayList中

  3. */

  4. public boolean addAll(Collection<? extends E> c) {

  5. // 将集合c转为数组

  6. Object[] a = c.toArray();

  7. int numNew = a.length;

  8. // 检查是否需要扩容

  9. ensureCapacityInternal(size + numNew);

  10. // 将c中元素全部拷贝到数组的最后

  11. System.arraycopy(a, 0, elementData, size, numNew);

  12. // 大小增加c的大小

  13. size += numNew;

  14. // 如果c不为空就返回true,否则返回false

  15. return numNew != 0;

  16. }

(1)拷贝c中的元素到数组a中;

(2)检查是否需要扩容;

(3)把数组a中的元素拷贝到elementData的尾部;

get(int index)方法

获取指定索引位置的元素,时间复杂度为O(1)。

  
  
  
  1. public E get(int index) {

  2. // 检查是否越界

  3. rangeCheck(index);

  4. // 返回数组index位置的元素

  5. return elementData(index);

  6. }

  7. private void rangeCheck(int index) {

  8. if (index >= size)

  9. throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

  10. }

  11. E elementData(int index) {

  12. return (E) elementData[index];

  13. }

(1)检查索引是否越界,这里只检查是否越上界,如果越上界抛出IndexOutOfBoundsException异常,如果越下界抛出的是ArrayIndexOutOfBoundsException异常。

(2)返回索引位置处的元素;

remove(int index)方法

删除指定索引位置的元素,时间复杂度为O(n)。

  
  
  
  1. public E remove(int index) {

  2. // 检查是否越界

  3. rangeCheck(index);

  4. modCount++;

  5. // 获取index位置的元素

  6. E oldValue = elementData(index);

  7. // 如果index不是最后一位,则将index之后的元素往前挪一位

  8. int numMoved = size - index - 1;

  9. if (numMoved > 0)

  10. System.arraycopy(elementData, index+1, elementData, index, numMoved);

  11. // 将最后一个元素删除,帮助GC

  12. elementData[--size] = null; // clear to let GC do its work

  13. // 返回旧值

  14. return oldValue;

  15. }

(1)检查索引是否越界;

(2)获取指定索引位置的元素;

(3)如果删除的不是最后一位,则其它元素往前移一位;

(4)将最后一位置为null,方便GC回收;

(5)返回删除的元素。

可以看到,ArrayList删除元素的时候并没有缩容。

remove(Object o)方法

删除指定元素值的元素,时间复杂度为O(n)。

  
  
  
  1. public boolean remove(Object o) {

  2. if (o == null) {

  3. // 遍历整个数组,找到元素第一次出现的位置,并将其快速删除

  4. for (int index = 0; index < size; index++)

  5. // 如果要删除的元素为null,则以null进行比较,使用==

  6. if (elementData[index] == null) {

  7. fastRemove(index);

  8. return true;

  9. }

  10. } else {

  11. // 遍历整个数组,找到元素第一次出现的位置,并将其快速删除

  12. for (int index = 0; index < size; index++)

  13. // 如果要删除的元素不为null,则进行比较,使用equals()方法

  14. if (o.equals(elementData[index])) {

  15. fastRemove(index);

  16. return true;

  17. }

  18. }

  19. return false;

  20. }

  21. private void fastRemove(int index) {

  22. // 少了一个越界的检查

  23. modCount++;

  24. // 如果index不是最后一位,则将index之后的元素往前挪一位

  25. int numMoved = size - index - 1;

  26. if (numMoved > 0)

  27. System.arraycopy(elementData, index+1, elementData, index, numMoved);

  28. // 将最后一个元素删除,帮助GC

  29. elementData[--size] = null; // clear to let GC do its work

  30. }

(1)找到第一个等于指定元素值的元素;

(2)快速删除;

fastRemove(int index)相对于remove(int index)少了检查索引越界的操作,可见jdk将性能优化到极致。

retainAll(Collection c)方法

求两个集合的交集。

  
  
  
  1. public boolean retainAll(Collection<?> c) {

  2. // 集合c不能为null

  3. Objects.requireNonNull(c);

  4. // 调用批量删除方法,这时complement传入true,表示删除不包含在c中的元素

  5. return batchRemove(c, true);

  6. }

  7. /**

  8. * 批量删除元素

  9. * complement为true表示删除c中不包含的元素

  10. * complement为false表示删除c中包含的元素

  11. */

  12. private boolean batchRemove(Collection<?> c, boolean complement) {

  13. final Object[] elementData = this.elementData;

  14. // 使用读写两个指针同时遍历数组

  15. // 读指针每次自增1,写指针放入元素的时候才加1

  16. // 这样不需要额外的空间,只需要在原有的数组上操作就可以了

  17. int r = 0, w = 0;

  18. boolean modified = false;

  19. try {

  20. // 遍历整个数组,如果c中包含该元素,则把该元素放到写指针的位置(以complement为准)

  21. for (; r < size; r++)

  22. if (c.contains(elementData[r]) == complement)

  23. elementData[w++] = elementData[r];

  24. } finally {

  25. // 正常来说r最后是等于size的,除非c.contains()抛出了异常

  26. if (r != size) {

  27. // 如果c.contains()抛出了异常,则把未读的元素都拷贝到写指针之后

  28. System.arraycopy(elementData, r,

  29. elementData, w, size - r);

  30. w += size - r;

  31. }

  32. if (w != size) {

  33. // 将写指针之后的元素置为空,帮助GC

  34. for (int i = w; i < size; i++)

  35. elementData[i] = null;

  36. modCount += size - w;

  37. // 新大小等于写指针的位置(因为每写一次写指针就加1,所以新大小正好等于写指针的位置)

  38. size = w;

  39. modified = true;

  40. }

  41. }

  42. // 有修改返回true

  43. return modified;

  44. }

(1)遍历elementData数组;

(2)如果元素在c中,则把这个元素添加到elementData数组的w位置并将w位置往后移一位;

(3)遍历完之后,w之前的元素都是两者共有的,w之后(包含)的元素不是两者共有的;

(4)将w之后(包含)的元素置为null,方便GC回收;

removeAll(Collection c)

求两个集合的单方向差集,只保留当前集合中不在c中的元素,不保留在c中不在当前集体中的元素。

  
  
  
  1. public boolean removeAll(Collection<?> c) {

  2. // 集合c不能为空

  3. Objects.requireNonNull(c);

  4. // 同样调用批量删除方法,这时complement传入false,表示删除包含在c中的元素

  5. return batchRemove(c, false);

  6. }

与retainAll(Collection c)方法类似,只是这里保留的是不在c中的元素。

总结

(1)ArrayList内部使用数组存储元素,当数组长度不够时进行扩容,每次加一半的空间,ArrayList不会进行缩容;

(2)ArrayList支持随机访问,通过索引访问元素极快,时间复杂度为O(1);

(3)ArrayList添加元素到尾部极快,平均时间复杂度为O(1);

(4)ArrayList添加元素到中间比较慢,因为要搬移元素,平均时间复杂度为O(n);

(5)ArrayList从尾部删除元素极快,时间复杂度为O(1);

(6)ArrayList从中间删除元素比较慢,因为要搬移元素,平均时间复杂度为O(n);

(7)ArrayList支持求并集,调用addAll(Collection c)方法即可;

(8)ArrayList支持求交集,调用retainAll(Collection c)方法即可;

(7)ArrayList支持求单向差集,调用removeAll(Collection c)方法即可;

彩蛋

elementData设置成了transient,那ArrayList是怎么把元素序列化的呢?

  
  
  
  1. private void writeObject(java.io.ObjectOutputStream s)

  2. throws java.io.IOException{

  3. // 防止序列化期间有修改

  4. int expectedModCount = modCount;

  5. // 写出非transient非static属性(会写出size属性)

  6. s.defaultWriteObject();

  7. // 写出元素个数

  8. s.writeInt(size);

  9. // 依次写出元素

  10. for (int i=0; i<size; i++) {

  11. s.writeObject(elementData[i]);

  12. }

  13. // 如果有修改,抛出异常

  14. if (modCount != expectedModCount) {

  15. throw new ConcurrentModificationException();

  16. }

  17. }

  18. private void readObject(java.io.ObjectInputStream s)

  19. throws java.io.IOException, ClassNotFoundException {

  20. // 声明为空数组

  21. elementData = EMPTY_ELEMENTDATA;

  22. // 读入非transient非static属性(会读取size属性)

  23. s.defaultReadObject();

  24. // 读入元素个数,没什么用,只是因为写出的时候写了size属性,读的时候也要按顺序来读

  25. s.readInt();

  26. if (size > 0) {

  27. // 计算容量

  28. int capacity = calculateCapacity(elementData, size);

  29. SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);

  30. // 检查是否需要扩容

  31. ensureCapacityInternal(size);

  32. Object[] a = elementData;

  33. // 依次读取元素到数组中

  34. for (int i=0; i<size; i++) {

  35. a[i] = s.readObject();

  36. }

  37. }

  38. }

查看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序列化真实的元素,而不是根据数组的长度序列化元素,减少了空间占用。



欢迎关注我的公众号“彤哥读源码”,与彤哥一起畅游源码的海洋。

本文分享自微信公众号 - 彤哥读源码(gh_63d1b83b9e01)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

展开阅读全文
打赏
0
1 收藏
分享
加载中
更多评论
打赏
0 评论
1 收藏
0
分享
返回顶部
顶部