Java - LinkedList源碼分析

標籤：public   stat   poll   http   關係   one   問題   pre   dal   

java提高篇(二二)---LinkedList

 

一、概述

      LinkedList與ArrayList一樣實現List介面，只是ArrayList是List介面的大小可變數組的實現，LinkedList是List介面鏈表的實現。基於鏈表實現的方式使得LinkedList在插入和刪除時更優於ArrayList，而隨機訪問則比ArrayList遜色些。

      LinkedList實現所有可選的列表操作，並允許所有的元素包括null。

      除了實現 List 介面外，LinkedList 類還為在列表的開頭及結尾 get、remove 和 insert 元素提供了統一的命名方法。這些操作允許將連結清單用作堆棧、隊列或雙端隊列。

      此類實現 Deque 介面，為 add、poll 提供先進先出隊列操作，以及其他堆棧和雙端隊列操作。

      所有操作都是按照雙重連結清單的需要執行的。在列表中編索引的操作將從開頭或結尾遍曆列表（從靠近指定索引的一端）。

      同時，與ArrayList一樣此實現不是同步的。

      （以上摘自JDK 6.0 API）。

二、源碼分析      2.1、定義

      首先我們先看LinkedList的定義：

public class LinkedList<E>    extends AbstractSequentialList<E>    implements List<E>, Deque<E>, Cloneable, java.io.Serializable

      從這段代碼中我們可以清晰地看出LinkedList繼承AbstractSequentialList，實現List、Deque、Cloneable、Serializable。其中AbstractSequentialList提供了 List 介面的骨幹實現，從而最大限度地減少了實現受“連續訪問”資料存放區（如連結清單）支援的此介面所需的工作,從而以減少實現List介面的複雜度。Deque一個線性 collection，支援在兩端插入和移除元素，定義了雙端隊列的操作。

2.2、屬性

      在LinkedList中提供了兩個基本屬性size、header。

private transient Entry<E> header = new Entry<E>(null, null, null);private transient int size = 0;

其中size表示的LinkedList的大小，header表示鏈表的表頭，Entry為節點對象。

private static class Entry<E> {        E element;        //元素節點        Entry<E> next;    //下一個元素        Entry<E> previous;  //上一個元素        Entry(E element, Entry<E> next, Entry<E> previous) {            this.element = element;            this.next = next;            this.previous = previous;        }    }

上面為Entry對象的原始碼，Entry為LinkedList的內部類，它定義了儲存的元素。該元素的前一個元素、後一個元素，這是典型的雙向鏈表定義方式。

2.3、構造方法

      LinkedList提高了兩個構造方法：LinkedLis()和LinkedList(Collection<? extends E> c)。

/**     *  構造一個空列表。     */    public LinkedList() {        header.next = header.previous = header;    }        /**     *  構造一個包含指定 collection 中的元素的列表，這些元素按其 collection 的迭代器返回的順序排列。     */    public LinkedList(Collection<? extends E> c) {        this();        addAll(c);    }

  LinkedList()構造一個空列表。裡面沒有任何元素，僅僅只是將header節點的前一個元素、後一個元素都指向自身。

      LinkedList(Collection<? extends E> c)： 構造一個包含指定 collection 中的元素的列表，這些元素按其 collection 的迭代器返回的順序排列。該建構函式首先會調用LinkedList()，構造一個空列表，然後調用了addAll()方法將Collection中的所有元素添加到列表中。以下是addAll()的原始碼：

/**     *  添加指定 collection 中的所有元素到此列表的結尾，順序是指定 collection 的迭代器返回這些元素的順序。     */    public boolean addAll(Collection<? extends E> c) {        return addAll(size, c);    }        /**     * 將指定 collection 中的所有元素從指定位置開始插入此列表。其中index表示在其中插入指定collection中第一個元素的索引     */    public boolean addAll(int index, Collection<? extends E> c) {        //若插入的位置小於0或者大於鏈表長度，則拋出IndexOutOfBoundsException異常        if (index < 0 || index > size)            throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);        Object[] a = c.toArray();        int numNew = a.length;    //插入元素的個數        //若插入的元素為空白，則返回false        if (numNew == 0)            return false;        //modCount:在AbstractList中定義的，表示從結構上修改列表的次數        modCount++;        //擷取插入位置的節點，若插入的位置在size處，則是前端節點，否則擷取index位置處的節點        Entry<E> successor = (index == size ? header : entry(index));        //插入位置的前一個節點，在插入過程中需要修改該節點的next引用：指向插入的節點元素        Entry<E> predecessor = successor.previous;        //執行插入動作        for (int i = 0; i < numNew; i++) {            //構造一個節點e，這裡已經執行了插入節點動作同時修改了相鄰節點的指向引用            //            Entry<E> e = new Entry<E>((E) a[i], successor, predecessor);            //將插入位置前一個節點的下一個元素引用指向當前元素            predecessor.next = e;            //修改插入位置的前一個節點，這樣做的目的是將插入位置右移一位，保證後續的元素是插在該元素的後面，確保這些元素的順序            predecessor = e;        }        successor.previous = predecessor;        //修改容量大小        size += numNew;        return true;    }

在addAll()方法中，涉及到了兩個方法，一個是entry(int index)，該方法為LinkedList的私人方法，主要是用來尋找index位置的節點元素。

/**     * 返回指定位置(若存在)的節點元素     */    private Entry<E> entry(int index) {        if (index < 0 || index >= size)            throw new IndexOutOfBoundsException("Index: " + index + ", Size: "                    + size);        //頭部節點        Entry<E> e = header;        //判斷遍曆的方向        if (index < (size >> 1)) {            for (int i = 0; i <= index; i++)                e = e.next;        } else {            for (int i = size; i > index; i--)                e = e.previous;        }        return e;    }

      從該方法有兩個遍曆方向中我們也可以看出LinkedList是雙向鏈表，這也是在構造方法中為什麼需要將header的前、後節點均指向自己。

      如果對資料結構有點瞭解，對上面所涉及的內容應該問題，我們只需要清楚一點：LinkedList是雙向鏈表，其餘都迎刃而解。

      由於篇幅有限，下面將就LinkedList中幾個常用的方法進行源碼分析。

2.4、增加方法

      add(E e): 將指定元素添加到此列表的結尾。

public boolean add(E e) {    addBefore(e, header);        return true;    }

 該方法調用addBefore方法，然後直接返回true，對於addBefore()而已，它為LinkedList的私人方法。

private Entry<E> addBefore(E e, Entry<E> entry) {        //利用Entry建構函式構建一個新節點 newEntry，        Entry<E> newEntry = new Entry<E>(e, entry, entry.previous);        //修改newEntry的前後節點的引用，確保其鏈表的參考關聯性是正確的        newEntry.previous.next = newEntry;        newEntry.next.previous = newEntry;        //容量+1        size++;        //修改次數+1        modCount++;        return newEntry;    }

在addBefore方法中無非就是做了這件事：構建一個新節點newEntry，然後修改其前後的引用。

      LinkedList還提供了其他的增加方法：

      add(int index, E element)：在此列表中指定的位置插入指定的元素。

      addAll(Collection<? extends E> c)：添加指定 collection 中的所有元素到此列表的結尾，順序是指定 collection 的迭代器返回這些元素的順序。

      addAll(int index, Collection<? extends E> c)：將指定 collection 中的所有元素從指定位置開始插入此列表。

      AddFirst(E e): 將指定元素插入此列表的開頭。

      addLast(E e): 將指定元素添加到此列表的結尾。

2.5、移除方法

      remove(Object o)：從此列表中移除首次出現的指定元素（如果存在）。該方法的原始碼如下：

public boolean remove(Object o) {        if (o==null) {            for (Entry<E> e = header.next; e != header; e = e.next) {                if (e.element==null) {                    remove(e);                    return true;                }            }        } else {            for (Entry<E> e = header.next; e != header; e = e.next) {                if (o.equals(e.element)) {                    remove(e);                    return true;                }            }        }        return false;    }

該方法首先會判斷移除的元素是否為null，然後迭代這個鏈表找到該元素節點，最後調用remove(Entry<E> e)，remove(Entry<E> e)為私人方法，是LinkedList中所有移除方法的基礎方法，如下：

private E remove(Entry<E> e) {        if (e == header)            throw new NoSuchElementException();        //保留被移除的元素：要返回        E result = e.element;                //將該節點的前一節點的next指向該節點後節點        e.previous.next = e.next;        //將該節點的後一節點的previous指向該節點的前節點        //這兩步就可以將該節點從鏈表從除去：在該鏈表中是無法遍曆到該節點的        e.next.previous = e.previous;        //將該節點歸空        e.next = e.previous = null;        e.element = null;        size--;        modCount++;        return result;    }

其他的移除方法：

      clear()： 從此列表中移除所有元素。

      remove()：擷取並移除此列表的頭（第一個元素）。

      remove(int index)：移除此列表中指定位置處的元素。

      remove(Objec o)：從此列表中移除首次出現的指定元素（如果存在）。

      removeFirst()：移除並返回此列表的第一個元素。

      removeFirstOccurrence(Object o)：從此列表中移除第一次出現的指定元素（從頭部到尾部遍曆列表時）。

      removeLast()：移除並返回此列表的最後一個元素。

      removeLastOccurrence(Object o)：從此列表中移除最後一次出現的指定元素（從頭部到尾部遍曆列表時）。

2.5、尋找方法

      對於尋找方法的源碼就沒有什麼好介紹了，無非就是迭代，比對，然後就是返回當前值。

      get(int index)：返回此列表中指定位置處的元素。

      getFirst()：返回此列表的第一個元素。

      getLast()：返回此列表的最後一個元素。

      indexOf(Object o)：返回此列表中首次出現的指定元素的索引，如果此列表中不包含該元素，則返回 -1。

      lastIndexOf(Object o)：返回此列表中最後出現的指定元素的索引，如果此列表中不包含該元素，則返回 -1。

Java - LinkedList源碼分析