Java LinkedList 原始碼剖析

總體介紹

LinkedList同時實現了List介面和Deque介面，也就是說它既可以看作一個順序容器，又可以看作一個佇列（Queue），同時又可以看作一個棧（Stack）。這樣看來，LinkedList簡直就是個全能冠軍。當你需要使用棧或者佇列的時候，首先應該考慮的就是LinkedList。因為Java官方已經宣告不建議使用Stack類，推薦使用LinkedList，更遺憾的是，Java里根本沒有一個叫做Queue的類（它是個介面名字）。

LinkedList底層通過雙向連結串列實現，本節將著重講解插入和刪除元素時雙向連結串列的維護過程，也即是之間解跟List介面相關的函式，而將Queue和Stack以及Deque相關的知識放在下一節講。雙向連結串列的每個節點用內部類Node表示。LinkedList通過first和last引用分別指向連結串列的第一個和最後一個元素。注意這裡沒有所謂的啞元，當連結串列為空的時候first和last都指向null。

//Node內部類
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;
    }
}

LinkedList的實現方式決定了所有跟下標相關的操作都是線性時間，而在首段或者末尾刪除元素只需要常數時間。為追求效率LinkedList沒有實現同步（synchronized），如果需要多個執行緒併發訪問，可以先採用Collections.synchronizedList()方法對其進行包裝。

方法剖析

add()

add()方法有兩個版本，一個是add(E e)，該方法在LinkedList的末尾插入元素，因為有last指向連結串列末尾，在末尾插入元素的花費是常數時間。只需要簡單修改幾個相關引用即可；另一個是add(int index, E element)，該方法是在指定下表處插入元素，需要先通過線性查詢找到具體位置，然後修改相關引用完成插入操作。

結合上圖，可以看出add(E e)的邏輯非常簡單。

//add(E e)
public boolean add(E e) {
    final Node<E> l = last;
    final Node<E> newNode = new Node<>(l, e, null);
    last = newNode;
    if (l == null)
        first = newNode;//原來連結串列為空，這是插入的第一個元素
    else
        l.next = newNode;
    size++;
    return true;
}

add(int index, E element)的邏輯稍顯複雜，可以分成兩部，1.先根據index找到要插入的位置；2.修改引用，完成插入操作。

//add(int index, E element)
public void add(int index, E element) {
    checkPositionIndex(index);//index >= 0 && index <= size;
    if (index == size)//插入位置是末尾，包括列表為空的情況
        add(element);
    else{
        Node<E> succ = node(index);//1.先根據index找到要插入的位置
        //2.修改引用，完成插入操作。
        final Node<E> pred = succ.prev;
        final Node<E> newNode = new Node<>(pred, e, succ);
        succ.prev = newNode;
        if (pred == null)//插入位置為0
            first = newNode;
        else
            pred.next = newNode;
        size++;
    }
}

上面程式碼中的node(int index)函式有一點小小的trick，因為連結串列雙向的，可以從開始往後找，也可以從結尾往前找，具體朝那個方向找取決於條件index < (size >> 1)，也即是index是靠近前端還是後端。

remove()

remove()方法也有兩個版本，一個是刪除跟指定元素相等的第一個元素remove(Object o)，另一個是刪除指定下標處的元素remove(int index)。

兩個刪除操作都要1.先找到要刪除元素的引用，2.修改相關引用，完成刪除操作。在尋找被刪元素引用的時候remove(Object o)呼叫的是元素的equals方法，而remove(int index)使用的是下標計數，兩種方式都是線性時間複雜度。在步驟2中，兩個revome()方法都是通過unlink(Node<E> x)方法完成的。這裡需要考慮刪除元素是第一個或者最後一個時的邊界情況。

//unlink(Node<E> x)，刪除一個Node
E unlink(Node<E> x) {
    final E element = x.item;
    final Node<E> next = x.next;
    final Node<E> prev = x.prev;
    if (prev == null) {//刪除的是第一個元素
        first = next;
    } else {
        prev.next = next;
        x.prev = null;
    }
    if (next == null) {//刪除的是最後一個元素
        last = prev;
    } else {
        next.prev = prev;
        x.next = null;
    }
    x.item = null;//let GC work
    size--;
    return element;
}

get()

get(int index)得到指定下標處元素的引用，通過呼叫上文中提到的node(int index)方法實現。

public E get(int index) {
    checkElementIndex(index);//index >= 0 && index < size;
    return node(index).item;
}

set()

set(int index, E element)方法將指定下標處的元素修改成指定值，也是先通過node(int index)找到對應下表元素的引用，然後修改Node中item的值。

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