《JAVA1.8源碼分析》：LinkedList

LinkedList源碼分析

繼承結構

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

LinkedList繼承了AbstractSequentialList接口，實現了List，Deque，Cloneable和Serializable接口，沒有繼承randomAccess，所有需要遍歷訪問。實現了Deque接口，則LinkedList類也具有雙端隊列的特性。

屬性

//LinkedList對象實例的大小
1. transient int size = 0;
//頭指針：指向LinkedList中的第一個元素
2. transient Node<E> first;
//尾指針：指向LinkedList中的最後一個元素
3. transient Node<E> last;

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只定義了存儲的元素、前一個元素的指向、後一個元素的指向，這就是雙向鏈表的節點的定義，每個節點只知道自己的前一個節點和後一個節點。

構造函數

//構造一個空鏈表。
 public LinkedList() {
    }

public LinkedList(Collection<? extends E> c) {
        //調用無參構造方法構造一個空的鏈表
        this();
        addAll(c);
    }

addAll函數

public boolean addAll(Collection<? extends E> c) {
        //直接調用另一個函數
        return addAll(size, c);
    }

public boolean addAll(int index, Collection<? extends E> c) {
        //檢查位置是否合法
        checkPositionIndex(index);

        //轉爲數組
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        Node<E> pred, succ;
        //判斷是否爲尾結點
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index);
            pred = succ.prev;
        }

        //將所有元素加入在pre指向之後
        for (Object o : a) {
            //類型轉化
            @SuppressWarnings("unchecked") E e = (E) o;
            //創建新結點
            Node<E> newNode = new Node<>(pred, e, null);
            //如果是首節點，則設置first
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }
         /*
        在尾結點加入時，pred所指向的就是last的位置，
        否則，則將pred與succ的指向要進行連接起來。
        */
        if (succ == null) {
            last = pred;
        } else {
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;
        modCount++;//增加修改次數
        return true;
    }    

//根據位置得到對應的結點
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;
        }
    }

此函數的功能：返回LinkedList對象中指定位置index處的非空結點。源碼的實現比較簡單，就是將index與鏈表的中心點的位置進行比較，然後從離得近的一段來進行搜索，得到我們想到的位置的節點。這樣的好處相比我們從頭搜索到尾可以更快的得到，這樣方便提高性能。

add函數

//將元素添加到最後
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);
        last = newNode;
        if (l == null)
            first = newNode;
        else
            l.next = newNode;
        size++;
        modCount++;
    }

//指定位置添加元素
public void add(int index, E element) {
        checkPositionIndex(index);

        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }

 //在某個結點之前插入結點
 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++;
    }

remove函數
remove提供了removeFirst，removeLast，和remove三個方法

//removeFirst
public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }
//移除首節點
private E unlinkFirst(Node<E> f) {
        // assert f == first && f != null;
        final E element = f.item;
        //找到next結點
        final Node<E> next = f.next;
        f.item = null;
        f.next = null; // help GC
        //next結點爲首節點
        first = next;
        //判斷是否只有一個首節點
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

removeLast 類似就不分析了

//根據結點來刪除
 public boolean remove(Object o) {
         //遍歷查詢結點，分爲null和普通情況
         //因爲equals（null）會直接返回false
        if (o == 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;
    }
//根據座標刪除
public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }

//刪除某個節點具體實現
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) {
            first = next;
        } else {
            prev.next = next;
            x.prev = null;
        }

        if (next == null) {
            last = prev;
        } else {
            next.prev = prev;
            x.next = null;
        }

        x.item = null;
        size--;
        modCount++;
        return element;
    }

get函數

//直接調用node函數即可
public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }

set函數

 public E set(int index, E element) {
        checkElementIndex(index);
        //找到結點
        Node<E> x = node(index);
        E oldVal = x.item;
        //修改結點的值
        x.item = element;
        //返回老結點
        return oldVal;
    }

小結
關於LinkedList類的代碼實現，首先我們要知道的值LinkedList就是一個雙向鏈表。有前後兩個指針來遍歷整個雙向鏈表。關於add、set、get函數的內部實現 和我們在學習算法的時候寫關於 刪除鏈表節點以及添加鏈表節點的思想類似，因此看這個的源碼會感覺思路相當的清晰、簡單。