集合框架原始碼學習之LinkedList

SnailClimb發表於2018-03-19

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類常用方法

簡介

LinkedList是一個實現了List介面Deque介面雙端連結串列。 LinkedList底層的連結串列結構使它支援高效的插入和刪除操作,另外它實現了Deque介面,使得LinkedList類也具有佇列的特性; LinkedList不是執行緒安全的,如果想使LinkedList變成執行緒安全的,可以呼叫靜態類Collections類中的synchronizedList方法:

List list=Collections.synchronizedList(new 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原始碼分析

構造方法

空構造方法:

    public LinkedList() {
    }
複製程式碼

用已有的集合建立連結串列的構造方法:

    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }
複製程式碼

新增(add)方法

add(E e) 方法:將元素新增到連結串列尾部

public boolean add(E e) {
        linkLast(e);//這裡就只呼叫了這一個方法
        return true;
    }
複製程式碼
   /**
     * 連結使e作為最後一個元素。
     */
    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++;
    }
複製程式碼

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));
    }
複製程式碼

linkBefore方法需要給定兩個引數,一個插入節點的值,一個指定的node,所以我們又呼叫了Node(index)去找到index對應的node

addAll(Collection c ):將集合插入到連結串列尾部

public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }
複製程式碼

addAll(int index, Collection 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);
    }
複製程式碼

根據位置取資料的方法

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

根據物件得到索引的方法

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;
    }
複製程式碼

檢查連結串列是否包含某物件的方法:

contains(Object o): 檢查物件o是否存在於連結串列中

 public boolean contains(Object o) {
        return indexOf(o) != -1;
    }
複製程式碼

### 刪除(remove/pop)方法 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 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));
    }
複製程式碼

LinkedList類常用方法測試

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實戰專案回覆關鍵字免費領取):

微信公眾號

相關文章