集合框架源碼學習之LinkedList

<font face="楷體"> 目錄：</font>

0-1. 簡介

0-2. 內部結構分析

0-3. LinkedList源碼分析

　　0-3-1. 構造方法

　　0-3-2. 添加add方法
　　

　　0-3-3. 根據位置取數據的方法

　　0-3-4. 根據對象獲得索引的方法

　　0-3-5. 檢查鏈表是否包含某對象的方法

　　0-3-6. 刪除removepop方法

0-4. LinkedList類經常使用方法

<font face="楷體" id="1"> 簡介</font>

<font color="red">LinkedList</font>是一個實現了<font color="red">List接口</font>和<font color="red">Deque接口</font>的<font color="red">雙端鏈表</font>。
LinkedList底層的鏈表結構使它<font color="red">支持高效的插入和刪除操做</font>，另外它實現了Deque接口，使得LinkedList類也具備隊列的特性;
LinkedList<font color="red">不是線程安全的</font>，若是想使LinkedList變成線程安全的，能夠調用靜態類<font color="red">Collections類</font>中的<font color="red">synchronizedList</font>方法：

List list=Collections.synchronizedList(new LinkedList(...));

<font face="楷體" id="2">內部結構分析</font>

以下圖所示：

看完了圖以後，咱們再看LinkedList類中的一個<font color="red">內部私有類Node</font>就很好理解了：

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。這個類有三個屬性，分別是前驅節點，本節點的值，後繼結點。

<font face="楷體" id="3"> LinkedList源碼分析</font>

<font face="楷體" id="3.1">構造方法</font>

空構造方法：

public LinkedList() {
    }

用已有的集合建立鏈表的構造方法：

public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }

<font face="楷體" id="3.2">添加（add）方法</font>

add(E e) 方法：將元素添加到鏈表尾部

public boolean add(E e) {
        linkLast(e);//這裏就只調用了這一個，咱們立刻就分析這個方法的實現
        return true;
    }

private void linkFirst(E e) {
        final Node<E> f = first;
        final Node<E> newNode = new Node<>(null, e, f);//新建節點，以頭節點爲後繼節點
        first = newNode;
        //若是鏈表爲空，last節點也指向該節點
        if (f == null)
            last = newNode;
        //不然，將頭節點的前驅指針指向新節點
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

add(int index,E e)：在指定位置添加元素

public void add(int index, E element) {
        checkPositionIndex(index); //檢查索引是否處於[0-size]之間

        if (index == size)//添加在鏈表尾部
            linkLast(element);
        else//添加在鏈表中間
            linkBefore(element, node(index));
    }

<font color="red">linkBefore方法</font>須要給定兩個參數，一個<font color="red">插入節點的值</font>，一個<font color="red">指定的node</font>，因此咱們又調用了<font color="red">Node(index)去找到index對應的node</font>

addAll(Collection<? extends E> c )： 將集合插入到鏈表尾部

public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

addAll(int index, Collection<? extends E> c)： 將集合從指定位置開始插入

public boolean addAll(int index, Collection<? extends E> c) {
        //1:檢查index範圍是否在size以內
        checkPositionIndex(index);

        //2:toArray()方法把集合的數據存到對象數組中
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        //3：獲得插入位置的前驅節點和後繼節點
        Node<E> pred, succ;
        //若是插入位置爲尾部，前驅節點爲last，後繼節點爲null
        if (index == size) {
            succ = null;
            pred = last;
        }
        //不然，調用node()方法獲得後繼節點，再獲得前驅節點
        else {
            succ = node(index);
            pred = succ.prev;
        }

        // 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方法一般包括下面四個步驟：

1. 檢查index範圍是否在size以內
2. toArray()方法把集合的數據存到對象數組中
3. 獲得插入位置的前驅和後繼節點
4. 遍歷數據，將數據插入到指定位置

addFirst(E e)： 將元素添加到鏈表頭部

public void addFirst(E e) {
        linkFirst(e);
    }

private void linkFirst(E e) {
        final Node<E> f = first;
        final Node<E> newNode = new Node<>(null, e, f);//新建節點，以頭節點爲後繼節點
        first = newNode;
        //若是鏈表爲空，last節點也指向該節點
        if (f == null)
            last = newNode;
        //不然，將頭節點的前驅指針指向新節點
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

addLast(E e)： 將元素添加到鏈表尾部，與 add(E e) 方法同樣

public void addLast(E e) {
        linkLast(e);
    }

<font face="楷體" id="3.3">根據位置取數據的方法</font>

get(int index)：：根據指定索引返回數據

public E get(int index) {
        //檢查index範圍是否在size以內
        checkElementIndex(index);
        //調用Node(index)去找到index對應的node而後返回它的值
        return node(index).item;
    }

獲取頭節點（index=0）數據方法:

public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }
public E element() {
        return getFirst();
    }
public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }

區別：
getFirst(),element(),peek(),peekFirst()
這四個獲取頭結點方法的區別在於對鏈表爲空時的處理，是拋出異常仍是返回null，其中getFirst() 和element() 方法將會在鏈表爲空時，拋出異常

element()方法的內部就是使用getFirst()實現的。它們會在鏈表爲空時，拋出NoSuchElementException
獲取尾節點（index=-1）數據方法:

public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }
 public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

二者區別：
getLast() 方法在鏈表爲空時，會拋出NoSuchElementException，而peekLast() 則不會，只是會返回 null。

<font face="楷體" id="3.4">根據對象獲得索引的方法</font>

int indexOf(Object o)： 從頭遍歷找

public int indexOf(Object o) {
        int index = 0;
        if (o == null) {
            //從頭遍歷
            for (Node<E> x = first; x != null; x = x.next) {
                if (x.item == null)
                    return index;
                index++;
            }
        } else {
            //從頭遍歷
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item))
                    return index;
                index++;
            }
        }
        return -1;
    }

int lastIndexOf(Object o)： 從尾遍歷找

public int lastIndexOf(Object o) {
        int index = size;
        if (o == null) {
            //從尾遍歷
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (x.item == null)
                    return index;
            }
        } else {
            //從尾遍歷
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (o.equals(x.item))
                    return index;
            }
        }
        return -1;
    }

<font face="楷體" id="3.5">檢查鏈表是否包含某對象的方法：</font>

contains(Object o)： 檢查對象o是否存在於鏈表中

public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

<font face="楷體" id="3.6"> 刪除（remove/pop）方法</font>

remove() ,removeFirst(),pop(): 刪除頭節點

public E pop() {
        return removeFirst();
    }
public E remove() {
        return removeFirst();
    }
public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

removeLast(),pollLast(): 刪除尾節點

public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

區別： removeLast()在鏈表爲空時將拋出NoSuchElementException，而pollLast()方法返回null。

remove(Object o): 刪除指定元素

public boolean remove(Object o) {
        //若是刪除對象爲null
        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;
    }

當刪除指定對象時，只需調用remove(Object o)便可，不過該方法一次只會刪除一個匹配的對象，若是刪除了匹配對象，返回true，不然false。

unlink(Node<E> 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) {
            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;
    }

remove(int index)：刪除指定位置的元素

public E remove(int index) {
        //檢查index範圍
        checkElementIndex(index);
        //將節點刪除
        return unlink(node(index));
    }

<font face="楷體" id="4">LinkedList類經常使用方法測試</font>：

package list;

import java.util.Iterator;
import java.util.LinkedList;

public class LinkedListDemo {
    public static void main(String[] srgs) {
        //建立存放int類型的linkedList
        LinkedList<Integer> linkedList = new LinkedList<>();
        /************************** linkedList的基本操做 ************************/
        linkedList.addFirst(0); // 添加元素到列表開頭
        linkedList.add(1); // 在列表結尾添加元素
        linkedList.add(2, 2); // 在指定位置添加元素
        linkedList.addLast(3); // 添加元素到列表結尾
        
        System.out.println("LinkedList（直接輸出的）: " + linkedList);

        System.out.println("getFirst()得到第一個元素: " + linkedList.getFirst()); // 返回此列表的第一個元素
        System.out.println("getLast()得到第最後一個元素: " + linkedList.getLast()); // 返回此列表的最後一個元素
        System.out.println("removeFirst()刪除第一個元素並返回: " + linkedList.removeFirst()); // 移除並返回此列表的第一個元素
        System.out.println("removeLast()刪除最後一個元素並返回: " + linkedList.removeLast()); // 移除並返回此列表的最後一個元素
        System.out.println("After remove:" + linkedList);
        System.out.println("contains()方法判斷列表是否包含1這個元素:" + linkedList.contains(1)); // 判斷此列表包含指定元素，若是是，則返回true
        System.out.println("該linkedList的大小 : " + linkedList.size()); // 返回此列表的元素個數

        /************************** 位置訪問操做 ************************/
        System.out.println("-----------------------------------------");
        linkedList.set(1, 3); // 將此列表中指定位置的元素替換爲指定的元素
        System.out.println("After set(1, 3):" + linkedList);
        System.out.println("get(1)得到指定位置（這裏爲1）的元素: " + linkedList.get(1)); // 返回此列表中指定位置處的元素

        /************************** Search操做 ************************/
        System.out.println("-----------------------------------------");
        linkedList.add(3);
        System.out.println("indexOf(3): " + linkedList.indexOf(3)); // 返回此列表中首次出現的指定元素的索引
        System.out.println("lastIndexOf(3): " + linkedList.lastIndexOf(3));// 返回此列表中最後出現的指定元素的索引

        /************************** Queue操做 ************************/
        System.out.println("-----------------------------------------");
        System.out.println("peek(): " + linkedList.peek()); // 獲取但不移除此列表的頭
        System.out.println("element(): " + linkedList.element()); // 獲取但不移除此列表的頭
        linkedList.poll(); // 獲取並移除此列表的頭
        System.out.println("After poll():" + linkedList);
        linkedList.remove();
        System.out.println("After remove():" + linkedList); // 獲取並移除此列表的頭
        linkedList.offer(4);
        System.out.println("After offer(4):" + linkedList); // 將指定元素添加到此列表的末尾

        /************************** Deque操做 ************************/
        System.out.println("-----------------------------------------");
        linkedList.offerFirst(2); // 在此列表的開頭插入指定的元素
        System.out.println("After offerFirst(2):" + linkedList);
        linkedList.offerLast(5); // 在此列表末尾插入指定的元素
        System.out.println("After offerLast(5):" + linkedList);
        System.out.println("peekFirst(): " + linkedList.peekFirst()); // 獲取但不移除此列表的第一個元素
        System.out.println("peekLast(): " + linkedList.peekLast()); // 獲取但不移除此列表的第一個元素
        linkedList.pollFirst(); // 獲取並移除此列表的第一個元素
        System.out.println("After pollFirst():" + linkedList);
        linkedList.pollLast(); // 獲取並移除此列表的最後一個元素
        System.out.println("After pollLast():" + linkedList);
        linkedList.push(2); // 將元素推入此列表所表示的堆棧（插入到列表的頭）
        System.out.println("After push(2):" + linkedList);
        linkedList.pop(); // 今後列表所表示的堆棧處彈出一個元素（獲取並移除列表第一個元素）
        System.out.println("After pop():" + linkedList);
        linkedList.add(3);
        linkedList.removeFirstOccurrence(3); // 今後列表中移除第一次出現的指定元素（從頭部到尾部遍歷列表）
        System.out.println("After removeFirstOccurrence(3):" + linkedList);
        linkedList.removeLastOccurrence(3); // 今後列表中移除最後一次出現的指定元素（從頭部到尾部遍歷列表）
        System.out.println("After removeFirstOccurrence(3):" + linkedList);

        /************************** 遍歷操做 ************************/
        System.out.println("-----------------------------------------");
        linkedList.clear();
        for (int i = 0; i < 100000; i++) {
            linkedList.add(i);
        }
        // 迭代器遍歷
        long start = System.currentTimeMillis();
        Iterator<Integer> iterator = linkedList.iterator();
        while (iterator.hasNext()) {
            iterator.next();
        }
        long end = System.currentTimeMillis();
        System.out.println("Iterator：" + (end - start) + " ms");

        // 順序遍歷(隨機遍歷)
        start = System.currentTimeMillis();
        for (int i = 0; i < linkedList.size(); i++) {
            linkedList.get(i);
        }
        end = System.currentTimeMillis();
        System.out.println("for：" + (end - start) + " ms");

        // 另外一種for循環遍歷
        start = System.currentTimeMillis();
        for (Integer i : linkedList)
            ;
        end = System.currentTimeMillis();
        System.out.println("for2：" + (end - start) + " ms");

        // 經過pollFirst()或pollLast()來遍歷LinkedList
        LinkedList<Integer> temp1 = new LinkedList<>();
        temp1.addAll(linkedList);
        start = System.currentTimeMillis();
        while (temp1.size() != 0) {
            temp1.pollFirst();
        }
        end = System.currentTimeMillis();
        System.out.println("pollFirst()或pollLast()：" + (end - start) + " ms");

        // 經過removeFirst()或removeLast()來遍歷LinkedList
        LinkedList<Integer> temp2 = new LinkedList<>();
        temp2.addAll(linkedList);
        start = System.currentTimeMillis();
        while (temp2.size() != 0) {
            temp2.removeFirst();
        }
        end = System.currentTimeMillis();
        System.out.println("removeFirst()或removeLast()：" + (end - start) + " ms");
    }
}

歡迎關注個人微信公衆號（分享各類Java學習資源，面試題，以及企業級Java實戰項目回覆關鍵字免費領取）：