给jdk写注释系列之jdk1.6容器(1)-ArrayList

  工作中经常听到别人讲“容器”,各种各样的容器,话说到底什么是容器,通俗的讲“容器就是用来装东西的器皿,比如:水桶就是用来盛水的,水桶就是一个容器。”

ok,在我们写程序的时候常常要对大量的对象进行管理,比如查询,遍历,修改等。jdk为我们提供的容器位于java.util包,也是我们平时用的最多的包之一。

但是为什么不用数组(其实也不是不用,只是不直接用)呢,因为数组的长度需要提前确定,而且不能改变大小,用起来手脚受限嘛。

下面步入正题,首先我们想,一个对象管理容器需要哪些功能?增加,删除,修改,查询(crud对不对?)还有呢?遍历,容量,是否包含某个元素。。。

功能是有了,如果让你自己实现一个这样的容器该怎么实现呢?

我们看看ArrayList是怎么实现这些功能的。

1.底层存储

  顾名思义哈,ArrayList就是用数组实现的List容器,既然是用数组实现,当然底层用数组来保存数据啦。。。

1 private transient Object[] elementData;
2 private int size;

  可以看到用一个Object数组来存储数据,用一个int值来计数,记录当前容器的数据大小。

  另外,细心的人会发现elementData数组是使用transient修饰的,关于transient关键字的作用简单说就是java自带默认机制进行序列化的时候,被其修饰的属性不需要维持。会不会产生一点疑问?elementData不需要维持,那么怎么进行反序列化,又怎么保证序列化和反序列化数据的正确性?难道不需要存储?用大腿想一下那当然是不可以的嘛,既然需要存储,它是怎么实现的呢?注意上面红色加粗的地方,默认序列化机制,嗯哼想明白了ArrayList一定是使用了自定义的序列化方式,到底是不是这样的呢?看下面两个方法:

 1   /**
 2      * Save the state of the <tt>ArrayList</tt> instance to a stream (that
 3      * is, serialize it).
 4      *
 5      * @serialData The length of the array backing the <tt>ArrayList </tt>
 6      *             instance is emitted (int), followed by all of its elements
 7      *             (each an <tt>Object</tt> ) in the proper order.
 8      */
 9     private void writeObject(java.io.ObjectOutputStream s)
10         throws java.io.IOException{
11         // Write out element count, and any hidden stuff
12         int expectedModCount = modCount ;
13        s.defaultWriteObject();
14
15         // Write out array length
16         s.writeInt( elementData.length );
17
18         // Write out all elements in the proper order.
19         for (int i=0; i<size; i++)
20             s.writeObject( elementData[i]);
21
22         if (modCount != expectedModCount) {
23             throw new ConcurrentModificationException();
24         }
25
26     }
27
28     /**
29      * Reconstitute the <tt>ArrayList</tt> instance from a stream (that is,
30      * deserialize it).
31      */
32     private void readObject(java.io.ObjectInputStream s)
33         throws java.io.IOException, ClassNotFoundException {
34         // Read in size, and any hidden stuff
35        s.defaultReadObject();
36
37         // Read in array length and allocate array
38         int arrayLength = s.readInt();
39         Object[] a = elementData = new Object[arrayLength];
40
41         // Read in all elements in the proper order.
42         for (int i=0; i<size; i++)
43             a[i] = s.readObject();
44     }

  英语注释很详细,也很容易读懂,就不进行翻译了。那么想一下为什么要这样设计呢,岂不是很麻烦。下面简单进行解释下:

  elementData 是一个数据存储数组,而数组是定长的,它会初始化一个容量,等容量不足时再扩充容量(扩容方式为数据拷贝,后面会详细解释),再通俗一点说就是比如elementData 的长度是10,而里面只保存了3个对象,那么数组中其余的7个元素(null)是没有意义的,所以也就不需要保存,以节省序列化后的内存容量,好了到这里就明白了这样设计的初衷和好处,顺便好像也明白了长度单独用一个int变量保存,而不是直接使用elementData.length的原因。

2.构造方法

 1     /**
 2      * 构造一个具有指定容量的list
 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      * 构造一个初始容量为10的list
14      */
15     public ArrayList() {
16         this(10);
17     }
18
19     /**
20      * 构造一个包含指定元素的list,这些元素的是按照Collection的迭代器返回的顺序排列的
21      */
22     public ArrayList(Collection<? extends E> c) {
23         elementData = c.toArray();
24         size = elementData .length;
25         // c.toArray might (incorrectly) not return Object[] (see 6260652)
26         if (elementData .getClass() != Object[].class)
27            elementData = Arrays.copyOf( elementData, size , Object[].class);
28     }

  构造方法看完了,想一下指定容量的构造方法的意义,既然默认为10就可以那么为什么还要提供一个可以指定容量大小的构造方法呢?在这里说好像有点太早,那就卖个关子,下面再说。。。

 

3.增加

 1     /**
 2      * 添加一个元素
 3      */
 4     public boolean add(E e) {
 5        // 进行扩容检查
 6        ensureCapacity( size + 1);  // Increments modCount
 7        // 将e增加至list的数据尾部,容量+1
 8         elementData[size ++] = e;
 9         return true;
10     }
11
12     /**
13      * 在指定位置添加一个元素
14      */
15     public void add(int index, E element) {
16         // 判断索引是否越界,这里会抛出多么熟悉的异常。。。
17         if (index > size || index < 0)
18            throw new IndexOutOfBoundsException(
19                "Index: "+index+", Size: " +size);
20
21        // 进行扩容检查
22        ensureCapacity( size+1);  // Increments modCount
23        // 对数组进行复制处理,目的就是空出index的位置插入element,并将index后的元素位移一个位置
24        System. arraycopy(elementData, index, elementData, index + 1,
25                       size - index);
26        // 将指定的index位置赋值为element
27         elementData[index] = element;
28        // list容量+1
29         size++;
30     }
31     /**
32      * 增加一个集合元素
33      */
34     public boolean addAll(Collection<? extends E> c) {
35        //将c转换为数组
36        Object[] a = c.toArray();
37         int numNew = a.length ;
38        //扩容检查
39        ensureCapacity( size + numNew);  // Increments modCount
40        //将c添加至list的数据尾部
41         System. arraycopy(a, 0, elementData, size, numNew);
42        //更新当前容器大小
43         size += numNew;
44         return numNew != 0;
45     }
46     /**
47      * 在指定位置,增加一个集合元素
48      */
49     public boolean addAll(int index, Collection<? extends E> c) {
50         if (index > size || index < 0)
51            throw new IndexOutOfBoundsException(
52                "Index: " + index + ", Size: " + size);
53
54        Object[] a = c.toArray();
55         int numNew = a.length ;
56        ensureCapacity( size + numNew);  // Increments modCount
57
58        // 计算需要移动的长度
59         int numMoved = size - index;
60        // 数组复制,空出第index到index+numNum个位置
61         if (numMoved > 0)
62            System. arraycopy(elementData, index, elementData, index + numNew,
63                           numMoved);
64
65        // 将要插入的集合元素复制到数组空出的位置中
66         System. arraycopy(a, 0, elementData, index, numNew);
67         size += numNew;
68         return numNew != 0;
69     }
70
71     /**
72      * 数组容量检查,不够时则进行扩容
73      */
74    public void ensureCapacity( int minCapacity) {
75         modCount++;
76        // 当前数组的长度
77         int oldCapacity = elementData .length;
78        // 最小需要的容量大于当前数组的长度则进行扩容
79         if (minCapacity > oldCapacity) {
80            Object oldData[] = elementData;
81           // 新扩容的数组长度为旧容量的1.5倍+1
82            int newCapacity = (oldCapacity * 3)/2 + 1;
83           // 如果新扩容的数组长度还是比最小需要的容量小,则以最小需要的容量为长度进行扩容
84            if (newCapacity < minCapacity)
85               newCapacity = minCapacity;
86             // minCapacity is usually close to size, so this is a win:
87             // 进行数据拷贝,Arrays.copyOf底层实现是System.arrayCopy()
88             elementData = Arrays.copyOf( elementData, newCapacity);
89        }
90     }

4.删除

 1     /**
 2      * 根据索引位置删除元素
 3      */
 4     public E remove( int index) {
 5       // 数组越界检查
 6        RangeCheck(index);
 7
 8         modCount++;
 9       // 取出要删除位置的元素,供返回使用
10        E oldValue = (E) elementData[index];
11        // 计算数组要复制的数量
12         int numMoved = size - index - 1;
13        // 数组复制,就是将index之后的元素往前移动一个位置
14         if (numMoved > 0)
15            System. arraycopy(elementData, index+1, elementData, index,
16                           numMoved);
17        // 将数组最后一个元素置空(因为删除了一个元素,然后index后面的元素都向前移动了,所以最后一个就没用了),好让gc尽快回收
18        // 不要忘了size减一
19         elementData[--size ] = null; // Let gc do its work
20
21         return oldValue;
22     }
23
24     /**
25      * 根据元素内容删除,只删除匹配的第一个
26      */
27     public boolean remove(Object o) {
28        // 对要删除的元素进行null判断
29        // 对数据元素进行遍历查找,知道找到第一个要删除的元素,删除后进行返回,如果要删除的元素正好是最后一个那就惨了,时间复杂度可达O(n) 。。。
30         if (o == null) {
31             for (int index = 0; index < size; index++)
32               // null值要用==比较
33                if (elementData [index] == null) {
34                   fastRemove(index);
35                   return true;
36               }
37        } else {
38            for (int index = 0; index < size; index++)
39               // 非null当然是用equals比较了
40                if (o.equals(elementData [index])) {
41                   fastRemove(index);
42                   return true;
43               }
44         }
45         return false;
46     }
47
48     /*
49      * Private remove method that skips bounds checking and does not
50      * return the value removed.
51      */
52     private void fastRemove(int index) {
53         modCount++;
54        // 原理和之前的add一样,还是进行数组复制,将index后的元素向前移动一个位置,不细解释了,
55         int numMoved = size - index - 1;
56         if (numMoved > 0)
57             System. arraycopy(elementData, index+1, elementData, index,
58                              numMoved);
59         elementData[--size ] = null; // Let gc do its work
60     }
61
62     /**
63      * 数组越界检查
64      */
65     private void RangeCheck(int index) {
66         if (index >= size )
67            throw new IndexOutOfBoundsException(
68                "Index: "+index+", Size: " +size);
69     }

  PS:看到了这个方法,便可jdk源码有些地方写的也不是那么精巧,比如这里remove时将数组越界检查封装成了一个单独方法,可是往前翻一下add方法中的数组越界就没有进行封装,需要检查的时候都是写一遍一样的代码,why啊。。。

  增加和删除方法到这里就解释完了,代码是很简单,主要需要特别关心的就两个地方:1.数组扩容,2.数组复制,这两个操作都是极费效率的,最惨的情况下(添加到list第一个位置,删除list最后一个元素或删除list第一个索引位置的元素)时间复杂度可达O(n)。

  还记得上面那个坑吗(为什么提供一个可以指定容量大小的构造方法 )?看到这里是不是有点明白了呢,简单解释下:如果数组初试容量过小,假设默认的10个大小,而我们使用ArrayList的主要操作时增加元素,不断的增加,一直增加,不停的增加,会出现上面后果?那就是数组容量不断的受挑衅,数组需要不断的进行扩容,扩容的过程就是数组拷贝System.arraycopy的过程,每一次扩容就会开辟一块新的内存空间和数据的复制移动,这样势必对性能造成影响。那么在这种以写为主(写会扩容,删不会缩容)场景下,提前预知性的设置一个大容量,便可减少扩容的次数,提高了性能。

待续。。。

时间: 2024-11-08 23:24:56

给jdk写注释系列之jdk1.6容器(1)-ArrayList的相关文章

给jdk写注释系列之jdk1.6容器(13)-总结篇之Java集合与数据结构

是的,这篇blogs是一个总结篇,最开始的时候我提到过,对于java容器或集合的学习也可以看做是对数据结构的学习与应用.在前面我们分析了很多的java容器,也接触了好多种常用的数据结构,今天我们就来总结下这些内容. 下面我们以数据结构的维度来总结下,在Java集合的实现过程中,底层到底使用了哪些常用的数据结构中,他们分别又有什么特点.      1. 数组(Array) 结构说明:在程序设计中,为了处理方便, 把具有相同类型的若干变量按有序的形式组织起来.这些按序排列的同类数据元素的集合称为数组

给jdk写注释系列之jdk1.6容器(10)-Stack&amp;Vector源码解析

前面我们已经接触过几种数据结构了,有数组.链表.Hash表.红黑树(二叉查询树),今天再来看另外一种数据结构:栈. 什么是栈呢,我就不找它具体的定义了,直接举个例子,栈就相当于一个很窄的木桶,我们往木桶里放东西,往外拿东西时会发现,我们最开始放的东西在最底部,最先拿出来的是刚刚放进去的.所以,栈就是这么一种先进后出( First In Last Out,或者叫后进先出) 的容器,它只有一个口,在这个口放入元素,也在这个口取出元素. 栈最主要了两个动作就是入栈和出栈操作,其实还是很容易的明白的对不

给jdk写注释系列之jdk1.6容器(12)-PriorityQueue源码解析

PriorityQueue是一种什么样的容器呢?看过前面的几个jdk容器分析的话,看到Queue这个单词你一定会,哦~这是一种队列.是的,PriorityQueue是一种队列,但是它又是一种什么样的队列呢?它具有着什么样的特点呢?它的底层实现方式又是怎么样的呢?我们一起来看一下. PriorityQueue其实是一个优先队列,什么是优先队列呢?这和我们前面讲的先进先出(First In First Out )的队列的区别在于,优先队列每次出队的元素都是优先级最高的元素.那么怎么确定哪一个元素的优

给jdk写注释系列之jdk1.6容器(6)-HashSet源码解析&amp;Map迭代器

今天的主角是HashSet,Set是什么东东,当然也是一种java容器了. 现在再看到Hash心底里有没有会心一笑呢,这里不再赘述hash的概念原理等一大堆东西了(不懂得需要先回去看下HashMap了),需要在啰嗦一句的是hash表是基于快速存取的角度设计的,也是一种典型的空间换时间的做法(这个在分析HashMap中都有讲过).那么今天的HashSet它又是怎么一回事的,他的存在又是为了解决什么问题呢? 先来看下Set的特点:Set元素无顺序,且元素不可以重复. .想到了什么?无顺序,由于散列的

给jdk写注释系列之jdk1.6容器(1):ArrayList源码解析

原文出自吞噬天地,链接整理自ImportNew 给jdk写注释系列之jdk1.6容器(2):LinkedList源码解析 给jdk写注释系列之jdk1.6容器(3):Iterator设计模式 给jdk写注释系列之jdk1.6容器(4)-HashMap源码解析 给jdk写注释系列之jdk1.6容器(5)-LinkedHashMap源码解析 给jdk写注释系列之jdk1.6容器(6)-HashSet源码解析&Map迭代器 给jdk写注释系列之jdk1.6容器(1):ArrayList源码解析 工作中

给jdk写注释系列之jdk1.6容器(2)-LinkedList源码解析

LinkedList是基于链表结构的一种List,在分析LinkedList源码前有必要对链表结构进行说明. 1.链表的概念 链表是由一系列非连续的节点组成的存储结构,简单分下类的话,链表又分为单向链表和双向链表,而单向/双向链表又可以分为循环链表和非循环链表,下面简单就这四种链表进行图解说明.           1.1.单向链表 单向链表就是通过每个结点的指针指向下一个结点从而链接起来的结构,最后一个节点的next指向null.      1. 2.单向循环链表           单向循环

给jdk写注释系列之jdk1.6容器(5)-LinkedHashMap源码解析

前面分析了HashMap的实现,我们知道其底层数据存储是一个hash表(数组+单向链表).接下来我们看一下另一个LinkedHashMap,它是HashMap的一个子类,他在HashMap的基础上维持了一个双向链表(hash表+双向链表),在遍历的时候可以使用插入顺序(先进先出,类似于FIFO),或者是最近最少使用(LRU)的顺序. 来具体看下LinkedHashMap的实现. 1.定义  1 public class LinkedHashMap<K,V> 2 extends HashMap&

JDK源代码学习系列04----ArrayList

                                                                         JDK源代码学习系列04----ArrayList 1.ArrayList简单介绍 ArrayList是基于Object[] 数组的,也就是我们常说的动态数组.它能非常方便的实现数组的添加删除等操作. public class ArrayList<E> extends AbstractList<E> implements List<

为什么写注释必须成为编码的硬性标准(双语原创)

为什么写注释必须成为编码的硬性标准(双语原创) Why Writing Annotation Must Become Peremptory Rule? 程序猿最烦的事:别人的代码不写注释:自己写注释. Parodox: It is most hated for programmers that others'code have not annotations, and oneself must write annotations. 1.注释最主要是给别人看的,供自己回顾是锦上添花 理解一个人的思