java集合类源码分析之List（一）

　　首先分析一下集合与数组的区别：1.java中的数组一般用于存储基本数据类型，而且是静态的，即长度固定不变，这就不适用于元素个数未知的情况；2.集合只能用于存储引用类型，并且长度可变，适用于大多数情况，可用toArray()方法转换成数组。

java语言提供了多种集合类的接口，如List、Set、Map等。其中，List接口继承自Collection，它的实现类有ArrayList、LinkedList、Vector（Stack），下面就从它们的源代码开始：

1.ArrayList（数组列表）

顾名思义，这是一种以数组形式进行存储的列表，所以其优点是便于随机访问，而在插入和删除操作时效率较低。

• 构造方法（三种）：

1.public ArrayList(int initialCapacity)　　指定初始列表的容量，当容量不够时会自动进行扩容

2.public ArrayList()　　空的构造方法

3.public ArrayList(Collection<? extends E> c)　　初始化列表元素，传入参数为一个集合类的对象

        ArrayList<String> arrayList1 = new ArrayList<String>(3);    //初始化ArrayList容量大小
        arrayList1.add("A");
        arrayList1.add("B");
        arrayList1.add("C");
        ArrayList<String> arrayList2 = new ArrayList<String>(arrayList1);    //初始化ArrayList元素
        System.out.println(arrayList2);    //[A, B, C]

• 插入元素（add）

1.在列表尾部插入 add(E e)

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

2.在列表指定位置插入 add(int index, E element)

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

3.在列表尾部插入一个子集 addAll(Collection<? extends E> c)

    public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }

4.在列表的指定位置插入一个子集 addAll(int index, Collection<? extends E> c)

    public boolean addAll(int index, Collection<? extends E> c) {
        rangeCheckForAdd(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount

        int numMoved = size - index;
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }

观察源码可知，在指定位置插入元素其实是通过arraycopy()方法来实现的，即是将原数组复制到目标数组，因而效率较低。

应用示例：

        ArrayList<String> arrayList1 = new ArrayList<String>(3);    //初始化ArrayList容量大小
        arrayList1.add("A");
        arrayList1.add("B");
        arrayList1.add("C");
        arrayList1.add("D");
        System.out.println(arrayList1);    //[A, B, C, D]
        arrayList1.add(0, "E");
        System.out.println(arrayList1); //[E, A, B, C, D]

• 查找元素

1.查找指定位置的元素 get(int index)

2.查找指定元素的位置 indexOf(Object o)、lastIndexOf(Object o)

3.查找列表中是否包含指定元素 contains(Object o)

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

由于ArrayList以数组方式实现，自带索引，所以便于随机查找。

• 修改元素

修改指定位置的元素 set(int index, E element)

        ArrayList<String> arrayList1 = new ArrayList<String>(3);    //初始化ArrayList容量大小
        arrayList1.add("A");
        arrayList1.add("B");
        arrayList1.add("C");
        arrayList1.add("D");
        System.out.println(arrayList1); //[A, B, C, D]
        arrayList1.set(0, "X");
        System.out.println(arrayList1); //[X, B, C, D]

由于ArrayList以数组方式实现，自带索引，所以便于随机修改。

• 删除元素

1.删除指定位置的元素 remove(int index)

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

        modCount++;
        E oldValue = elementData(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

        return oldValue;
    }

2.删除指定元素 remove(Object o)

    public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

3.清空列表 clear()

    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

从源码中我们可以知道，删除元素时也是通过arraycopy()方法，将原数组复制到目标数组，因而效率较低。

应用示例：

        ArrayList<String> arrayList1 = new ArrayList<String>(3);    //初始化ArrayList容量大小
        arrayList1.add("A");
        arrayList1.add("B");
        arrayList1.add("C");
        arrayList1.add("D");
        arrayList1.remove(0);
        System.out.println(arrayList1);    //[B, C, D]
        arrayList1.remove("D");
        System.out.println(arrayList1);    //[B, C]
        arrayList1.clear();
        System.out.println(arrayList1.isEmpty());    //true

 2.LinkedList（链接列表）

顾名思义，以链表的方式来实现List接口，其优点是便于元素插入和删除，而在随机访问时效率较低。此外LinkedList提供额外的get，remove，insert方法操作 LinkedList的首部或尾部。这些操作使LinkedList可被用作堆栈（stack），队列（queue）或双向队列（deque）。

• 存储节点的基本定义（静态内部类实现）

    private static class Node<E> {
        E item;
        Node<E> next;
        Node<E> prev;

        Node(Node<E> prev, E element, Node<E> next) {
            this.item = element;
            this.next = next;
            this.prev = prev;
        }
    }

• 构造方法（两种）

1. public LinkedList()　　空的构造方法

2.public LinkedList(Collection<? extends E> c)　　初始化列表元素，传入参数为一个集合类的对象

• 插入元素

1.addFirst(E e) 在列表的头部插入

2.addLast(E e)、add(E e) 在列表的尾部插入

3.add(int index, E element) 在列表的指定位置插入

4.addAll(Collection<? extends E> c) 在列表的尾部插入一个子集

5.addAll(int index, Collection<? extends E> c) 在列表的指定位置插入一个子集

应用示例：

        LinkedList<Integer> linkedList = new LinkedList<Integer>();
        LinkedList<Integer> linkedList2 = new LinkedList<Integer>();
        linkedList.add(100);
        linkedList.add(120);
        linkedList.add(105);
                System.out.println(linkedList);//[100, 120, 105]
        linkedList.add(200);
        System.out.println(linkedList);//[100, 120, 105, 200]
        linkedList.add(0, 300);
        System.out.println(linkedList);//[300, 100, 120, 105, 200]
        linkedList.addFirst(400);
        System.out.println(linkedList);//[400, 300, 100, 120, 105, 200]
        linkedList.addLast(500);
        System.out.println(linkedList);//[400, 300, 100, 120, 105, 200, 500]
        
        linkedList2.addAll(linkedList);
        System.out.println(linkedList2);//[400, 300, 100, 120, 105, 200, 500]
        linkedList2.addAll(0, linkedList);
        System.out.println(linkedList2);//[400, 300, 100, 120, 105, 200, 500, 400, 300, 100, 120, 105, 200, 500]

由于LinkedList以链表方式实现，所以在插入元素时只需要修改指针(前驱节点和后继节点)即可，因而效率较高。

• 查找元素

1.getFirst() 返回列表头部元素

2.getLast() 返回列表尾部元素

3.get(int index) 返回列表指定位置的元素

4.indexOf(Object o) 返回指定元素首次出现的位置

5.lastIndexOf(Object o) 返回指定元素最后一次出现的位置

应用示例：

        System.out.println(linkedList);//[400, 300, 100, 120, 105, 200, 500]
                System.out.println(linkedList.getFirst());//400
        System.out.println(linkedList.getLast());//500
        System.out.println(linkedList.get(3));//120
        System.out.println(linkedList.indexOf(120));//3;
        System.out.println(linkedList.lastIndexOf(120));//3

由于链表实现的列表没有索引，所以查找指定位置的元素只能通过不断遍历来实现，因而效率低下。

• 修改元素

1.set(int index, E element) 修改指定位置的元素

    public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    }

同样首先需要遍历找到指定元素，然后进行修改，效率低下。

• 删除元素

1.removeFirst() 删除列表头部元素

2.removeLast() 删除列表尾部元素

3.remove(Object o) 删除指定元素

4.remove(int index) 删除指定位置的元素

应用示例：

        System.out.println(linkedList);//[400, 300, 100, 120, 105, 200, 500]
        System.out.println(linkedList.removeFirst());//400
        System.out.println(linkedList.removeLast());//500
        System.out.println(linkedList.remove(3));//105
        System.out.println(linkedList.remove(new Integer("300")));//true

由于链接的实现方式，删除元素只需要修改指针（前驱节点和后继节点）即可，因而效率较高。

3.Vector（Stack）向量

Vector与ArrayList用法类似，并且也是以数组方式实现的，但它消耗的内存资源比ArrayList多，因而常常用于大量数据的存储，并且Vector是线程安全的。Stack（栈）是Vector的一个子类，具有后进先出的特性。

• 构造方法（四种）

1.Vector(int initialCapacity, int capacityIncrement) 指定初始容量以及扩容的大小

    public Vector(int initialCapacity, int capacityIncrement) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
        this.capacityIncrement = capacityIncrement;
    }

2.Vector(int initialCapacity) 指定初始容量

3.Vector() 空的构造器

4.Vector(Collection<? extends E> c) 初始化向量元素，参数为一个集合类的对象

应用示例：

        Vector<Integer> vector1 = new Vector<Integer>();
        vector1.add(100);
        vector1.add(102);
        Vector<Integer> vector2 = new Vector<Integer>(6);
        Vector<Integer> vector3 = new Vector<Integer>(6, 3);
        Vector<Integer> vector4 = new Vector<Integer>(vector1);
        System.out.println(vector4); //[100, 102]

• 插入元素

1.addElement(E obj)、add(E e) 在向量尾部插入指定元素

2.add(int index, E element)、insertElementAt(E obj, int index) 在指定位置插入元素

    public synchronized void insertElementAt(E obj, int index) {
        modCount++;
        if (index > elementCount) {
            throw new ArrayIndexOutOfBoundsException(index
                                                     + " > " + elementCount);
        }
        ensureCapacityHelper(elementCount + 1);
        System.arraycopy(elementData, index, elementData, index + 1, elementCount - index);
        elementData[index] = obj;
        elementCount++;
    }

3.addAll(Collection<? extends E> c) 在向量尾部插入一个子集

4.addAll(int index, Collection<? extends E> c) 在向量的指定位置插入一个子集

    public synchronized boolean addAll(int index, Collection<? extends E> c) {
        modCount++;
        if (index < 0 || index > elementCount)
            throw new ArrayIndexOutOfBoundsException(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityHelper(elementCount + numNew);

        int numMoved = elementCount - index;
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        elementCount += numNew;
        return numNew != 0;
    }

与ArrayList类似，在指定位置插入是通过arraycopy()方法实现的，即是将原数组复制到目标数组，因而效率较低。

将泛型参数类型设置为Object，就可以插入不同类型的数据：

        Vector<Object> vec = new Vector<>();
        vec.add(100);
        vec.add(new Integer(120));
        vec.add("hello");
        vec.add(true);
        System.out.println(vec);//[100, 120, hello, true]
        //若要还原向量中的元素类型，需要进行强制类型转换
        System.out.println((int)vec.get(1)+100);//220
        System.out.println(100+(int)vec.get(0));//200

• 查询元素

1.contains(Object o) 查询是否包含指定元素

2.indexOf(Object o) 返回指定元素首次出现的位置

3.indexOf(Object o, int index) 返回从index开始的指定元素首次出现的位置

4.elementAt(int index) 返回指定位置的元素

5.firstElement() 返回响向量的第一个元素

6.lastElement() 返回向量的最后一个元素

7.get(int index) 返回指定位置的元素

8.subList(int fromIndex, int toIndex) 返回指定位置的子序列

由于Vector使用数组实现，自带索引，因此在查询时效率较高。

• 修改元素

1.set(int index, E element) 修改指定位置的元素

2.setElementAt(E obj, int index) 修改指定位置的元素

应用示例：

        System.out.println(vector4); //[100, 102, 200]
        
        vector4.set(0, 500);
        System.out.println(vector4);//[500, 102, 200]
        vector4.setElementAt(300, 1);
        System.out.println(vector4);//[500, 300, 200]

• 删除元素

1.removeElement(Object obj)、remove(Object o) 删除首次出现的指定元素

2.removeAllElements() 清空向量的所有元素

3.remove(int index) 删除指定位置的元素

4.removeAll(Collection<?> c) 删除向量中出现的集合c中的元素

5.removeElementAt(int index) 删除指定位置的元素

应用示例:

        System.out.println(vector4);//[500, 300, 200]
        
        vector4.removeAll(vector1);
        System.out.println(vector4);//[500, 300]
        vector4.removeAllElements();

与ArrayList类似，删除指定位置的元素时也是将原数组复制到目标数组实现的。

• Stack（栈）

前面说过Stack是Vector的一个子类，可以调用其父类的大部分成员方法，这里只介绍Stack自身的一些成员方法：

1.public Stack() 空的构造器

2.E push(E item) 将一个元素压入栈顶

3.E pop() 返回栈顶元素，并将该元素移除

4.E peek() 返回栈顶元素，而并不将其移除

5.empty() 判断栈是否为空

6.search(Object o) 搜索栈中的元素，返回值为该元素在栈中的位置（从1开始计数，自上而下）

        Stack<Integer> stack = new Stack<Integer>();
        stack.push(100);
        stack.push(200);
        stack.push(300);
        System.out.println(stack.peek());//300
        System.out.println(stack.size());//3
        System.out.println(stack.pop());//300
        System.out.println(stack.size());//2
        stack.push(100);
        stack.push(200);
        stack.push(300);
        System.out.println(stack);//[100, 200, 100, 200, 300]
        System.out.println(stack.search(100));//3

至此，List集合的几个实现类基本介绍完毕，下一节将分析这几个实现类的区别。