LinkedList源码剖析

1. 属性

package java.util;

import java.util.function.Consumer;
/**
 * LinkedList是通过一个双向链表来实现的,它允许插入所有元素,包括null.同时,它是线程不同步的.
*/
public class LinkedList<E> extends AbstractSequentialList<E> implements List<E>, Deque<E>, Cloneable, java.io.Serializable {
    private static final long serialVersionUID = 876323262645176354L;
    
    //链表的节点个数
    transient int size = 0;

    //指向头节点的指针
    transient Node<E> first;

    //指向尾节点的指针
    transient Node<E> last;
}

双向链表的结构

• 双向链表的每个结点除了数据域之外，还有一个前指针和后指针，分别指向前驱结点和后继结点（如果有前驱 / 后继的话）。另外，双向链表还有一个 first 指针，指向头节点；一个 last 指针，指向尾节点。
• 单向链表（1个数据域、1个指针域）要删除元素时，不但要找到删除的节点，还要找到删除节点的上一个节点（前驱），因为需要变更上一个节点中 next 的指针，但又因为它是单向链表，所以在删除的节点中并没有存储上一个节点的相关信息，那么我们就需要再查询一遍链表以找到上一个节点，这样就带来了一定的性能问题，所以就有了双向链表（1个数据域、2个指针域）。

2. 结点结构

//Node是在LinkedList里定义的一个静态内部类,它表示链表每个节点的结构.
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;
    }
}

3. 添加元素

• 对于链表这种数据结构来说，添加元素的操作无非就是在表头/表尾插入元素，又或者在指定位置插入元素。因为 LinkedList 有头指针和尾指针，所以在表头或表尾进行插入元素只需要 O(1) 的时间，而在指定位置插入元素则需要先遍历一下链表，所以复杂度为 O(n)。

在链表头部添加元素的过程

• 当向表头插入一个节点时，很显然当前节点的前驱一定为 null，而后继结点是 first 指针指向的节点，当然还要修改 first 指针指向新的头节点。除此之外，原来的头节点变成了第二个节点，所以还要修改原来头节点的前驱指针，使它指向表头节点。

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

private void linkFirst(E e) {
    final Node<E> f = first;
    //当前节点的前驱指针指向null,后继指针指向原来的头节点.
    final Node<E> newNode = new Node<>(null, e, f);
    //头指针指向新的头节点
    first = newNode;
    //如果原来有头节点,则更新原来节点的前驱指针,否则更新尾指针.
    if (f == null)
        last = newNode;
    else
        f.prev = newNode;
    size++;
    modCount++;
}

在链表尾部添加元素的过程

• 当向表尾插入一个节点时，很显然当前节点的后继一定为 null，而前驱结点是 last 指针指向的节点，然后还要修改 last 指针指向新的尾节点。此外，还要修改原来尾节点的后继指针，使它指向新的尾节点。

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

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

void linkLast(E e) {
    final Node<E> l = last;
    //当前节点的前驱指向尾节点,后继指向null.
    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) {
    //指定节点的前驱
    final Node<E> pred = succ.prev; // assert succ != null;
    //当前节点的前驱为指点节点的前驱,后继为指定的节点.
    final Node<E> newNode = new Node<>(pred, e, succ);
    //更新指定节点的前驱为当前节点
    succ.prev = newNode;
    //更新前驱节点的后继
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    size++;
    modCount++;
}

4. 删除元素

删除指定节点的过程

• 删除操作与添加操作大同小异，例如删除指定节点的过程如下图所示，需要把当前节点的前驱节点的后继修改为当前节点的后继，以及当前节点的后继结点的前驱修改为当前节点的前驱。删除头节点和尾节点跟删除指定节点非常类似，略😜。

//删除指定元素
public boolean remove(Object o) {
    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;
}

//删除表头元素
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;
    final Node<E> next = f.next;
    f.item = null;
    f.next = null; // help GC
    first = next; //头指针指向后一个节点
    if (next == null)
        last = null;
    else
        next.prev = null; //新头节点的前驱为null
    size--;
    modCount++;
    return element;
}

//删除表尾元素
public E removeLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}
//删除表尾节点,返回表尾元素的值.
private E unlinkLast(Node<E> l) {
    // assert l == last && l != null;
    final E element = l.item;
    final Node<E> prev = l.prev;
    l.item = null;
    l.prev = null; // help GC
    last = prev; //尾指针指向前一个节点
    if (prev == null)
        first = null;
    else
        prev.next = null; //新尾节点的后继为null
    size--;
    modCount++;
    return element;
}

5. 获取元素

//获取表头元素
public E getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}

//获取表尾元素
public E getLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return l.item;
}

public E get(int index) {
    checkElementIndex(index); //先检查是否越界
    return node(index).item;
}
//获取指定下标的元素
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;
    }
}

6. 其他常用方法

//链表的大小
public int size() {
    return size;
}

//替换指定下标的值
public E set(int index, E element) {
    checkElementIndex(index);
    Node<E> x = node(index);
    E oldVal = x.item;
    x.item = element;
    return oldVal;
}

//获取表头节点的值,表头为空返回null.
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

//获取表头节点的值,表头为空抛出异常.
public E element() {
    return getFirst();
}

//获取表头节点的值,并删除表头节点,表头为空返回null.
public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

//添加元素到表头
public void push(E e) {
    addFirst(e);
}

//删除表头元素
public E pop() {
    return removeFirst();
}

• LinkedList 的底层结构是一个带头/尾指针的双向链表，可以快速的对头/尾节点进行操作。
• 相比数组，链表的特点就是在指定位置插入和删除元素的效率较高，但是查找的效率就不如数组那么高了。