Java 集合系列03之 ArrayList詳細介紹(源碼解析)和使用示例

http://www.cnblogs.com/skywang12345/p/3308556.html

概要

上一章，咱們學習了Collection的架構。這一章開始，咱們對Collection的具體實現類進行講解；首先，講解List，而List中ArrayList又最爲經常使用。所以，本章咱們講解ArrayList。先對ArrayList有個總體認識，再學習它的源碼，最後再經過例子來學習如何使用它。內容包括：
第1部分 ArrayList簡介
第2部分 ArrayList數據結構
第3部分 ArrayList源碼解析(基於JDK1.6.0_45)
第4部分 ArrayList遍歷方式
第5部分 toArray()異常
第6部分 ArrayList示例

轉載請註明出處：http://www.cnblogs.com/skywang12345/p/3308556.html

 

第1部分 ArrayList介紹

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()

// capacity是ArrayList的默認容量大小。當因爲增長數據致使容量不足時，容量會添加上一次容量大小的一半。
ArrayList(int capacity)

// 建立一個包含collection的ArrayList
ArrayList(Collection<? extends E> collection)

 

ArrayList的API

// Collection中定義的API
boolean             add(E object)
boolean             addAll(Collection<? extends E> collection)
void                clear()
boolean             contains(Object object)
boolean             containsAll(Collection<?> collection)
boolean             equals(Object object)
int                 hashCode()
boolean             isEmpty()
Iterator<E>         iterator()
boolean             remove(Object object)
boolean             removeAll(Collection<?> collection)
boolean             retainAll(Collection<?> collection)
int                 size()
<T> T[]             toArray(T[] array)
Object[]            toArray()
// AbstractCollection中定義的API
void                add(int location, E object)
boolean             addAll(int location, Collection<? extends E> collection)
E                   get(int location)
int                 indexOf(Object object)
int                 lastIndexOf(Object object)
ListIterator<E>     listIterator(int location)
ListIterator<E>     listIterator()
E                   remove(int location)
E                   set(int location, E object)
List<E>             subList(int start, int end)
// ArrayList新增的API
Object               clone()
void                 ensureCapacity(int minimumCapacity)
void                 trimToSize()
void                 removeRange(int fromIndex, int toIndex)

 

第2部分 ArrayList數據結構

ArrayList的繼承關係

java.lang.Object
   ↳     java.util.AbstractCollection<E>
         ↳     java.util.AbstractList<E>
               ↳     java.util.ArrayList<E>

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

 

ArrayList與Collection關係以下圖：

ArrayList包含了兩個重要的對象：elementData 和 size。

(01) elementData 是"Object[]類型的數組"，它保存了添加到ArrayList中的元素。實際上，elementData是個動態數組，咱們能經過構造函數 ArrayList(int initialCapacity)來執行它的初始容量爲initialCapacity；若是經過不含參數的構造函數ArrayList()來建立ArrayList，則elementData的容量默認是10。elementData數組的大小會根據ArrayList容量的增加而動態的增加，具體的增加方式，請參考源碼分析中的ensureCapacity()函數。

(02) size 則是動態數組的實際大小。

 

第3部分 ArrayList源碼解析(基於JDK1.6.0_45)

爲了更瞭解ArrayList的原理，下面對ArrayList源碼代碼做出分析。ArrayList是經過數組實現的，源碼比較容易理解。 

  1 package java.util;
  2 
  3 public class ArrayList<E> extends AbstractList<E>
  4         implements List<E>, RandomAccess, Cloneable, java.io.Serializable
  5 {
  6     // 序列版本號
  7     private static final long serialVersionUID = 8683452581122892189L;
  8 
  9     // 保存ArrayList中數據的數組
 10     private transient Object[] elementData;
 11 
 12     // ArrayList中實際數據的數量
 13     private int size;
 14 
 15     // ArrayList帶容量大小的構造函數。
 16     public ArrayList(int initialCapacity) {
 17         super();
 18         if (initialCapacity < 0)
 19             throw new IllegalArgumentException("Illegal Capacity: "+
 20                                                initialCapacity);
 21         // 新建一個數組
 22         this.elementData = new Object[initialCapacity];
 23     }
 24 
 25     // ArrayList構造函數。默認容量是10。
 26     public ArrayList() {
 27         this(10);
 28     }
 29 
 30     // 建立一個包含collection的ArrayList
 31     public ArrayList(Collection<? extends E> c) {
 32         elementData = c.toArray();
 33         size = elementData.length;
 34         // c.toArray might (incorrectly) not return Object[] (see 6260652)
 35         if (elementData.getClass() != Object[].class)
 36             elementData = Arrays.copyOf(elementData, size, Object[].class);
 37     }
 38 
 39 
 40     // 將當前容量值設爲 =實際元素個數
 41     public void trimToSize() {
 42         modCount++;
 43         int oldCapacity = elementData.length;
 44         if (size < oldCapacity) {
 45             elementData = Arrays.copyOf(elementData, size);
 46         }
 47     }
 48 
 49 
 50     // 肯定ArrarList的容量。
 51     // 若ArrayList的容量不足以容納當前的所有元素，設置 新的容量=「(原始容量x3)/2 + 1」
 52     public void ensureCapacity(int minCapacity) {
 53         // 將「修改統計數」+1
 54         modCount++;
 55         int oldCapacity = elementData.length;
 56         // 若當前容量不足以容納當前的元素個數，設置 新的容量=「(原始容量x3)/2 + 1」
 57         if (minCapacity > oldCapacity) {
 58             Object oldData[] = elementData;
 59             int newCapacity = (oldCapacity * 3)/2 + 1;
 60             if (newCapacity < minCapacity)
 61                 newCapacity = minCapacity;
 62             elementData = Arrays.copyOf(elementData, newCapacity);
 63         }
 64     }
 65 
 66     // 添加元素e
 67     public boolean add(E e) {
 68         // 肯定ArrayList的容量大小
 69         ensureCapacity(size + 1);  // Increments modCount!!
 70         // 添加e到ArrayList中
 71         elementData[size++] = e;
 72         return true;
 73     }
 74 
 75     // 返回ArrayList的實際大小
 76     public int size() {
 77         return size;
 78     }
 79 
 80     // 返回ArrayList是否包含Object(o)
 81     public boolean contains(Object o) {
 82         return indexOf(o) >= 0;
 83     }
 84 
 85     // 返回ArrayList是否爲空
 86     public boolean isEmpty() {
 87         return size == 0;
 88     }
 89 
 90     // 正向查找，返回元素的索引值
 91     public int indexOf(Object o) {
 92         if (o == null) {
 93             for (int i = 0; i < size; i++)
 94             if (elementData[i]==null)
 95                 return i;
 96             } else {
 97                 for (int i = 0; i < size; i++)
 98                 if (o.equals(elementData[i]))
 99                     return i;
100             }
101             return -1;
102         }
103 
104         // 反向查找，返回元素的索引值
105         public int lastIndexOf(Object o) {
106         if (o == null) {
107             for (int i = size-1; i >= 0; i--)
108             if (elementData[i]==null)
109                 return i;
110         } else {
111             for (int i = size-1; i >= 0; i--)
112             if (o.equals(elementData[i]))
113                 return i;
114         }
115         return -1;
116     }
117 
118     // 反向查找(從數組末尾向開始查找)，返回元素(o)的索引值
119     public int lastIndexOf(Object o) {
120         if (o == null) {
121             for (int i = size-1; i >= 0; i--)
122             if (elementData[i]==null)
123                 return i;
124         } else {
125             for (int i = size-1; i >= 0; i--)
126             if (o.equals(elementData[i]))
127                 return i;
128         }
129         return -1;
130     }
131  
132 
133     // 返回ArrayList的Object數組
134     public Object[] toArray() {
135         return Arrays.copyOf(elementData, size);
136     }
137 
138     // 返回ArrayList的模板數組。所謂模板數組，便可以將T設爲任意的數據類型
139     public <T> T[] toArray(T[] a) {
140         // 若數組a的大小 < ArrayList的元素個數；
141         // 則新建一個T[]數組，數組大小是「ArrayList的元素個數」，並將「ArrayList」所有拷貝到新數組中
142         if (a.length < size)
143             return (T[]) Arrays.copyOf(elementData, size, a.getClass());
144 
145         // 若數組a的大小 >= ArrayList的元素個數；
146         // 則將ArrayList的所有元素都拷貝到數組a中。
147         System.arraycopy(elementData, 0, a, 0, size);
148         if (a.length > size)
149             a[size] = null;
150         return a;
151     }
152 
153     // 獲取index位置的元素值
154     public E get(int index) {
155         RangeCheck(index);
156 
157         return (E) elementData[index];
158     }
159 
160     // 設置index位置的值爲element
161     public E set(int index, E element) {
162         RangeCheck(index);
163 
164         E oldValue = (E) elementData[index];
165         elementData[index] = element;
166         return oldValue;
167     }
168 
169     // 將e添加到ArrayList中
170     public boolean add(E e) {
171         ensureCapacity(size + 1);  // Increments modCount!!
172         elementData[size++] = e;
173         return true;
174     }
175 
176     // 將e添加到ArrayList的指定位置
177     public void add(int index, E element) {
178         if (index > size || index < 0)
179             throw new IndexOutOfBoundsException(
180             "Index: "+index+", Size: "+size);
181 
182         ensureCapacity(size+1);  // Increments modCount!!
183         System.arraycopy(elementData, index, elementData, index + 1,
184              size - index);
185         elementData[index] = element;
186         size++;
187     }
188 
189     // 刪除ArrayList指定位置的元素
190     public E remove(int index) {
191         RangeCheck(index);
192 
193         modCount++;
194         E oldValue = (E) elementData[index];
195 
196         int numMoved = size - index - 1;
197         if (numMoved > 0)
198             System.arraycopy(elementData, index+1, elementData, index,
199                  numMoved);
200         elementData[--size] = null; // Let gc do its work
201 
202         return oldValue;
203     }
204 
205     // 刪除ArrayList的指定元素
206     public boolean remove(Object o) {
207         if (o == null) {
208                 for (int index = 0; index < size; index++)
209             if (elementData[index] == null) {
210                 fastRemove(index);
211                 return true;
212             }
213         } else {
214             for (int index = 0; index < size; index++)
215             if (o.equals(elementData[index])) {
216                 fastRemove(index);
217                 return true;
218             }
219         }
220         return false;
221     }
222 
223 
224     // 快速刪除第index個元素
225     private void fastRemove(int index) {
226         modCount++;
227         int numMoved = size - index - 1;
228         // 從"index+1"開始，用後面的元素替換前面的元素。
229         if (numMoved > 0)
230             System.arraycopy(elementData, index+1, elementData, index,
231                              numMoved);
232         // 將最後一個元素設爲null
233         elementData[--size] = null; // Let gc do its work
234     }
235 
236     // 刪除元素
237     public boolean remove(Object o) {
238         if (o == null) {
239             for (int index = 0; index < size; index++)
240             if (elementData[index] == null) {
241                 fastRemove(index);
242             return true;
243             }
244         } else {
245             // 便利ArrayList，找到「元素o」，則刪除，並返回true。
246             for (int index = 0; index < size; index++)
247             if (o.equals(elementData[index])) {
248                 fastRemove(index);
249             return true;
250             }
251         }
252         return false;
253     }
254 
255     // 清空ArrayList，將所有的元素設爲null
256     public void clear() {
257         modCount++;
258 
259         for (int i = 0; i < size; i++)
260             elementData[i] = null;
261 
262         size = 0;
263     }
264 
265     // 將集合c追加到ArrayList中
266     public boolean addAll(Collection<? extends E> c) {
267         Object[] a = c.toArray();
268         int numNew = a.length;
269         ensureCapacity(size + numNew);  // Increments modCount
270         System.arraycopy(a, 0, elementData, size, numNew);
271         size += numNew;
272         return numNew != 0;
273     }
274 
275     // 從index位置開始，將集合c添加到ArrayList
276     public boolean addAll(int index, Collection<? extends E> c) {
277         if (index > size || index < 0)
278             throw new IndexOutOfBoundsException(
279             "Index: " + index + ", Size: " + size);
280 
281         Object[] a = c.toArray();
282         int numNew = a.length;
283         ensureCapacity(size + numNew);  // Increments modCount
284 
285         int numMoved = size - index;
286         if (numMoved > 0)
287             System.arraycopy(elementData, index, elementData, index + numNew,
288                  numMoved);
289 
290         System.arraycopy(a, 0, elementData, index, numNew);
291         size += numNew;
292         return numNew != 0;
293     }
294 
295     // 刪除fromIndex到toIndex之間的所有元素。
296     protected void removeRange(int fromIndex, int toIndex) {
297     modCount++;
298     int numMoved = size - toIndex;
299         System.arraycopy(elementData, toIndex, elementData, fromIndex,
300                          numMoved);
301 
302     // Let gc do its work
303     int newSize = size - (toIndex-fromIndex);
304     while (size != newSize)
305         elementData[--size] = null;
306     }
307 
308     private void RangeCheck(int index) {
309     if (index >= size)
310         throw new IndexOutOfBoundsException(
311         "Index: "+index+", Size: "+size);
312     }
313 
314 
315     // 克隆函數
316     public Object clone() {
317         try {
318             ArrayList<E> v = (ArrayList<E>) super.clone();
319             // 將當前ArrayList的所有元素拷貝到v中
320             v.elementData = Arrays.copyOf(elementData, size);
321             v.modCount = 0;
322             return v;
323         } catch (CloneNotSupportedException e) {
324             // this shouldn't happen, since we are Cloneable
325             throw new InternalError();
326         }
327     }
328 
329 
330     // java.io.Serializable的寫入函數
331     // 將ArrayList的「容量，全部的元素值」都寫入到輸出流中
332     private void writeObject(java.io.ObjectOutputStream s)
333         throws java.io.IOException{
334     // Write out element count, and any hidden stuff
335     int expectedModCount = modCount;
336     s.defaultWriteObject();
337 
338         // 寫入「數組的容量」
339         s.writeInt(elementData.length);
340 
341     // 寫入「數組的每個元素」
342     for (int i=0; i<size; i++)
343             s.writeObject(elementData[i]);
344 
345     if (modCount != expectedModCount) {
346             throw new ConcurrentModificationException();
347         }
348 
349     }
350 
351 
352     // java.io.Serializable的讀取函數：根據寫入方式讀出
353     // 先將ArrayList的「容量」讀出，而後將「全部的元素值」讀出
354     private void readObject(java.io.ObjectInputStream s)
355         throws java.io.IOException, ClassNotFoundException {
356         // Read in size, and any hidden stuff
357         s.defaultReadObject();
358 
359         // 從輸入流中讀取ArrayList的「容量」
360         int arrayLength = s.readInt();
361         Object[] a = elementData = new Object[arrayLength];
362 
363         // 從輸入流中將「全部的元素值」讀出
364         for (int i=0; i<size; i++)
365             a[i] = s.readObject();
366     }
367 }

總結：
(01) ArrayList 其實是經過一個數組去保存數據的。當咱們構造ArrayList時；若使用默認構造函數，則ArrayList的默認容量大小是10。
(02) 當ArrayList容量不足以容納所有元素時，ArrayList會從新設置容量：新的容量=「(原始容量x3)/2 + 1」。
(03) ArrayList的克隆函數，便是將所有元素克隆到一個數組中。
(04) ArrayList實現java.io.Serializable的方式。當寫入到輸出流時，先寫入「容量」，再依次寫入「每個元素」；當讀出輸入流時，先讀取「容量」，再依次讀取「每個元素」。

 

第4部分 ArrayList遍歷方式

ArrayList支持3種遍歷方式

(01) 第一種，經過迭代器遍歷。即經過Iterator去遍歷。

Integer value = null;
Iterator iter = list.iterator();
while (iter.hasNext()) {
    value = (Integer)iter.next();
}

(02) 第二種，隨機訪問，經過索引值去遍歷。
因爲ArrayList實現了RandomAccess接口，它支持經過索引值去隨機訪問元素。

Integer value = null;
int size = list.size();
for (int i=0; i<size; i++) {
    value = (Integer)list.get(i);        
}

(03) 第三種，for循環遍歷。以下：

Integer value = null;
for (Integer integ:list) {
    value = integ;
}

 

下面經過一個實例，比較這3種方式的效率，實例代碼(ArrayListRandomAccessTest.java)以下：

 1 import java.util.*;
 2 import java.util.concurrent.*;
 3 
 4 /*
 5  * @desc ArrayList遍歷方式和效率的測試程序。
 6  *
 7  * @author skywang
 8  */
 9 public class ArrayListRandomAccessTest {
10 
11     public static void main(String[] args) {
12         List list = new ArrayList();
13         for (int i=0; i<100000; i++)
14             list.add(i);
15         //isRandomAccessSupported(list);
16         iteratorThroughRandomAccess(list) ;
17         iteratorThroughIterator(list) ;
18         iteratorThroughFor2(list) ;
19     
20     }
21 
22     private static void isRandomAccessSupported(List list) {
23         if (list instanceof RandomAccess) {
24             System.out.println("RandomAccess implemented!");
25         } else {
26             System.out.println("RandomAccess not implemented!");
27         }
28 
29     }
30 
31     public static void iteratorThroughRandomAccess(List list) {
32 
33         long startTime;
34         long endTime;
35         startTime = System.currentTimeMillis();
36         for (int i=0; i<list.size(); i++) {
37             list.get(i);
38         }
39         endTime = System.currentTimeMillis();
40         long interval = endTime - startTime;
41         System.out.println("iteratorThroughRandomAccess：" + interval+" ms");
42     }
43 
44     public static void iteratorThroughIterator(List list) {
45 
46         long startTime;
47         long endTime;
48         startTime = System.currentTimeMillis();
49         for(Iterator iter = list.iterator(); iter.hasNext(); ) {
50             iter.next();
51         }
52         endTime = System.currentTimeMillis();
53         long interval = endTime - startTime;
54         System.out.println("iteratorThroughIterator：" + interval+" ms");
55     }
56 
57 
58     public static void iteratorThroughFor2(List list) {
59 
60         long startTime;
61         long endTime;
62         startTime = System.currentTimeMillis();
63         for(Object obj:list)
64             ;
65         endTime = System.currentTimeMillis();
66         long interval = endTime - startTime;
67         System.out.println("iteratorThroughFor2：" + interval+" ms");
68     }
69 }

 

運行結果：

iteratorThroughRandomAccess：3 ms
iteratorThroughIterator：8 ms
iteratorThroughFor2：5 ms

因而可知，遍歷ArrayList時，使用隨機訪問(即，經過索引序號訪問)效率最高，而使用迭代器的效率最低！

 

第5部分 toArray()異常

當咱們調用ArrayList中的 toArray()，可能遇到過拋出「java.lang.ClassCastException」異常的狀況。下面咱們說說這是怎麼回事。

ArrayList提供了2個toArray()函數：

Object[] toArray()
<T> T[] toArray(T[] contents)

調用 toArray() 函數會拋出「java.lang.ClassCastException」異常，可是調用 toArray(T[] contents) 能正常返回 T[]。

toArray() 會拋出異常是由於 toArray() 返回的是 Object[] 數組，將 Object[] 轉換爲其它類型(如如，將Object[]轉換爲的Integer[])則會拋出「java.lang.ClassCastException」異常，由於Java不支持向下轉型。具體的能夠參考前面ArrayList.java的源碼介紹部分的toArray()。
解決該問題的辦法是調用 <T> T[] toArray(T[] contents) ， 而不是 Object[] toArray()。

調用 toArray(T[] contents) 返回T[]的能夠經過如下幾種方式實現。

// toArray(T[] contents)調用方式一
public static Integer[] vectorToArray1(ArrayList<Integer> v) {
    Integer[] newText = new Integer[v.size()];
    v.toArray(newText);
    return newText;
}

// toArray(T[] contents)調用方式二。最經常使用！
public static Integer[] vectorToArray2(ArrayList<Integer> v) {
    Integer[] newText = (Integer[])v.toArray(new Integer[0]);
    return newText;
}

// toArray(T[] contents)調用方式三
public static Integer[] vectorToArray3(ArrayList<Integer> v) {
    Integer[] newText = new Integer[v.size()];
    Integer[] newStrings = (Integer[])v.toArray(newText);
    return newStrings;
}

  

第6部分 ArrayList示例

本文經過一個實例(ArrayListTest.java)，介紹 ArrayList 中經常使用API的用法。 

 1 import java.util.*;
 2 
 3 /*
 4  * @desc ArrayList經常使用API的測試程序
 5  * @author skywang 
 6  * @email kuiwu-wang@163.com
 7  */
 8 public class ArrayListTest {
 9 
10     public static void main(String[] args) {
11         
12         // 建立ArrayList
13         ArrayList list = new ArrayList();
14 
15         // 將「」
16         list.add("1");
17         list.add("2");
18         list.add("3");
19         list.add("4");
20         // 將下面的元素添加到第1個位置
21         list.add(0, "5");
22 
23         // 獲取第1個元素
24         System.out.println("the first element is: "+ list.get(0));
25         // 刪除「3」
26         list.remove("3");
27         // 獲取ArrayList的大小
28         System.out.println("Arraylist size=: "+ list.size());
29         // 判斷list中是否包含"3"
30         System.out.println("ArrayList contains 3 is: "+ list.contains(3));
31         // 設置第2個元素爲10
32         list.set(1, "10");
33 
34         // 經過Iterator遍歷ArrayList
35         for(Iterator iter = list.iterator(); iter.hasNext(); ) {
36             System.out.println("next is: "+ iter.next());
37         }
38 
39         // 將ArrayList轉換爲數組
40         String[] arr = (String[])list.toArray(new String[0]);
41         for (String str:arr)
42             System.out.println("str: "+ str);
43 
44         // 清空ArrayList
45         list.clear();
46         // 判斷ArrayList是否爲空
47         System.out.println("ArrayList is empty: "+ list.isEmpty());
48     }
49 }

運行結果：

the first element is: 5
Arraylist size=: 4
ArrayList contains 3 is: false
next is: 5
next is: 10
next is: 2
next is: 4
str: 5
str: 10
str: 2
str: 4
ArrayList is empty: true