转：【Java集合源码剖析】ArrayList源码剖析

转载请注明出处：http://blog.csdn.net/ns_code/article/details/35568011

 

本篇博文参加了CSDN博文大赛，如果您觉得这篇博文不错，希望您能帮我投一票，谢谢！

投票地址：http://vote.blog.csdn.net/Article/Details?articleid=35568011

 

ArrayList简介

ArrayList是基于数组实现的，是一个动态数组，其容量能自动增长，类似于C语言中的动态申请内存，动态增长内存。

ArrayList不是线程安全的，只能用在单线程环境下，多线程环境下可以考虑用Collections.synchronizedList(List l)函数返回一个线程安全的ArrayList类，也可以使用concurrent并发包下的CopyOnWriteArrayList类。

ArrayList实现了Serializable接口，因此它支持序列化，能够通过序列化传输，实现了RandomAccess接口，支持快速随机访问，实际上就是通过下标序号进行快速访问，实现了Cloneable接口，能被克隆。

ArrayList源码剖析

ArrayList的源码如下（加入了比较详细的注释）：

1. package java.util;
2. public class ArrayList<E> extends AbstractList<E>
3. implements List<E>, RandomAccess, Cloneable, java.io.Serializable
4. {
5. // 序列版本号
6. private static final long serialVersionUID = 8683452581122892189L;
7. // ArrayList基于该数组实现，用该数组保存数据
8. private transient Object[] elementData;
9. // ArrayList中实际数据的数量
10. private int size;
11. // ArrayList带容量大小的构造函数。
12. public ArrayList(int initialCapacity) {
13. super();
14. if (initialCapacity < 0)
15. throw new IllegalArgumentException("Illegal Capacity: "+
16. initialCapacity);
17. // 新建一个数组
18. this.elementData = new Object[initialCapacity];
19. }
20. // ArrayList无参构造函数。默认容量是10。
21. public ArrayList() {
22. this(10);
23. }
24. // 创建一个包含collection的ArrayList
25. public ArrayList(Collection<? extends E> c) {
26. elementData = c.toArray();
27. size = elementData.length;
28. if (elementData.getClass() != Object[].class)
29. elementData = Arrays.copyOf(elementData, size, Object[].class);
30. }
31. // 将当前容量值设为实际元素个数
32. public void trimToSize() {
33. modCount++;
34. int oldCapacity = elementData.length;
35. if (size < oldCapacity) {
36. elementData = Arrays.copyOf(elementData, size);
37. }
38. }
39. // 确定ArrarList的容量。
40. // 若ArrayList的容量不足以容纳当前的全部元素，设置 新的容量=“(原始容量x3)/2 + 1”
41. public void ensureCapacity(int minCapacity) {
42. // 将“修改统计数”+1，该变量主要是用来实现fail-fast机制的
43. modCount++;
44. int oldCapacity = elementData.length;
45. // 若当前容量不足以容纳当前的元素个数，设置 新的容量=“(原始容量x3)/2 + 1”
46. if (minCapacity > oldCapacity) {
47. Object oldData[] = elementData;
48. int newCapacity = (oldCapacity * 3)/2 + 1;
49. //如果还不够，则直接将minCapacity设置为当前容量
50. if (newCapacity < minCapacity)
51. newCapacity = minCapacity;
52. elementData = Arrays.copyOf(elementData, newCapacity);
53. }
54. }
55. // 添加元素e
56. public boolean add(E e) {
57. // 确定ArrayList的容量大小
58. ensureCapacity(size + 1);  // Increments modCount!!
59. // 添加e到ArrayList中
60. elementData[size++] = e;
61. return true;
62. }
63. // 返回ArrayList的实际大小
64. public int size() {
65. return size;
66. }
67. // ArrayList是否包含Object(o)
68. public boolean contains(Object o) {
69. return indexOf(o) >= 0;
70. }
71. //返回ArrayList是否为空
72. public boolean isEmpty() {
73. return size == 0;
74. }
75. // 正向查找，返回元素的索引值
76. public int indexOf(Object o) {
77. if (o == null) {
78. for (int i = 0; i < size; i++)
79. if (elementData[i]==null)
80. return i;
81. } else {
82. for (int i = 0; i < size; i++)
83. if (o.equals(elementData[i]))
84. return i;
85. }
86. return -1;
87. }
88. // 反向查找，返回元素的索引值
89. public int lastIndexOf(Object o) {
90. if (o == null) {
91. for (int i = size-1; i >= 0; i--)
92. if (elementData[i]==null)
93. return i;
94. } else {
95. for (int i = size-1; i >= 0; i--)
96. if (o.equals(elementData[i]))
97. return i;
98. }
99. return -1;
100. }
101. // 反向查找(从数组末尾向开始查找)，返回元素(o)的索引值
102. public int lastIndexOf(Object o) {
103. if (o == null) {
104. for (int i = size-1; i >= 0; i--)
105. if (elementData[i]==null)
106. return i;
107. } else {
108. for (int i = size-1; i >= 0; i--)
109. if (o.equals(elementData[i]))
110. return i;
111. }
112. return -1;
113. }
114. // 返回ArrayList的Object数组
115. public Object[] toArray() {
116. return Arrays.copyOf(elementData, size);
117. }
118. // 返回ArrayList元素组成的数组
119. public <T> T[] toArray(T[] a) {
120. // 若数组a的大小 < ArrayList的元素个数；
121. // 则新建一个T[]数组，数组大小是“ArrayList的元素个数”，并将“ArrayList”全部拷贝到新数组中
122. if (a.length < size)
123. return (T[]) Arrays.copyOf(elementData, size, a.getClass());
124. // 若数组a的大小 >= ArrayList的元素个数；
125. // 则将ArrayList的全部元素都拷贝到数组a中。
126. System.arraycopy(elementData, 0, a, 0, size);
127. if (a.length > size)
128. a[size] = null;
129. return a;
130. }
131. // 获取index位置的元素值
132. public E get(int index) {
133. RangeCheck(index);
134. return (E) elementData[index];
135. }
136. // 设置index位置的值为element
137. public E set(int index, E element) {
138. RangeCheck(index);
139. E oldValue = (E) elementData[index];
140. elementData[index] = element;
141. return oldValue;
142. }
143. // 将e添加到ArrayList中
144. public boolean add(E e) {
145. ensureCapacity(size + 1);  // Increments modCount!!
146. elementData[size++] = e;
147. return true;
148. }
149. // 将e添加到ArrayList的指定位置
150. public void add(int index, E element) {
151. if (index > size || index < 0)
152. throw new IndexOutOfBoundsException(
153. "Index: "+index+", Size: "+size);
154. ensureCapacity(size+1);  // Increments modCount!!
155. System.arraycopy(elementData, index, elementData, index + 1,
156. size - index);
157. elementData[index] = element;
158. size++;
159. }
160. // 删除ArrayList指定位置的元素
161. public E remove(int index) {
162. RangeCheck(index);
163. modCount++;
164. E oldValue = (E) elementData[index];
165. int numMoved = size - index - 1;
166. if (numMoved > 0)
167. System.arraycopy(elementData, index+1, elementData, index,
168. numMoved);
169. elementData[--size] = null; // Let gc do its work
170. return oldValue;
171. }
172. // 删除ArrayList的指定元素
173. public boolean remove(Object o) {
174. if (o == null) {
175. for (int index = 0; index < size; index++)
176. if (elementData[index] == null) {
177. fastRemove(index);
178. return true;
179. }
180. } else {
181. for (int index = 0; index < size; index++)
182. if (o.equals(elementData[index])) {
183. fastRemove(index);
184. return true;
185. }
186. }
187. return false;
188. }
189. // 快速删除第index个元素
190. private void fastRemove(int index) {
191. modCount++;
192. int numMoved = size - index - 1;
193. // 从"index+1"开始，用后面的元素替换前面的元素。
194. if (numMoved > 0)
195. System.arraycopy(elementData, index+1, elementData, index,
196. numMoved);
197. // 将最后一个元素设为null
198. elementData[--size] = null; // Let gc do its work
199. }
200. // 删除元素
201. public boolean remove(Object o) {
202. if (o == null) {
203. for (int index = 0; index < size; index++)
204. if (elementData[index] == null) {
205. fastRemove(index);
206. return true;
207. }
208. } else {
209. // 便利ArrayList，找到“元素o”，则删除，并返回true。
210. for (int index = 0; index < size; index++)
211. if (o.equals(elementData[index])) {
212. fastRemove(index);
213. return true;
214. }
215. }
216. return false;
217. }
218. // 清空ArrayList，将全部的元素设为null
219. public void clear() {
220. modCount++;
221. for (int i = 0; i < size; i++)
222. elementData[i] = null;
223. size = 0;
224. }
225. // 将集合c追加到ArrayList中
226. public boolean addAll(Collection<? extends E> c) {
227. Object[] a = c.toArray();
228. int numNew = a.length;
229. ensureCapacity(size + numNew);  // Increments modCount
230. System.arraycopy(a, 0, elementData, size, numNew);
231. size += numNew;
232. return numNew != 0;
233. }
234. // 从index位置开始，将集合c添加到ArrayList
235. public boolean addAll(int index, Collection<? extends E> c) {
236. if (index > size || index < 0)
237. throw new IndexOutOfBoundsException(
238. "Index: " + index + ", Size: " + size);
239. Object[] a = c.toArray();
240. int numNew = a.length;
241. ensureCapacity(size + numNew);  // Increments modCount
242. int numMoved = size - index;
243. if (numMoved > 0)
244. System.arraycopy(elementData, index, elementData, index + numNew,
245. numMoved);
246. System.arraycopy(a, 0, elementData, index, numNew);
247. size += numNew;
248. return numNew != 0;
249. }
250. // 删除fromIndex到toIndex之间的全部元素。
251. protected void removeRange(int fromIndex, int toIndex) {
252. modCount++;
253. int numMoved = size - toIndex;
254. System.arraycopy(elementData, toIndex, elementData, fromIndex,
255. numMoved);
256. // Let gc do its work
257. int newSize = size - (toIndex-fromIndex);
258. while (size != newSize)
259. elementData[--size] = null;
260. }
261. private void RangeCheck(int index) {
262. if (index >= size)
263. throw new IndexOutOfBoundsException(
264. "Index: "+index+", Size: "+size);
265. }
266. // 克隆函数
267. public Object clone() {
268. try {
269. ArrayList<E> v = (ArrayList<E>) super.clone();
270. // 将当前ArrayList的全部元素拷贝到v中
271. v.elementData = Arrays.copyOf(elementData, size);
272. v.modCount = 0;
273. return v;
274. } catch (CloneNotSupportedException e) {
275. // this shouldn't happen, since we are Cloneable
276. throw new InternalError();
277. }
278. }
279. // java.io.Serializable的写入函数
280. // 将ArrayList的“容量，所有的元素值”都写入到输出流中
281. private void writeObject(java.io.ObjectOutputStream s)
282. throws java.io.IOException{
283. // Write out element count, and any hidden stuff
284. int expectedModCount = modCount;
285. s.defaultWriteObject();
286. // 写入“数组的容量”
287. s.writeInt(elementData.length);
288. // 写入“数组的每一个元素”
289. for (int i=0; i<size; i++)
290. s.writeObject(elementData[i]);
291. if (modCount != expectedModCount) {
292. throw new ConcurrentModificationException();
293. }
294. }
295. // java.io.Serializable的读取函数：根据写入方式读出
296. // 先将ArrayList的“容量”读出，然后将“所有的元素值”读出
297. private void readObject(java.io.ObjectInputStream s)
298. throws java.io.IOException, ClassNotFoundException {
299. // Read in size, and any hidden stuff
300. s.defaultReadObject();
301. // 从输入流中读取ArrayList的“容量”
302. int arrayLength = s.readInt();
303. Object[] a = elementData = new Object[arrayLength];
304. // 从输入流中将“所有的元素值”读出
305. for (int i=0; i<size; i++)
306. a[i] = s.readObject();
307. }
308. }

几点总结

关于ArrayList的源码，给出几点比较重要的总结：

1、注意其三个不同的构造方法。无参构造方法构造的ArrayList的容量默认为10，带有Collection参数的构造方法，将Collection转化为数组赋给ArrayList的实现数组elementData。

2、注意扩充容量的方法ensureCapacity。ArrayList在每次增加元素（可能是1个，也可能是一组）时，都要调用该方法来确保足够的容量。当容量不足以容纳当前的元素个数时，就设置新的容量为旧的容量的1.5倍加1，如果设置后的新容量还不够，则直接新容量设置为传入的参数（也就是所需的容量），而后用Arrays.copyof()方法将元素拷贝到新的数组（详见下面的第3点）。从中可以看出，当容量不够时，每次增加元素，都要将原来的元素拷贝到一个新的数组中，非常之耗时，也因此建议在事先能确定元素数量的情况下，才使用ArrayList，否则建议使用LinkedList。

3、ArrayList的实现中大量地调用了Arrays.copyof()和System.arraycopy()方法。我们有必要对这两个方法的实现做下深入的了解。

首先来看Arrays.copyof()方法。它有很多个重载的方法，但实现思路都是一样的，我们来看泛型版本的源码：

1. public static <T> T[] copyOf(T[] original, int newLength) {
2. return (T[]) copyOf(original, newLength, original.getClass());
3. }

很明显调用了另一个copyof方法，该方法有三个参数，最后一个参数指明要转换的数据的类型，其源码如下：

1. public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
2. T[] copy = ((Object)newType == (Object)Object[].class)
3. ? (T[]) new Object[newLength]
4. : (T[]) Array.newInstance(newType.getComponentType(), newLength);
5. System.arraycopy(original, 0, copy, 0,
6. Math.min(original.length, newLength));
7. return copy;
8. }

这里可以很明显地看出，该方法实际上是在其内部又创建了一个长度为newlength的数组，调用System.arraycopy()方法，将原来数组中的元素复制到了新的数组中。

下面来看System.arraycopy()方法。该方法被标记了native，调用了系统的C/C++代码，在JDK中是看不到的，但在openJDK中可以看到其源码。该函数实际上最终调用了C语言的memmove()函数，因此它可以保证同一个数组内元素的正确复制和移动，比一般的复制方法的实现效率要高很多，很适合用来批量处理数组。Java强烈推荐在复制大量数组元素时用该方法，以取得更高的效率。

4、注意ArrayList的两个转化为静态数组的toArray方法。

第一个，Object[] toArray()方法。该方法有可能会抛出java.lang.ClassCastException异常，如果直接用向下转型的方法，将整个ArrayList集合转变为指定类型的Array数组，便会抛出该异常，而如果转化为Array数组时不向下转型，而是将每个元素向下转型，则不会抛出该异常，显然对数组中的元素一个个进行向下转型，效率不高，且不太方便。

第二个，<T> T[] toArray(T[] a)方法。该方法可以直接将ArrayList转换得到的Array进行整体向下转型（转型其实是在该方法的源码中实现的），且从该方法的源码中可以看出，参数a的大小不足时，内部会调用Arrays.copyOf方法，该方法内部创建一个新的数组返回，因此对该方法的常用形式如下：

1. public static Integer[] vectorToArray2(ArrayList<Integer> v) {
2. Integer[] newText = (Integer[])v.toArray(new Integer[0]);
3. return newText;
4. }

5、ArrayList基于数组实现，可以通过下标索引直接查找到指定位置的元素，因此查找效率高，但每次插入或删除元素，就要大量地移动元素，插入删除元素的效率低。

6、在查找给定元素索引值等的方法中，源码都将该元素的值分为null和不为null两种情况处理，ArrayList中允许元素为null。

本篇博文参加了CSDN博文大赛，如果您觉得这篇博文不错，希望您能帮我投一票，谢谢！

投票地址：http://vote.blog.csdn.net/Article/Details?articleid=35568011