【JDK源码】LinkedList源码分析

LinkedList源码分析

1.简介

• 通过继承体系，我们可以看到LinkedList不仅实现了List接口，还实现了Queue和Deque接口，所以它既能作为List使用，也能作为双端队列使用，当然也可以作为栈使用。
• 从继承体系可以看出，LinkedList实现了Cloneable和Serializable接口，说明其可以被克隆，也可以被序列化！同样的，LinkedList被克隆的时候，和ArrayList一样二者均是浅拷贝。

2.主要属性

// 元素个数
transient int size = 0;

// 链表首节点
transient Node<E> first;

// 链表尾节点
transient Node<E> last;

属性很简单，定义了元素个数size和链表的首尾节点。transient保证不被序列化。

3.主要内部类

典型的双链表结构：

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;
    }
}

4.主要构造方法

//无参构造
public LinkedList() {
}

//有参构造
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

5.添加元素

作为一个双端队列，添加元素主要有两种，一种是在队列尾部添加元素，一种是在队列首部添加元素，这两种形式在LinkedList中主要是通过下面两个方法来实现的。

队列首部添加

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也置为新节点
    //否则把原来的首节点的prev指针置为新节点
    if (f == null)
        last = newNode;
    else
        f.prev = newNode;
    // 元素个数加一
    size++;
    // 修改次数加一，说明这是一个支持fail-fast的集合
    modCount++;
}

队列尾部添加

public void addLast(E e) {
    linkLast(e);
}
// 从队列尾部添加元素
void linkLast(E e) {
    // 队列尾节点
    final Node<E> l = last;
    // 创建新节点，新节点的prev是尾节点
    final Node<E> newNode = new Node<>(l, e, null);
    // 让新节点成为新的尾节点
    last = newNode;
    // 判断是不是第一个添加的元素
    // 如果是就把first也置为新节点
    // 否则把原节点的next指针置为新节点
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    //元素个数加一
    size++;
    // 修改次数加一
    modCount++;
}

作为无界队列，添加元素总是会成功：

public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

public boolean offerLast(E e) {
    addLast(e);
    return true;
}

作为List，是要支持在中间添加元素的，主要是通过下面这个方法实现的。

指定位置添加

//在指定index位置处添加元素
public void add(int index, E element) {
    //检查是否越界
    checkPositionIndex(index);
    //如果index是在队列尾节点之后的一个位置
    //把新节点直接添加到尾节点之后
    //否则调用linkBefore()方法在中间添加节点
    if (index == size)
        linkLast(element);
    else
        linkBefore(element, node(index));
}
//寻找index位置对应的节点
Node<E> node(int index) {
    //因为是双链表，所以根据index是在前半段还是后半段决定从前遍历还是从后遍历
    //这样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;
    }
}

// 在节点succ之前添加元素
void linkBefore(E e, Node<E> succ) {
    // 找到待添加节点的前置节点，也就是succ的前置节点
    final Node<E> pred = succ.prev;
    // 在其前置节点和后继节点之间创建一个新节点
    final Node<E> newNode = new Node<>(pred, e, succ);
    // 修改后继节点的前置指针指向新节点
    succ.prev = newNode;
    // 判断前置节点是否为空
    //如果为空，说明是第一个添加的元素，修改first指针
    //复制修改前置节点的nxet为新节点
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    //元素个数+1
    size++;
    //修改次数+1
    modCount++;
}

LinkedList在中间添加元素的方法也很简单，典型的双链表在中间添加元素的方法。

总结

添加元素的三种方式大致如下图所示：

• 在队列首尾添加元素很高效，时间复杂度为O(1)。
• 在中间添加元素比较低效，首先要先找到插入位置的节点，再修改前后节点的指针，时间复杂度为O(n)。

6.删除元素

作为双端队列，删除元素也有两种方式，一种是队列首删除元素，一种是队列尾删除元素。

作为List，又要支持中间删除元素，所以删除元素一个有三个方法，分别如下：

删除头节点

//remove的时候如果没有元素抛出异常
public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

//poll的时候如果没有元素返回null
public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

//删除首节点
private E unlinkFirst(Node<E> f) {
    //首节点的元素值
    final E element = f.item;
    //首节点的next指针
    final Node<E> next = f.next;
    //首节点的值置为null，协助GC
    f.item = null;
    f.next = null; // help GC
    //把首节点的next作为新的首节点
    first = next;
    //如果只有一个元素，删除了，就把last也置为null
    //否则把next的前置指针置为null
    if (next == null)
        last = null;
    else
        next.prev = null;
    //元素个数减一
    size--;
    //修改次数加一
    modCount++;
    //返回删除的元素
    return element;
}

删除尾节点

//remove的时候如果没有元素抛出异常
public E removeLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}

//poll的时候如果没有元素返回null
public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

//删除尾节点
private E unlinkLast(Node<E> l) {
    //尾节点的元素值
    final E element = l.item;
    //尾节点的前置指针
    final Node<E> prev = l.prev;
    //清空尾节点的内容，协助GC
    l.item = null;
    l.prev = null; // help GC
    //让前置节点称为新的尾节点
    last = prev;
    //如果只有一个元素，删除了把first置为null
    //否则把前置节点的next置为null
    if (prev == null)
        first = null;
    else
        prev.next = null;
    //元素个数减一
    size--;
    //修改次数加一
    modCount++;
    //返回删除的元素
    return element;
}

删除中间指定节点

//删除中间节点
public E remove(int index) {
    //检查是否越界
    checkElementIndex(index);
    //删除指定index位置的节点
    return unlink(node(index));
}

//删除指定节点
E unlink(Node<E> x) {
    // 节点x的元素值
    final E element = x.item;
    // x的前置节点
    final Node<E> next = x.next;
    // x的后置节点
    final Node<E> prev = x.prev;
    //如果前置节点为空
    //说明是首节点，让first指向x的后置节点
    //否则修改前置节点的next为x的后置节点
    if (prev == null) {
        first = next;
    } else {
        prev.next = next;
        x.prev = null;
    }
    //如果后置节点为空
    //说明是尾节点，让last指向x的前置节点
    //否则修改后置节点prev为x的前置节点
    if (next == null) {
        last = prev;
    } else {
        next.prev = prev;
        x.next = null;
    }
    //清空x的元素值，协助GC
    x.item = null;
    //元素个数减一
    size--;
    //修改次数加一
    modCount++;
    //返回删除的元素
    return element;
}

总结

删除元素的三种方法都是典型的双链表删除元素的方法，大致流程如下图所示：

• 在队列首尾删除元素很高效，时间复杂度为O(1)。
• 在中间删除元素比较低效，首先要找到删除位置的节点，再修改前后指针，时间复杂度为O(n)。

7.清除方法

清除所有元素

public void clear() {
    //为了让GC更快可以回收放置的元素，需要将node之间的引用关系赋空。
    for (Node<E> x = first; x != null; ) {
        Node<E> next = x.next;
        x.item = null;
        x.next = null;
        x.prev = null;
        x = next;
    }
    first = last = null;
    //元素个数置为0
    size = 0;
    //修改次数加一
    modCount++;
}

8.作为栈

LinkedList是双端队列，双端队列可以作为栈使用。

//元素入栈
public void push(E e) {
    // 队列的头元素就是栈的栈顶元素
    addFirst(e);
}

//删除栈顶元素并返回
public E pop() {
    // 队列的头元素就是栈的栈顶元素
    return removeFirst();
}

栈的特性是LIFO，所以作为栈使用也很简单，添加删除元素都只操作队列首节点即可。

9.总结

1. LinkedList是一个以双链表实现的List
2. LinkedList还是一个双端队列，具有队列、双端队列、栈的特性
3. LinkedList在队列首尾添加、删除元素非常高效，时间复杂度为O(1)
4. LinkedList在中间添加、删除元素比较低效，时间复杂度为O(n)
5. LinkedList不支持随机访问，所以访问非队列首尾的元素比较低效
6. LinkedList在功能上等于ArrayList + ArrayDeque