ArrayList 源码分析(JDK1.8)

ArrayList简介

  ArrayList 是一个数组队列,相当于 动态数组。与Java中的数组相比,它的容量能动态增长。它继承于AbstractList,实现了List, RandomAccess, Cloneable, java.io.Serializable这些接口。

  ArrayList 继承了AbstractList,实现了List。它是一个数组队列,提供了相关的添加、删除、修改、遍历等功能。

  ArrayList 实现了RandmoAccess接口,即提供了随机访问功能。RandmoAccess是java中用来被List实现,为List提供快速访问功能的。在ArrayList中,我们即可以通过元素的序号快速获取元素对象;这就是快速随机访问。稍后,我们会比较List的“快速随机访问”和“通过Iterator迭代器访问”的效率。

  ArrayList 实现了Cloneable接口,即覆盖了函数clone(),能被克隆。

  ArrayList 实现java.io.Serializable接口,这意味着ArrayList支持序列化,能通过序列化去传输。

  和Vector不同,ArrayList中的操作不是线程安全的!所以,建议在单线程中才使用ArrayList,而在多线程中可以选择Vector或者CopyOnWriteArrayList。

下面让我们翻开ArrayList的源代码,看看一些常用的方法属性,以及一些需要注意的地方。

ArrayList属性

  ArrayList属性主要就是当前数组长度size,以及存放数组的对象elementData数组,除此之外还有一个经常用到的属性就是从AbstractList继承过来的modCount属性,代表ArrayList集合的修改次数。

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

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

    //用于空实例的共享空数组实例。
    private static final Object[] EMPTY_ELEMENTDATA = {};

   //一个空对象,如果使用默认构造函数创建,则默认对象内容默认是该值
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

	//// 当前数据对象存放地方,当前对象不参与序列化
    transient Object[] elementData; 

    // 当前数组长度
    private int size;

Arraylist构造方法详细信息

无参构造器:构造一个初始容量为 10 的空列表。

public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

注意:此时我们创建的ArrayList对象中的elementData中的长度是1,size是0,当进行第一次add的时候,elementData将会变成默认的长度:10。

有参构造器(int 类型的参数):构造一个具有指定初始容量的空列表。

如果传入参数,则代表指定ArrayList的初始数组长度,传入参数如果是大于等于0,则使用用户的参数初始化,如果用户传入的参数小于0,则抛出异常。源码如下:

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);
        }
    }
  • 参数:initialCapacity - 列表的初始容量
  • 如果指定的初始容量为负,则会抛出: IllegalArgumentException
    IllegalArgumentException:表明向方法传递了一个不合法或不正确的参数

有参构造器(Collection 类型的参数):构造一个包含指定 collection 的元素的列表,这些元素是按照该 collection 的迭代器返回它们的顺序排列的。

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

说明:
1、这里,我们将传入的 collection 对象首先转换成数组,并且把数组地址值赋值给 elementData。
2、然后,根据转换来的数组获取数组的长度并且赋值给 size 变量,同时判断 size 的大小,如果 size 的值等于0,直接将空对象 EMPTY_ELEMENTDATA 的地址赋给 elementData。
3、如果 size 的值大于0,则执行Arrays.copy() 方法,把 collection 对象转换来的内容(可以理解为深拷贝)copy 到elementData。

注意:this.elementData = arg0.toArray(); 这里执行的简单赋值时浅拷贝,所以要执行 Arrays.copy() 做深拷贝

常用方法详细信息

get方法:返回此列表中指定位置上的元素。

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

   return elementData(index);
}

private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

说明:
1、rangeCheck(index) 方法:用来判断传入的索引是否正确,如果索引超出范围 (index < 0 || index >= size()),该方法则会抛出 IndexOutOfBoundsException: 数组(下标)越界异常
2、如果传入的索引正确,则会返回指定索引位置的元素。

set方法:用指定的元素替代此列表中指定位置上的元素。

public E set(int index, E element) {
     rangeCheck(index);

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

说明:
1、rangeCheck(index) 方法:用来判断传入的索引是否正确,如果索引超出范围 (index < 0 || index >= size()),该方法则会抛出 IndexOutOfBoundsException: 数组(下标)越界异常
2、然后,通过索引获取旧的元素,并且根据索引对列表就行元素更新,最后,返回旧的元素。

add方法

add的方法有两个,一个是带一个参数的,一个是带两个参数的,下面我们一个个分析。

我们先来看带一个参数的:

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

确保添加的元素有地方存储,当第一次添加元素的时候this.size+1 的值是1,所以第一次添加的时候会将当前elementData数组的长度变为10:

private void ensureCapacityInternal(int minCapacity) {
    ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
//判断是否是第一次添加元素的,如果是,则会将elementData数组的长度变为10;
//如果不是,则返回 minCapacity 变量
private static int calculateCapacity(Object[] elementData, int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

将修改次数(modCount)自增1,判断是否需要扩充数组长度,判断条件就是用当前所需的数组最小长度与数组的长度对比,如果大于0,则增长数组长度。

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;

    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

如果当前的数组已使用空间(size)加1之后 大于数组长度,则增大数组容量,扩大为原来的1.5倍。

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

然后,我们看另外一个add方法:

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

//该方法主要判断传入的索引是否正确,这里和 get() 方法中调用的 rangeCheck(index) 方法 一样的作用,如果索引超出范围 (index < 0 || index >= size()),该方法则会抛出 IndexOutOfBoundsException: 数组(下标)越界异常。
private void rangeCheckForAdd(int index) {
    if (index > size || index < 0)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

其中 ensureCapacityInternal(size + 1) 方法,已经在上面介绍,这里就不作介绍了。
  经过上面的层层判断,确保有足够的容量之后,使用System.arraycopy 将需要插入的位置(index)后面的元素统统往后移动一位。并且将新的数据内容存放到数组的指定位置(index)上。

remove方法

其中 remove 方法有两个,一个是根据索引进行元素移除的,一个是根据元素对象进行移除的:
我们先看其中的一个:
根据索引进行元素移除:

public E remove(int index) {
//判断索引是否越界,越界则抛出数组越界异常。
    rangeCheck(index);

//自增长修改次数
    modCount++;
//将指定位置(index)上的元素保存到 oldValue。
    E oldValue = elementData(index);

//将指定位置(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

//将原来的值oldValue返回
    return oldValue;
}

注意:调用这个方法不会缩减数组的长度,只是将最后一个数组元素置空而已。

根据元素对象进行元素移除:

public boolean remove(Object o) {
//首先判断传入的对象是否为 null
    if (o == null) {
    //如果传入的对象为 null ,我们对 elementData 进行遍历,
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
            //循环遍历,找到了第一个为null 的对象,调用fastRemove(index)进行移除,其本质也是根据索引进行元素的移除。
                fastRemove(index);
                //返回 true 
                return true;
            }
    } else {
   // 如果传入的对象不为 null ,则遍历 elementData 数组 并且判断该对象是否与遍历的元素有相同的,如果有则调用 fastRemove(index) 进行移除,最后返回 true。
        for (int index = 0; index < size; index++)
        
            if (o.equals(elementData[index])) {
                fastRemove(index);
                
                return true;
            }
    }
    //如果经过上面的层层判断,没有要移除的元素,则返回 false。
    return false;
}

//定位到需要remove的元素索引,先将index后面的元素往前面移动一位(调用System.arraycooy实现),然后将最后一个元素置空。
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方法:清空列表

    public void clear() {
    //自增长修改次数
        modCount++;

        // clear to let GC do its work
        //遍历 elementData ,并且对每个位置上的元素赋上 null 值
        for (int i = 0; i < size; i++)
            elementData[i] = null;
	//然后,将 size 值赋值为 0.
        size = 0;
    }

ArrayList 自带的迭代器: listIterator
其迭代器有两种:一种是有参的,一种是无参的
带有参数的迭代器:可以根据指定的位置进行向前遍历,以及向后遍历。

public ListIterator<E> listIterator(int index) {
//首先判断传入的索引是否正确,如果索引超出范围 (index < 0 || index >= size()),该方法则会抛出 IndexOutOfBoundsException: 数组(下标)越界异常。
    if (index < 0 || index > size)
        throw new IndexOutOfBoundsException("Index: "+index);
    return new ListItr(index);
}

ListItr 是 ArrayList 中的内部类:

    private class ListItr extends Itr implements ListIterator<E> {
        ListItr(int index) {
            super();
            cursor = index;
        }

		//集合反向遍历时,判断隐式游标的上一个元素是否存在,存在返回true,否则返回false。
        public boolean hasPrevious() {
            return cursor != 0;
        }

		//返回隐式游标所指位置下一个元素的索引值。
        public int nextIndex() {
            return cursor;
        }

		//返回隐式游标所指上一个位置元素的索引值。
        public int previousIndex() {
            return cursor - 1;
        }

        @SuppressWarnings("unchecked")
        public E previous() {
            checkForComodification();
            int i = cursor - 1;
            if (i < 0)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i;
            return (E) elementData[lastRet = i];
        }

		// 从列表中将 next() 或 previous() 返回的元素替换为e,比如:next() 取出为 a,可以通过set将a 替换为on。
        public void set(E e) {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.set(lastRet, e);
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

		// 在集合中插入指定元素,插入位置与最后一个操作next() 或previous()方法有关。
        public void add(E e) {
            checkForComodification();

            try {
                int i = cursor;
                ArrayList.this.add(i, e);
                cursor = i + 1;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
    }

总结:

ArrayList 其他特点:

  • ArrayList自己实现了序列化和反序列化的方法,因为它自己实现了 private void writeObject(java.io.ObjectOutputStream s)和 private void readObject(java.io.ObjectInputStream s) 方法
  • ArrayList基于数组方式实现,无容量的限制(会扩容)
  • 添加元素时可能要扩容(所以最好预判一下),删除元素时不会减少容量(若希望减少容量,trimToSize()),删除元素时,将删除掉的位置元素置为null,下次gc就会回收这些元素所占的内存空间。
  • 线程不安全
  • add(int index, E element):添加元素到数组中指定位置的时候,需要将该位置及其后边所有的元素都整块向后复制一位
  • get(int index):获取指定位置上的元素时,可以通过索引直接获取(O(1))
  • remove(Object o)需要遍历数组
  • remove(int index)不需要遍历数组,只需判断index是否符合条件即可,效率比remove(Object o)高
  • 使用iterator遍历可能会引发多线程异常

参考文献:https://blog.csdn.net/fighterandknight/article/details/61240861

你可能感兴趣的:(Java基础,ArrayList)