六張圖詳解LinkedList 原始碼解析

小碼code發表於2022-06-23
原始碼

LinkedList 底層基於連結串列實現，增刪不需要移動資料，所以效率很高。但是查詢和修改資料的效率低，不能像陣列那樣根據下標快速的定位到資料，需要一個一個遍歷資料。

基本結構

LinkedList 是基於連結串列實現的結構，主要核心是 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;
    }
}

結構如下圖所示：

這是一個雙連結串列的結構，有 prev 前置指標和next 後置指標。

還有首節點first、尾節點last、長度size:

transient int size = 0;

transient Node<E> first;

transient Node<E> last;

新增資料

LinkedList新增元素有兩個方法：add(E e) 和 add(int index,E e)。

  • add(E e) 是在連結串列的尾部新增資料
  • add(int index,E e) 在指定連結串列位置新增資料

add(E e)

add 方法呼叫了 linkLast 方法:

public boolean add(E e) {
    linkLast(e);
    return true;
}

linkLast 表示在連結串列最後新增指定元素：

void linkLast(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 和 modCount 自增  
    size++;
    modCount++;
}
  • 記錄原尾部節點 l
  • 建立新的節點，前置指向原尾部節點。
  • 如果 l 為空，更新頭部節點
  • 更新尾部節點
  • 如果 l 不為空，l 的後置指標指向新節點

如果原尾部節點為空，直接建立一個節點，這個節點是last和first節點。
如果原尾部節點不為空，建立新節點，新節點的前置指向原來的last，原來的last的next指向新節點。

add在鏈尾新增資料，新增前後指標。以及更新為last節點。

add(int index,E e)

這個方法是新增元素到連結串列的指定位置，連結串列的下標和陣列一樣，也是從0開始算起:

先看一下 add(int index, E element) 方法

public void add(int index, E element) {
    // 檢查下標是否越界
    checkPositionIndex(index);
    if (index == size)
        // 下標等於size，直接新增到連結串列尾部
        linkLast(element);
    else
        // 
        linkBefore(element, node(index));
}

checkPositionIndex 判斷下標是否越界，index >= 0 && index <= size index 是否在 0 ~ size範圍之內。

如果index等於 size，和 add(E e) 操作一樣，都是新增在連結串列尾部。
如果index小於 size，呼叫 linkBefore 方法，往連結串列中間插入節點。首先看 node 方法：

Node<E> node(int index) {
    // assert isElementIndex(index);
    // size >> 1 表示 size 右移一位，就是 size/2 size的一半
    // index 小於 size 的一半，從首節點往後遍歷
    if (index < (size >> 1)) {
        Node<E> x = first;
        for (int i = 0; i < index; i++)
            x = x.next;
        return x;
    // index 大於 size 的一半，從最後一個節點往前遍歷    
    } else {
        Node<E> x = last;
        for (int i = size - 1; i > index; i--)
            x = x.prev;
        return x;
    }
}

node() 方法就是找到 index 對應的 node 節點。

比如一個長度為5的連結串列:

node(1) 從 first 節點（第0個節點）往後遍歷一個，也就是1對應的節點。
node(3) 從 last 節點（第4個節點）往前遍歷一個，也就是3對應的節點。

通過下標找到節點，連結串列一般是需要遍歷一遍，這裡最多需要遍歷一半的連結串列，主要是利用了雙連結串列的特性，既可以從前往後遍歷，又可以從後往前遍歷。

size>>1 表示size/2,判斷 index 是在連結串列的前半部分還是後半部分，如果在前半部分就從首節點往後遍歷，如果在後半部分就從最後一個節點往前遍歷，，這樣最多遍歷size的一半，避免遍歷整個連結串列。找到index下的節點之後，再看 linkedBefore 方法:

void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    // 記錄前置節點 pred
    final Node<E> pred = succ.prev;
    // 建立新節點，新節點的pre指向 pred，next指向succ節點
    final Node<E> newNode = new Node<>(pred, e, succ);
    // succ pre指向新節點
    succ.prev = newNode;
    // 如果pred為空，表示succ就是首節點，新節點賦為首節點
    if (pred == null)
        first = newNode;
    else
    // pred的next 指向新節點
        pred.next = newNode;
    size++;
    modCount++;
}
  • 記錄succ節點的前置節點 pred。
  • 新建節點，pre指向pred，next指向succ。
  • succ的pre 指向新節點。
  • 如果pred 為null，表示首節點是succ,將節點賦值給first節點。
  • 如果pred 不為null，pred的next指向新節點。

比如一個長度為5的連結串列，在下標為1的位置新增資料：

獲取資料

獲取資料主要有get、getFirst、getLast。

get 方法主要是通過 node 方法下標的節點，獲取節點的 item 資料。

getFirst 方法獲取首節點的item。

getLast 方法獲取尾節點的item。

刪除資料

remove(Object o)

從列表中刪除第一個匹配的元素

public boolean remove(Object o) {
    // 判斷是否為null
    if (o == null) {
        // 遍歷node 
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        // 遍歷node
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

刪除指定元素，需要判斷元素是否為null。

  • 如果為null，就使用x.item == null語句判斷。
  • 如果不為null，就使用o.equals(x.item)語句判斷。

然後再呼叫unlink方法：

E unlink(Node<E> x) {
    // assert x != null;
    // 記錄節點element、next和prev
    final E element = x.item;
    final Node<E> next = x.next;
    final Node<E> prev = x.prev;
    // prev為null，next 賦為首節點 
    if (prev == null) {
        first = next;
    } else {
        // prev的next指向next節點
        prev.next = next;
        // x節點prev置為null
        x.prev = null;
    }
    // next為null，prev賦為尾節點
    if (next == null) {
        last = prev;
    } else {
        // next的prev指向prev
        next.prev = prev;
        // x節點next置為null
        x.next = null;
    }
    // x.item置為null
    x.item = null;
    // 長度自減
    size--;
    modCount++;
    return element;
}

如圖，要刪除1資料的節點：

remove(int index)

刪除指定下標的資料：

public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

首先通過 node找到對應下標的節點，再呼叫unlink刪除資料即可。

總結

  • LinkedList 是一個雙連結串列的資料格式，為了支援雙連結串列結構，有頭節點，尾節點以及size大小。
  • add(E e) 直接新增在佇列尾部，新節點prev 指向尾節點，尾節點指向新節點。
  • add(int index,E e)如果新增位置等於連結串列長度，直接在連結串列尾節點新增資料。否則在連結串列中間新增資料。
    • 在連結串列中間新增資料首先要通過node方法獲取資料，node巧妙的判斷index和size一半長度的關係,小於就從前往後遍歷，大於就從後往前遍歷。無需遍歷整個連結串列。
    • 找到節點之後，記錄節點的prev節點，在prev和節點之間建立新的節點。
  • remove(Object o),遍歷找到元素，再呼叫unlink方法。記錄元素的前置節點prev和後置節點next,前置節點next指向後置節點，後置節點的next指向前置節點，刪除其它的前置節點和後置節點的指標。
  • remove（int index）,先通過node方法找到下標的資料，找到元素之後，再呼叫unlink方法。

如果感覺文章不錯的話，點個贊吧！

相關文章