• ArrayList源码分析(基于JDK1.6)


        不积跬步,无以至千里;不积小流,无以成江海。从基础做起,一点点积累,加油!

        《Java集合类》中讲述了ArrayList的基础使用,本文将深入剖析ArrayList的内部结构及实现原理,以便更好的、更高效的使用它。

        ArrayList就是传说中的动态数组,就是Array的复杂版本,它提供了如下一些好处:动态的增加和减少元素、灵活的设置数组的大小......

        认真阅读本文,我相信一定会对你有帮助。比如为什么ArrayList里面提供了一个受保护的removeRange方法?提供了其他没有被调用过的私有方法?

        首先看到对ArrayList的定义:

    1 public class ArrayList<E> extends AbstractList<E>  implements List<E>, RandomAccess, Cloneable, java.io.Serializable

        从ArrayList<E>可以看出它是支持泛型的,它继承自AbstractList,实现了List、RandomAccess、Cloneable、java.io.Serializable接口。

        AbstractList提供了List接口的默认实现(个别方法为抽象方法)。

        List接口定义了列表必须实现的方法。

        RandomAccess是一个标记接口,接口内没有定义任何内容。

        实现了Cloneable接口的类,可以调用Object.clone方法返回该对象的浅拷贝。

        通过实现 java.io.Serializable 接口以启用其序列化功能。未实现此接口的类将无法使其任何状态序列化或反序列化。序列化接口没有方法或字段,仅用于标识可序列化的语义。

        ArrayList的属性

        ArrayList定义只定义类两个私有属性:

     1 /**
     2      * The array buffer into which the elements of the ArrayList are stored.
     3      * The capacity of the ArrayList is the length of this array buffer.
     4      */
     5     private transient Object[] elementData;
     6 
     7     /**
     8      * The size of the ArrayList (the number of elements it contains).
     9      *
    10      * @serial
    11      */
    12     private int size;

        很容易理解,elementData存储ArrayList内的元素,size表示它包含的元素的数量。

        有个关键字需要解释:transient。

        Java的serialization提供了一种持久化对象实例的机制。当持久化对象时,可能有一个特殊的对象数据成员,我们不想用serialization机制来保存它。为了在一个特定对象的一个域上关闭serialization,可以在这个域前加上关键字transient。
    transient是Java语言的关键字,用来表示一个域不是该对象串行化的一部分。当一个对象被串行化的时候,transient型变量的值不包括在串行化的表示中,然而非transient型的变量是被包括进去的。

        有点抽象,看个例子应该能明白。

     1 public class UserInfo implements Serializable {
     2     private static final long serialVersionUID = 996890129747019948L;
     3     private String name;
     4     private transient String psw;
     5 
     6     public UserInfo(String name, String psw) {
     7         this.name = name;
     8         this.psw = psw;
     9     }
    10 
    11     public String toString() {
    12         return "name=" + name + ", psw=" + psw;
    13     }
    14 }
    15 
    16 public class TestTransient {
    17     public static void main(String[] args) {
    18         UserInfo userInfo = new UserInfo("张三", "123456");
    19         System.out.println(userInfo);
    20         try {
    21             // 序列化,被设置为transient的属性没有被序列化
    22             ObjectOutputStream o = new ObjectOutputStream(new FileOutputStream(
    23                     "UserInfo.out"));
    24             o.writeObject(userInfo);
    25             o.close();
    26         } catch (Exception e) {
    27             // TODO: handle exception
    28             e.printStackTrace();
    29         }
    30         try {
    31             // 重新读取内容
    32             ObjectInputStream in = new ObjectInputStream(new FileInputStream(
    33                     "UserInfo.out"));
    34             UserInfo readUserInfo = (UserInfo) in.readObject();
    35             //读取后psw的内容为null
    36             System.out.println(readUserInfo.toString());
    37         } catch (Exception e) {
    38             // TODO: handle exception
    39             e.printStackTrace();
    40         }
    41     }
    42 }

        被标记为transient的属性在对象被序列化的时候不会被保存。

        接着回到ArrayList的分析中......

        ArrayList的构造方法

        看完属性看构造方法。ArrayList提供了三个构造方法:

     1 /**
     2      * Constructs an empty list with the specified initial capacity.
     3      */
     4     public ArrayList(int initialCapacity) {
     5     super();
     6         if (initialCapacity < 0)
     7             throw new IllegalArgumentException("Illegal Capacity: "+
     8                                                initialCapacity);
     9     this.elementData = new Object[initialCapacity];
    10     }
    11 
    12     /**
    13      * Constructs an empty list with an initial capacity of ten.
    14      */
    15     public ArrayList() {
    16     this(10);
    17     }
    18 
    19     /**
    20      * Constructs a list containing the elements of the specified
    21      * collection, in the order they are returned by the collection's
    22      * iterator.
    23      */
    24     public ArrayList(Collection<? extends E> c) {
    25     elementData = c.toArray();
    26     size = elementData.length;
    27     // c.toArray might (incorrectly) not return Object[] (see 6260652)
    28     if (elementData.getClass() != Object[].class)
    29         elementData = Arrays.copyOf(elementData, size, Object[].class);
    30     }

        第一个构造方法使用提供的initialCapacity来初始化elementData数组的大小。第二个构造方法调用第一个构造方法并传入参数10,即默认elementData数组的大小为10。第三个构造方法则将提供的集合转成数组返回给elementData(返回若不是Object[]将调用Arrays.copyOf方法将其转为Object[])。

        ArrayList的其他方法

        add(E e)

        add(E e)都知道是在尾部添加一个元素,如何实现的呢?

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

        书上都说ArrayList是基于数组实现的,属性中也看到了数组,具体是怎么实现的呢?比如就这个添加元素的方法,如果数组大,则在将某个位置的值设置为指定元素即可,如果数组容量不够了呢?

        看到add(E e)中先调用了ensureCapacity(size+1)方法,之后将元素的索引赋给elementData[size],而后size自增。例如初次添加时,size为0,add将elementData[0]赋值为e,然后size设置为1(类似执行以下两条语句elementData[0]=e;size=1)。将元素的索引赋给elementData[size]不是会出现数组越界的情况吗?这里关键就在ensureCapacity(size+1)中了。

        根据ensureCapacity的方法名可以知道是确保容量用的。ensureCapacity(size+1)后面的注释可以明白是增加modCount的值(加了俩感叹号,应该蛮重要的,来看看)。

     1 /**
     2      * Increases the capacity of this <tt>ArrayList</tt> instance, if
     3      * necessary, to ensure that it can hold at least the number of elements
     4      * specified by the minimum capacity argument.
     5      *
     6      * @param   minCapacity   the desired minimum capacity
     7      */
     8     public void ensureCapacity(int minCapacity) {
     9     modCount++;
    10     int oldCapacity = elementData.length;
    11     if (minCapacity > oldCapacity) {
    12         Object oldData[] = elementData;
    13         int newCapacity = (oldCapacity * 3)/2 + 1;
    14             if (newCapacity < minCapacity)
    15         newCapacity = minCapacity;
    16             // minCapacity is usually close to size, so this is a win:
    17             elementData = Arrays.copyOf(elementData, newCapacity);
    18     }
    19     }

        The number of times this list has been structurally modified.

        这是对modCount的解释,意为记录list结构被改变的次数(观察源码可以发现每次调用ensureCapacoty方法,modCount的值都将增加,但未必数组结构会改变,所以感觉对modCount的解释不是很到位)。

        增加modCount之后,判断minCapacity(即size+1)是否大于oldCapacity(即elementData.length),若大于,则调整容量为max((oldCapacity*3)/2+1,minCapacity),调整elementData容量为新的容量,即将返回一个内容为原数组元素,大小为新容量的数组赋给elementData;否则不做操作。

        所以调用ensureCapacity至少将elementData的容量增加的1,所以elementData[size]不会出现越界的情况。

        容量的拓展将导致数组元素的复制,多次拓展容量将执行多次整个数组内容的复制。若提前能大致判断list的长度,调用ensureCapacity调整容量,将有效的提高运行速度。

        可以理解提前分配好空间可以提高运行速度,但是测试发现提高的并不是很大,而且若list原本数据量就不会很大效果将更不明显。

        add(int index, E element)

        add(int index,E element)在指定位置插入元素。

     1 public void add(int index, E element) {
     2     if (index > size || index < 0)
     3         throw new IndexOutOfBoundsException(
     4         "Index: "+index+", Size: "+size);
     5 
     6     ensureCapacity(size+1);  // Increments modCount!!
     7     System.arraycopy(elementData, index, elementData, index + 1,
     8              size - index);
     9     elementData[index] = element;
    10     size++;
    11     }

        首先判断指定位置index是否超出elementData的界限,之后调用ensureCapacity调整容量(若容量足够则不会拓展),调用System.arraycopy将elementData从index开始的size-index个元素复制到index+1至size+1的位置(即index开始的元素都向后移动一个位置),然后将index位置的值指向element。       

        addAll(Collection<? extends E> c)

    1 public boolean addAll(Collection<? extends E> c) {
    2     Object[] a = c.toArray();
    3         int numNew = a.length;
    4     ensureCapacity(size + numNew);  // Increments modCount
    5         System.arraycopy(a, 0, elementData, size, numNew);
    6         size += numNew;
    7     return numNew != 0;
    8     }

        先将集合c转换成数组,根据转换后数组的程度和ArrayList的size拓展容量,之后调用System.arraycopy方法复制元素到elementData的尾部,调整size。根据返回的内容分析,只要集合c的大小不为空,即转换后的数组长度不为0则返回true。

        addAll(int index,Collection<? extends E> c)

     1 public boolean addAll(int index, Collection<? extends E> c) {
     2     if (index > size || index < 0)
     3         throw new IndexOutOfBoundsException(
     4         "Index: " + index + ", Size: " + size);
     5 
     6     Object[] a = c.toArray();
     7     int numNew = a.length;
     8     ensureCapacity(size + numNew);  // Increments modCount
     9 
    10     int numMoved = size - index;
    11     if (numMoved > 0)
    12         System.arraycopy(elementData, index, elementData, index + numNew,
    13                  numMoved);
    14 
    15         System.arraycopy(a, 0, elementData, index, numNew);
    16     size += numNew;
    17     return numNew != 0;
    18     }

         先判断index是否越界。其他内容与addAll(Collection<? extends E> c)基本一致,只是复制的时候先将index开始的元素向后移动X(c转为数组后的长度)个位置(也是一个复制的过程),之后将数组内容复制到elementData的index位置至index+X。

        clear()

    1 public void clear() {
    2     modCount++;
    3 
    4     // Let gc do its work
    5     for (int i = 0; i < size; i++)
    6         elementData[i] = null;
    7 
    8     size = 0;
    9     }

        clear的时候并没有修改elementData的长度(好不容易申请、拓展来的,凭什么释放,留着搞不好还有用呢。这使得确定不再修改list内容之后最好调用trimToSize来释放掉一些空间),只是将所有元素置为null,size设置为0。

        clone()

        返回此 ArrayList 实例的浅表副本。(不复制这些元素本身。)

     1 public Object clone() {
     2     try {
     3         ArrayList<E> v = (ArrayList<E>) super.clone();
     4         v.elementData = Arrays.copyOf(elementData, size);
     5         v.modCount = 0;
     6         return v;
     7     } catch (CloneNotSupportedException e) {
     8         // this shouldn't happen, since we are Cloneable
     9         throw new InternalError();
    10     }
    11     }

        调用父类的clone方法返回一个对象的副本,将返回对象的elementData数组的内容赋值为原对象elementData数组的内容,将副本的modCount设置为0。

        contains(Object)

    1 public boolean contains(Object o) {
    2     return indexOf(o) >= 0;
    3     }

        indexOf方法返回值与0比较来判断对象是否在list中。接着看indexOf。

        indexOf(Object)

     1 public int indexOf(Object o) {
     2     if (o == null) {
     3         for (int i = 0; i < size; i++)
     4         if (elementData[i]==null)
     5             return i;
     6     } else {
     7         for (int i = 0; i < size; i++)
     8         if (o.equals(elementData[i]))
     9             return i;
    10     }
    11     return -1;
    12     }

        通过遍历elementData数组来判断对象是否在list中,若存在,返回index([0,size-1]),若不存在则返回-1。所以contains方法可以通过indexOf(Object)方法的返回值来判断对象是否被包含在list中。

        既然看了indexOf(Object)方法,接着就看lastIndexOf,光看名字应该就明白了返回的是传入对象在elementData数组中最后出现的index值。

     1 public int lastIndexOf(Object o) {
     2     if (o == null) {
     3         for (int i = size-1; i >= 0; i--)
     4         if (elementData[i]==null)
     5             return i;
     6     } else {
     7         for (int i = size-1; i >= 0; i--)
     8         if (o.equals(elementData[i]))
     9             return i;
    10     }
    11     return -1;
    12     }

        采用了从后向前遍历element数组,若遇到Object则返回index值,若没有遇到,返回-1。

        get(int index)

        这个方法看着很简单,应该是返回elementData[index]就完了。

    1 public E get(int index) {
    2     RangeCheck(index);
    3 
    4     return (E) elementData[index];
    5     }

        但看代码的时候看到调用了RangeCheck方法,而且还是大写的方法,看看究竟有什么内容吧。

    1 /**
    2      * Checks if the given index is in range.
    3 */
    4 private void RangeCheck(int index) {
    5     if (index >= size)
    6         throw new IndexOutOfBoundsException(
    7         "Index: "+index+", Size: "+size);
    8     }

        就是检查一下是不是超出数组界限了,超出了就抛出IndexOutBoundsException异常。为什么要大写呢???

        isEmpty()

        直接返回size是否等于0。

        remove(int index)

     1 public E remove(int index) {
     2     RangeCheck(index);
     3     modCount++;
     4     E oldValue = (E) elementData[index];
     5     int numMoved = size - index - 1;
     6     if (numMoved > 0)
     7         System.arraycopy(elementData, index+1, elementData, index,
     8                  numMoved);
     9     elementData[--size] = null; // Let gc do its work
    10     return oldValue;
    11     }

        首先是检查范围,修改modCount,保留将要被移除的元素,将移除位置之后的元素向前挪动一个位置,将list末尾元素置空(null),返回被移除的元素。

        remove(Object o)

     1 public boolean remove(Object o) {
     2     if (o == null) {
     3             for (int index = 0; index < size; index++)
     4         if (elementData[index] == null) {
     5             fastRemove(index);
     6             return true;
     7         }
     8     } else {
     9         for (int index = 0; index < size; index++)
    10         if (o.equals(elementData[index])) {
    11             fastRemove(index);
    12             return true;
    13         }
    14         }
    15     return false;
    16     }

        首先通过代码可以看到,当移除成功后返回true,否则返回false。remove(Object o)中通过遍历element寻找是否存在传入对象,一旦找到就调用fastRemove移除对象。为什么找到了元素就知道了index,不通过remove(index)来移除元素呢?因为fastRemove跳过了判断边界的处理,因为找到元素就相当于确定了index不会超过边界,而且fastRemove并不返回被移除的元素。下面是fastRemove的代码,基本和remove(index)一致。

    1 private void fastRemove(int index) {
    2         modCount++;
    3         int numMoved = size - index - 1;
    4         if (numMoved > 0)
    5             System.arraycopy(elementData, index+1, elementData, index,
    6                              numMoved);
    7         elementData[--size] = null; // Let gc do its work
    8     }

        removeRange(int fromIndex,int toIndex)

     1 protected void removeRange(int fromIndex, int toIndex) {
     2     modCount++;
     3     int numMoved = size - toIndex;
     4         System.arraycopy(elementData, toIndex, elementData, fromIndex,
     5                          numMoved);
     6 
     7     // Let gc do its work
     8     int newSize = size - (toIndex-fromIndex);
     9     while (size != newSize)
    10         elementData[--size] = null;
    11     }

        执行过程是将elementData从toIndex位置开始的元素向前移动到fromIndex,然后将toIndex位置之后的元素全部置空顺便修改size。

        这个方法是protected,及受保护的方法,为什么这个方法被定义为protected呢?

        这是一个解释,但是可能不容易看明白。http://stackoverflow.com/questions/2289183/why-is-javas-abstractlists-removerange-method-protected

        先看下面这个例子

    1 ArrayList<Integer> ints = new ArrayList<Integer>(Arrays.asList(0, 1, 2,
    2                 3, 4, 5, 6));
    3         // fromIndex low endpoint (inclusive) of the subList
    4         // toIndex high endpoint (exclusive) of the subList
    5         ints.subList(2, 4).clear();
    6         System.out.println(ints);

        输出结果是[0, 1, 4, 5, 6],结果是不是像调用了removeRange(int fromIndex,int toIndex)!哈哈哈,就是这样的。但是为什么效果相同呢?是不是调用了removeRange(int fromIndex,int toIndex)呢?这个问题将领写一篇博文讨论。

         《ArrayList removeRange方法深入分析》http://www.cnblogs.com/hzmark/archive/2012/12/19/ArrayList_removeRange.html

        set(int index,E element)

    1 public E set(int index, E element) {
    2     RangeCheck(index);
    3 
    4     E oldValue = (E) elementData[index];
    5     elementData[index] = element;
    6     return oldValue;
    7     }

        首先检查范围,用新元素替换旧元素并返回旧元素。

        size()

        size()方法直接返回size。

        toArray()

    1 public Object[] toArray() {
    2         return Arrays.copyOf(elementData, size);
    3     }

        调用Arrays.copyOf将返回一个数组,数组内容是size个elementData的元素,即拷贝elementData从0至size-1位置的元素到新数组并返回。

        toArray(T[] a)

    1 public <T> T[] toArray(T[] a) {
    2         if (a.length < size)
    3             // Make a new array of a's runtime type, but my contents:
    4             return (T[]) Arrays.copyOf(elementData, size, a.getClass());
    5     System.arraycopy(elementData, 0, a, 0, size);
    6         if (a.length > size)
    7             a[size] = null;
    8         return a;
    9     }

        如果传入数组的长度小于size,返回一个新的数组,大小为size,类型与传入数组相同。所传入数组长度与size相等,则将elementData复制到传入数组中并返回传入的数组。若传入数组长度大于size,除了复制elementData外,还将把返回数组的第size个元素置为空。

        trimToSize()

    1 public void trimToSize() {
    2     modCount++;
    3     int oldCapacity = elementData.length;
    4     if (size < oldCapacity) {
    5             elementData = Arrays.copyOf(elementData, size);
    6     }
    7     }

        由于elementData的长度会被拓展,size标记的是其中包含的元素的个数。所以会出现size很小但elementData.length很大的情况,将出现空间的浪费。trimToSize将返回一个新的数组给elementData,元素内容保持不变,length很size相同,节省空间。

        学习Java最好的方式还必须是读源码。读完源码你才会发现这东西为什么是这么玩的,有哪些限制,关键点在哪里等等。而且这些源码都是大牛们写的,你能从中学习到很多。 

     

     

        

    如果本文对您有帮助,点一下右下角的“推荐”
  • 相关阅读:
    大学毕业4年-回顾和总结(1)-钱,金钱观
    VR开发中性能问题—OculusWaitForGPU
    动态规划(一)
    POJ 2229 Sumsets
    hihoCoder #1122 : 二分图二•二分图最大匹配之匈牙利算法
    hihoCoder #1127 : 二分图二·二分图最小点覆盖和最大独立集
    hihoCoder #1121 : 二分图一•二分图判定
    HDU 1978 How many ways
    POJ1579 Function Run Fun
    POJ 2081 Recaman's Sequence
  • 原文地址:https://www.cnblogs.com/hzmark/p/ArrayList.html
Copyright © 2020-2023  润新知