java基礎:LinkedList — 原始碼分析

Hiway發表於2018-12-17

其他更多java基礎文章:
java基礎學習(目錄)


概述

LinkedList是一個實現了List介面和Deque介面的雙端連結串列,底層是雙向連結串列,它也可以被當作堆疊、佇列或雙端佇列進行操作。
有關索引的操作可能從連結串列頭開始遍歷到連結串列尾部,也可能從尾部遍歷到連結串列頭部,這取決於看索引更靠近哪一端。

  • LinkedList 實現 List 介面,能對它進行佇列操作。
  • LinkedList 實現 Deque 介面,即能將LinkedList當作雙端佇列使用。
  • LinkedList 實現了Cloneable介面,即覆蓋了函式clone(),能克隆。
  • LinkedList 實現java.io.Serializable介面,這意味著LinkedList支援序列化,能通過序列化去傳輸。
  • 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;
        }
    }
複製程式碼

內部類Node就是實際的結點,用於存放實際的元素。LinkedList通過Node類和first、last兩個特定意義的Node屬性欄位,來構建雙向連結串列的底層結構。

java基礎:LinkedList — 原始碼分析

從上圖可以看出,LinkedList內部是一個雙端連結串列結構,有兩個變數,first指向連結串列頭部,last指向連結串列尾部。 LinkedtList內部的成員變數如下:

transient Node<E> first;
transient Node<E> last;
//LinkedList的長度
transient int size = 0;
複製程式碼

方法細節

add方法

add(E e)

add(E e)用於將元素新增到連結串列尾部,實現如下:

    public boolean add(E e) {
        linkLast(e);
        return true;
    }
    
    void linkLast(E e) {
        final Node<E> l = last; //儲存原連結串列尾部節點
        final Node<E> newNode = new Node<>(l, e, null); //以原連結串列尾部節點為prev節點建立一個新節點
        last = newNode; //將連結串列尾部指向新節點
        if (l == null) //如果連結串列為空,那麼該節點既是頭節點也是尾節點
            first = newNode;
        else //連結串列不為空,那麼將該結點作為原連結串列尾部的後繼節點
            l.next = newNode;
        size++;
        modCount++;
    }
複製程式碼

從上面程式碼可以看到,linkLast方法中就是一個連結串列尾部新增一個雙端節點的操作,但是需要注意對連結串列為空時頭節點的處理。

add(int index,E e)

add(int index,E e)用於在指定位置新增元素。實現如下:

    public void add(int index, E element) {
        checkPositionIndex(index);

        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }
    
    Node<E> node(int index) {
        // assert isElementIndex(index);

        if (index < (size >> 1)) { //如果索引位置靠連結串列前半部分,從頭開始遍歷
            Node<E> x = first;
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else { //否則,從尾開始遍歷
            Node<E> x = last;
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }
    
    void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        final Node<E> pred = succ.prev;
        final Node<E> newNode = new Node<>(pred, e, succ);
        succ.prev = newNode;
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        size++;
        modCount++;
    }
複製程式碼

從上面程式碼可以看到,add(int index, E element)方法主要分為3步:

  1. 檢查index的範圍,否則丟擲異常
  2. 如果插入位置是連結串列尾部,那麼呼叫linkLast方法
  3. 如果插入位置是連結串列中間,那麼呼叫linkBefore方法

node(int index)方法就比較簡單,根據index是靠近頭部還是尾部選擇不同的遍歷方向。

linkBefore(E e, Node succ)方法表示在succ節點前插入一個值為e的新節點,步驟如下:

  1. 將succ節點的前驅節點儲存為pred
  2. 建立newNode節點,將newNode的後繼指標指向succ,前驅指標指向pred
  3. 將succ的前驅指標指向newNode
  4. 根據pred是否為null,進行不同操作。
  • 如果pred為null,說明該節點插入在頭節點之前,要重置first頭節點
  • 如果pred不為null,那麼直接將pred的後繼指標指向newNode即可

addAll方法

    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }
    
    //將集合從指定位置開始插入
    public boolean addAll(int index, Collection<? extends E> c) {
        //Step 1:檢查index範圍
        checkPositionIndex(index);

        //Step 2:得到集合的資料
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        //Step 3:得到插入位置的前驅節點和後繼節點
        Node<E> pred, succ;
        //如果插入位置為尾部,前驅節點為last,後繼節點為null
        if (index == size) {
            succ = null;
            pred = last;
        }
        //否則,呼叫node()方法得到後繼節點,再得到前驅節點
        else {
            succ = node(index);
            pred = succ.prev;
        }

        //Step 4:遍歷資料將資料插入
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            //建立新節點
            Node<E> newNode = new Node<>(pred, e, null);
            //如果插入位置在連結串列頭部
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }

        //如果插入位置在尾部,重置last節點
        if (succ == null) {
            last = pred;
        }
        //否則,將插入的連結串列與先前連結串列連線起來
        else {
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;
        modCount++;
        return true;
    }
複製程式碼

從上面的程式碼可以看到,addAll方法主要分為4步:

  1. 檢查index索引範圍
  2. 得到集合資料
  3. 得到插入位置的前驅和後繼節點
  4. 遍歷資料,將資料插入到指定位置

remove方法

    //刪:remove目標節點
    public E remove(int index) {
        checkElementIndex(index);//檢查是否越界 下標[0,size)
        return unlink(node(index));//從連結串列上刪除某節點
    }

    //因為要考慮 null元素,也是分情況遍歷
    public boolean remove(Object o) {
        if (o == null) {//如果要刪除的是null節點(從remove和add 裡 可以看出,允許元素為null)
            //遍歷每個節點 對比
            for (Node<E> x = first; x != null; x = x.next) {
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }
    
    //將節點x,從連結串列中刪除,返回刪除節點的值
    E unlink(Node<E> x) {
        // assert x != null;
        final E element = x.item;//繼續元素值,供返回
        final Node<E> next = x.next;//儲存當前節點的後置節點
        final Node<E> prev = x.prev;//前置節點

        if (prev == null) {//前置節點為null,
            first = next;//則首節點為next
        } else {//否則 更新前置節點的後置節點
            prev.next = next;
            x.prev = null;//記得將要刪除節點的前置節點置null
        }
        //如果後置節點為null,說明是尾節點
        if (next == null) {
            last = prev;
        } else {//否則更新 後置節點的前置節點
            next.prev = prev;
            x.next = null;//記得刪除節點的後置節點為null
        }
        //將刪除節點的元素值置null,以便GC
        x.item = null;
        size--;//修改size
        modCount++;//修改modCount
        return element;//返回刪除的元素值
    }
複製程式碼

上面unlink方法的程式碼可以簡單分為以下幾個步驟:
第一步:得到待刪除節點的前驅節點和後繼節點
第二步:更新前驅節點和刪除節點的prev
第三步:更新後繼節點和刪除節點的next
第四步:將刪除節點的元素值置null,以便GC,修改size值
經過四步,待刪除的結點就從連結串列中脫離了。需要注意的是刪除位置是頭節點或尾節點時候的處理。

Deque介面的方法

Deque 是 Double ended queue (雙端佇列) 的縮寫,讀音和 deck 一樣,蛋殼。
Deque介面其具體方法的處理邏輯如下所示:

頭部訪問 尾部訪問
操作 丟擲異常 返回特殊值 丟擲異常 返回特殊值
插入操作 addFirst(e) offerFirst(e) addLast(e) offerLast(e)
刪除操作 removeFirst() pollFirst() removeLast() pollLast()
訪問操作 getFirst() peekFirst() getLast() peekLast()

在LinkedList中,返回的特殊值為null或true。舉兩個簡單的例子分析下:

    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }
    
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }
複製程式碼

很簡單,當first為null時,getFirst()丟擲異常,peekFirst()返回特殊值null。

    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }
    
    public void addFirst(E e) {
        linkFirst(e);
    }
複製程式碼

offerFirst方法返回true,addFirst方法無返回。

Deque 介面能夠當做佇列(先進先出)、棧(後進先出)使用,具體就不在這闡述,可以看java.util.Deque學習筆記

總結

  • LinkedList 是雙向列表,能儲存null值
  • 連結串列批量增加,是靠for迴圈遍歷原陣列,依次執行插入節點操作。對比ArrayList是通過System.arraycopy完成批量增加的。增加一定會修改modCount。
  • 通過下標獲取某個node 的時候,會根據index處於前半段還是後半段 進行一個折半,以提升查詢效率
  • 刪也一定會修改modCount。 按下標刪,也是先根據index找到Node,然後去連結串列上unlink掉這個Node。 按元素刪,會先去遍歷連結串列尋找是否有該Node,如果有,去連結串列上unlink掉這個Node。
  • 改也是先根據index找到Node,然後替換值。改不修改modCount。
  • 查本身就是根據index找到Node。
  • LinkedList不光能夠向前迭代,還能像後迭代,不光能當連結串列,還能當佇列、棧使用

相關文章