JDK源码解析---ArrayList

1.概述

ArrayList是基于动态数组实现的,随机存取快,但是在增删时候,需要数组的拷贝复制,这个时候明显劣势。
支持自动扩容的动态数组,同时也支持指定扩容以及缩容。
不是线程安全的。
可以存放null值。
调用无参的构造函数的时候是延迟初始化的
我的理解就是 其他ArrayList就是一个大小可变的高级数组

2.类图

在这里插入图片描述
实现了4个接口

  • java.util.List 接口,提供数组的添加、删除、修改、迭代遍历等操作。
  • java.util.RandomAccess 接口,表示 ArrayList 支持快速的随机访问。
  • java.io.Serializable 接口,表示 ArrayList 支持序列化的功能。
    java.lang.Cloneable 接口,表示 ArrayList 支持克隆。

3.属性

 private static final long serialVersionUID = 8683452581122892189L;//序列化版本ID属性:用于ArrayList的序列化以及反序列化
 private static final int DEFAULT_CAPACITY = 10;//默认的容量大小属性:ArrayList的容量默认是10,此容量并不是实际的list大小。
 private static final Object[] EMPTY_ELEMENTDATA = {};//空数组实例属性:用于空实例的共享空数组。final修饰的。所以创建多个空的ArrayList 其实内部数组引用的是同一个数组
 private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};//默认大小的空数组实例属性:用于默认大小的空实例的共享空数组实例。构建多个默认大小的空ArrayList,其实内部数组引用的是同一个数组
 transient Object[] elementData;//elementData属性:元素数组。transient修饰说明只实现了序列化接口的话,是不会被序列化的。但是如果提供了writeObject方法,这一部分的序列化就取决于这个方法是否对其序列化。
 private int size;//size属性:数组的大小,size才是ArrayList的中元素的数量。因为数组下标是从0开始,所以该属性刚好指向数组的末尾,方便添加操作。
 private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;//MAX_ARRAY_SIZE属性:最大数组大小Integer.MAX_VALUE - 8;

4.构造方法

ArrayList一共有三个构造方法。

  • ArrayList(int initialCapacity)
    根据传入的参数初始化ArrayList数组的容量,若预先知道数组的大小,使用该构造方法,可以避免频繁的数组扩容导致效率下降,同时可以合理的使用内存。因为扩容的时候是要进行数组拷贝的
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            //若初始化容量为0,则使用空数组对象。这里就可以看出 若是空的ArrayList,内部的数组是引用的同一个。
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }
  • ArrayList(Collection<? extends E> c)
    集合c作为构造方法的参数。首先将传入的集合c转成数组。如果大小不等于0,则判断数组的类型是否是Object[],若不是则调用Arrays的copyOf方法,修改其类型为Object[]。若数组大小等于0则将属性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;
        }
    }
  • ArrayList()
    无参构造方法。将elementData设置为DEFAULTCAPACITY_EMPTY_ELEMENTDATA这个空数组。一开始初始化的时候ArrayList容量并不是10,而是因为声明了DEFAULTCAPACITY_EMPTY_ELEMENTDATA空数组,首次添加的时候将数组扩容为10.而若是EMPTY_ELEMENTDATA声明的空数组,按照1.5倍扩容从0开始而不是从10开始。这是两个属性的差别。
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

5.缩容方法

  • trimToSize()
    调用trimToSize函数,若当前数组实际大小小于数组的容量时候,判断当前数组大小是否为0,若为0,则将elementData设为空数组,若不为0,则将数组容量缩小到数组实际的大小。缩容也要进行数组的拷贝
    public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

6.扩容方法

  • ensureCapacity(int minCapacity)
    参数是最小容量miniCapacity。首先判断elementData参数是否等于DEFAULTCAPACITY_EMPTY_ELEMENTDATA,若不等于,那么最小扩展从0开始,若等于,则最小扩展从10开始。
    若传入的参数miniCapacity大于最小扩展属性值,则调用ensureExplicitCapacity(minCapacity)扩展。
    public void ensureCapacity(int minCapacity) {//注意这个是提供给外部调用的扩容方法
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            // any size if not default element table
            ? 0
            // larger than default for default empty table. It's already
            // supposed to be at default size.
            : DEFAULT_CAPACITY;

        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }
  • ensureCapacityInternal(int minCapacity)

    若当前的内部数组是DEFAULTCAPACITY_EMPTY_ELEMENTDATA

    那么就要比较传入的参数和默认容量哪个大。返回大的那个作为扩容容量。

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

    ensureExplicitCapacity(minCapacity);
}
  • ensureExplicitCapacity(int minCapacity)
    若最小容量参数大于当前数组容量,则调用grow扩容。
	    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
  • grow(int minCapacity)
    参数是最小容量minCapacity
    首先将原始容量扩大到原来的1.5倍保存在变量newCapacity中。比较扩大后的容量与参数minCapacity的大小。若minCapacity大,则newCapacity等于minCapacity。再判断newCapacity与规定的最大数组容量MAX_ARRAY_SIZE大小。若newCapacity大,则调用hugeCapacity函数,增大容量。之后调用Arrays.copyOf更新数组的容量大小。
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;//获得旧容量
        int newCapacity = oldCapacity + (oldCapacity >> 1);//扩大1.5倍
        if (newCapacity - minCapacity < 0)//和传入的参数对比,若参数小
            newCapacity = minCapacity;//则按照1.5倍扩容
        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;
    }

7.获取大小

  • size()
    返回属性size
    public int size() {
        return size;
    }

8.判断是否为空

  • isEmpty()
    返回 size与0的比较结果
    public boolean isEmpty() {
        return size == 0;
    }

9.判断是否含有某对象

  • contains(Object o)
    从前往后找。调用indexOf函数,参数是对象O,遍历数组属性elemenData,若找到符合的对象则返回其索引。否则返回-1
    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;
    }
  • lastIndexOf(Object o)
    从后往前找。调用lastIndexOf函数。
    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;
    }

10.克隆

  • clone()
    克隆ArrayList对象。调用父类进行克隆,拷贝一个新的数组,设置数组的修改次数为0。
public Object clone() {
        try {
            ArrayList<?> v = (ArrayList<?>) super.clone();
            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(e);
        }
    }

11.ArrayList转数组

  • toArray()
    返回类型是Object[]
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }
  • toArray(T[] a)
    返回类型是泛型数组。即给定参数是什么类型则返回什么类型的数组。如果ArrayList里面元素的数量大于准备转换的数组的大小则要拷贝数组,得到一个更大的新的数组来存放ArrayList里面的元素。否则直接ArrayList里面的元素拷贝到a数组中。最后若有a数组有剩余的空间,则将剩余的位置设置成null。返回数组a
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            // Make a new array of a's runtime type, but my contents:
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

12.返回指定索引的元素

  • elementData(int index)
    直接返回elementData[index];不检查索引是否越界
    E elementData(int index) {
        return (E) elementData[index];
    }

  • get(int index)
    检查索引是否越界
    public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }

13.修改指定索引位置的元素

  • set(int index, E element)
    首先检查是否越界,设置参数oldValue,获得原来该索引位置的元素。修改该索引位置的元素。返回原来的元素。
    public E set(int index, E element) {
        rangeCheck(index);

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

14.添加元素

  • add(E e)
    检查容量是否充足函数ensureCapacityInternal(int minCapacity),修改次数增加,若容量不足扩容等操作。在将元素赋值在elementData数组之后。实际大小加一
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }
  • add(int index, E element)
    指定位置添加元素。
    首先检查是否越界。同上调用函数ensureCapacityInternal(int minCapacity)。接着将原始的数组,从索引位置index之后的元素后移动。然后在index的位置添加元素。实际大小加一。这里就可以看出ArrayList不适合添加元素。有一大部分的元素需要移动,拷贝数组实现。
    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++;
    }

15.删除元素

  • remove(int index)
    检查是否越界
    修改次数加一,获得索引位置的元素。计算需要移动元素的个数numMoved。若numMoved大于0则调用函数System.arraycopy,将index+1之后的元素向前挪一个位置。返回删除的元素。删除同样不适合ArrayList,有一部分元素需要移动,拷贝数组实现。
    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;
    }
  • remove(Object o)
    找到对象O调用快速移除函数fastRemove(int index),返回true,若没找到返回false
    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;
    }
  • fastRemove(int index)
    相比于remove(int index),不需要检查是否越界,以及不用返回被删除的元素。
    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
    }
  • clear()
    清空数组。遍历全部设置为null
    public void clear() {
        modCount++;

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

        size = 0;
    }

16.添加所有

  • addAll(Collection<? extends E> c)
    将集合c全部添加到属性elementData后面。
    首先将集合转成数组a,计算其长度。调用ensureCapacityInternal函数,判断是否要扩容。
    调用System.arraycopy,将数组a,添加到属性elementData后面。属性size加numMoved。
    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;
    }
  • addAll(int index, Collection<? extends E> c)
    将集合c添加到指定索引位置之后
    首先判断是否越界,将集合c转为数组a,计算其长度。判断是否需要扩容。计算需要移动的元素数量numMoved。若numMoved大于0,则调用System.arraycopy,将数组a添加到index位置之后。属性size加numMoved。
    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;
    }

17.删除范围内的元素

  • removeRange(int fromIndex, int toIndex)
    计算需要移动的元素个数,
    调用System.arraycopy,拷贝元素。
    计算新的实际数组大小newSize,将newSize之后的元素设置为null。size属性设置为newSize。
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }

18.越界检查

  • rangeCheck(int index)
    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
  • rangeCheckForAdd(int index)
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
  • outOfBoundsMsg(int index)
    越界信息
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

19.删除批量元素

  • removeAll(Collection<?> c)
    集合为空则抛出异常,否则调用batchRemove(Collection<?> c, boolean complement)
    public boolean removeAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, false);
    }
  • batchRemove(Collection<?> c, boolean complement)
    批量移除指定的多个元素。当complement等于false时,是删除包含集合c的元素,当complement等于true时,则是保留包含集合c的元素,其他的删除。遍历数组elementData,判断是否在集合c中存在。重点在于这句
if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
    private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;
        boolean modified = false;
        try {
            for (; r < size; r++)
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // Preserve behavioral compatibility with AbstractCollection,
            // even if c.contains() throws.
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
                // clear to let GC do its work
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }

20.序列化

  • writeObject(java.io.ObjectOutputStream s)
    设置参数当前的总共修改次数expectedModCount,调用java.io.ObjectOutputStream中的defaultWriteObject()方法,输出流中传入属性sizes.writeInt(size),以及每一个元素 s.writeObject(elementData[i])。
    最后判断当前的修改次数与之前的是否一致,若不一致说明被修改过抛出异常。
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException{
        // Write out element count, and any hidden stuff
        int expectedModCount = modCount;
        s.defaultWriteObject();

        // Write out size as capacity for behavioural compatibility with clone()
        s.writeInt(size);

        // Write out all elements in the proper order.
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

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

21.反序列化

  • readObject(java.io.ObjectInputStream s)
    准备一个空数组,调用s.defaultReadObject(),反序列化,读出size属性s.readInt()。
    若size大于0则计算容量,判断是否要扩容。调用s。readObject反序列化取出元素。
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        elementData = EMPTY_ELEMENTDATA;

        // Read in size, and any hidden stuff
        s.defaultReadObject();

        // Read in capacity
        s.readInt(); // ignored

        if (size > 0) {
            // be like clone(), allocate array based upon size not capacity
            int capacity = calculateCapacity(elementData, size);    
            SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);//此句不知道用途
            ensureCapacityInternal(size);

            Object[] a = elementData;
            // Read in all elements in the proper order.
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }

22.创建迭代器

  • listIterator(int index)
    检查是否越界,然后创建一个List迭代器,从指定位置开始的迭代器。。
    public ListIterator<E> listIterator(int index) {
        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index);
        return new ListItr(index);
    }
  • listIterator()
    创建一个覆盖所有元素的迭代器。
    public ListIterator<E> listIterator() {
        return new ListItr(0);
    }
  • iterator()创建一个普通的覆盖所有元素的迭代器。
    public Iterator<E> iterator() {
        return new Itr();
    }

内部类迭代器的实现方法有

  • hasNext()
  • next()
  • remove()
  • forEachRemaining(Consumer<? super E> consumer)
  • checkForComodification()
    内部类List迭代器继承了迭代器类,其中实现方法有
  • previous()
  • set(E e)
  • add(E e)
  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值