LinkedList源码解析

引言

LinkedList是List接口的另一种实现，它的底层是基于双向链表实现的，因此它具有增删快查询慢特点，适用于集合元素先入先出和先入后出的场景，在队列源码中被频繁使用

整体结构

上图代表了一个双向链表结构，可以通过前面的节点找到后面的节点,也可以通过后面的节点找到前面的节点。

• Node: 代表链中的每个节，Node 的 prev 属性，代表前一个节点的地址，Node 的next 属性，代表后一个节点的地址；
• first :代表双向链表的头节点，它的前一个节点是 null。
• last: 代表双向链表的尾节点，它的后一个节点是 null；
• 如果链表中没有任何数据时，头节点first 和 尾节点last 是同一个节点，前后指向都是 null；
• 因为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;
    }
}

方法字段

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{
    //元素个数
    transient int size = 0;
    /**
     * 指向第一个节点
     */
    transient Node<E> first;
    /**
     * 指向最后一个节点
     */
    transient Node<E> last;
    .
    .
    }

LinedList的字段比较少，多添加了两个引用first和last用来指向头尾节点，和一个size用来存储节点的个数

LinkedList 源码解析

添加（新增）节点

如果想在LinkedList集合中添加节点，我们把新加入的节点添加到链表头部，也可以把新加入的节点添加添加到链表尾部，**add**方法默认是从尾部开始添加，**addFirst**方法是从头部开始添加，下面分别来看下两种不同的添加方式

    /**
     * 空的构造函数
     */
    public LinkedList() {//这时LinkedList是属性 first = null  last = null
    }
    /**
     * 包含一个数组的构造函数，链表中的顺序按照集合中的元素顺序进行插入
     */
    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);//这里调用了addAll(),就是插入所有元素
    }

说明：有两个构造函数，一个是初始化一个空的实例，另外一个是传入一个集合进行初初始化。在初始化的时候主要调用了addAll()方法，那么这个addAll()方法是怎么样添加元素的呢

public boolean add(E e) {
        linkLast(e);//把e对象指向到linkLast
        return true;
    }

从尾部添加（add）

// 从尾部开始添加节点
void linkLast(E e) {
    // 把尾节点数据暂存
    final Node<E> l = last;
    /**
     * 新建新的节点，初始化入参含义：
     * l 是新节点的前一个节点，当前值是尾节点值
     * e 表示当前新增节点，当前新增节点后一个节点是 null
     */
    final Node<E> newNode = new Node<>(l, e, null);
    // 新建节点添加到尾部
    last = newNode;
    //如果链表为空（l 是尾节点，尾节点为空，链表即空），头部和尾部是同一个节点，都是新建的节点
    if (l == null)
        first = newNode;
        //否则把前尾节点的下一个节点，指向当前尾节点。
    else
        l.next = newNode;    
    size++;//集合元素数量增加1
    modCount++;//实际修改次数增加1
}

上述源码画图说明

从头部添加（addFirst）

// 从头部添加
private void linkFirst(E e) {
    // 头节点赋值给临时变量
    final Node<E> f = first;
    // 新建节点，前一个节点指向null，e 是新建节点，f 是新建节点的下一个节点，目前值是头节点的值
    final Node<E> newNode = new Node<>(null, e, f);
    // 新建节点成为头节点
    first = newNode;
    // 头节点为空，就是链表为空，头尾节点是一个节点
    if (f == null)
        last = newNode;
    //上一个头节点的前一个节点指向当前节点
    else
        f.prev = newNode;
    size++;
    modCount++;
}

说明：头部添加节点和尾部添加节点非常类似，只是前者是移动头节点的 prev 指向，后者是移动尾节点的 next 指向

删除节点

节点删除的方式和添加类似，我们可以选择从头部删除，也可以选择从尾部删除，删除操作会把节点的值，前后指向节点都置为 null，帮助 GC进行回收。

从头部删除

//从头删除节点 f 是链表头节点
private E unlinkFirst(Node<E> f) {
    // 拿出头节点的值，作为方法的返回值
    final E element = f.item;
    // 拿出头节点的下一个节点
    final Node<E> next = f.next;
    //帮助 GC 回收头节点
    f.item = null;
    f.next = null;
    // 头节点的下一个节点成为头节点
    first = next;
    //如果 next 为空，表明链表为空
    if (next == null)
        last = null;
    //链表不为空，头节点的前一个节点指向 null
    else
        next.prev = null;
    //修改链表大小和版本
    size--;
    modCount++;
    return element;
}

从尾部删除节点的代码也是类似的，这里就不再详细解释了。
从源码中我们可以了解到，链表结构的节点新增、删除都非常简单，仅仅把前后节点的指向修改下就好了，所以 LinkedList 新增和删除速度很快。

查询节点

在链表查询某一个节点是比较慢的，因为需要挨个循环查找才行，我们看看 LinkedList 的源码是如何寻找节点的

// 根据链表索引位置查询节点
Node<E> node(int index) {
    // 如果 index 处于队列的前半部分，从头开始找，size >> 1 是 size 除以 2 的意思。
    if (index < (size >> 1)) {
        Node<E> x = first;
        // 直到 for 循环到 index 的前一个 node 停止
        for (int i = 0; i < index; i++)
            x = x.next;
        return x;
    } else {// 如果 index 处于队列的后半部分，从尾开始找
        Node<E> x = last;
        // 直到 for 循环到 index 的后一个 node 停止
        for (int i = size - 1; i > index; i--)
            x = x.prev;
        return x;
    }
}

从源码中我们可以发现，LinkedList 并没有采用从头循环到尾的做法，而是采取了简单二分法，首先看看 index是在链表的前半部分，还是后半部分。如果是前半部分，就从头开始寻找，反之亦然。通过这种方式，使循环的次数至少降低了一半，提高了查找的性能，这种思想值得我们借鉴。

迭代器

因为 LinkedList要实现双向的迭代访问，所以我们使用 Iterator 接口肯定不行了，因为 Iterator 只支持从头到尾的访问。Java 新增了一个迭代接口，叫做：ListIterator，这个接口提供了向前和向后的迭代方法，如下所示：
data-draft-node=”block” data-draft-type=”table” data-size=”normal” data-row-style=”normal”>

LinkedList 实现了 ListIterator 接口，如下图所示

// 双向迭代器
private class ListItr implements ListIterator<E> {
    private Node<E> lastReturned;//上一次执行 next() 或者 previos() 方法时的节点位置
    private Node<E> next;//下一个节点
    private int nextIndex;//下一个节点的位置
    //expectedModCount：期望版本号；modCount：目前最新版本号
    private int expectedModCount = modCount;
    …………
}

我们先来看下从头到尾方向的迭代

// 判断还有没有下一个元素
public boolean hasNext() {
    return nextIndex < size;// 下一个节点的索引小于链表的大小，就有
}
// 取下一个元素
public E next() {
    //检查期望版本号有无发生变化
    checkForComodification();
    if (!hasNext())//再次检查
        throw new NoSuchElementException();
    // next 是当前节点，在上一次执行 next() 方法时被赋值的。
    // 第一次执行时，是在初始化迭代器的时候，next 被赋值的
    lastReturned = next;
    // next 是下一个节点了，为下次迭代做准备
    next = next.next;
    nextIndex++;
    return lastReturned.item;
}

上述源码的思路就是直接取当前节点的下一个节点，而从尾到头迭代稍微复杂一点，如下：

// 如果上次节点索引位置大于 0，就还有节点可以迭代
public boolean hasPrevious() {
    return nextIndex > 0;
}
// 取前一个节点
public E previous() {
    checkForComodification();
    if (!hasPrevious())
        throw new NoSuchElementException();
    // next 为空场景：1:说明是第一次迭代，取尾节点(last);2:上一次操作把尾节点删除掉了
    // next 不为空场景：说明已经发生过迭代了，直接取前一个节点即可(next.prev)
    lastReturned = next = (next == null) ? last : next.prev;
    // 索引位置变化
    nextIndex--;
    return lastReturned.item;
}

这里复杂点体现在需要判断 next 不为空和为空的场景，代码注释中有详细的描述。

迭代器删除
LinkedList 在删除元素时，也推荐通过迭代器进行删除，删除过程如下：

public void remove() {
    checkForComodification();
    // lastReturned 是本次迭代需要删除的值，分以下空和非空两种情况：
    // lastReturned 为空，说明调用者没有主动执行过 next() 或者 previos()，直接报错
    // lastReturned 不为空，是在上次执行 next() 或者 previos()方法时赋的值
    if (lastReturned == null)
        throw new IllegalStateException();
    Node<E> lastNext = lastReturned.next;
    //删除当前节点
    unlink(lastReturned);
    // next == lastReturned 的场景分析：从尾到头递归顺序，并且是第一次迭代，并且要删除最后一个元素的情况下
    // 这种情况下，previous() 方法里面设置了 lastReturned = next = last,所以 next 和 lastReturned会相等
    if (next == lastReturned)
        // 这时候 lastReturned 是尾节点，lastNext 是 null，所以 next 也是 null，这样在 previous() 执行时，发现 next 是 null，就会把尾节点赋值给 next
        next = lastNext;
    else
        nextIndex--;
    lastReturned = null;
    expectedModCount++;
}

总结

• LinkedList是基于双向链表实现的，不论是增删改查方法还是队列和栈的实现，都可通过操作节点实现
• LinkedList无需提前指定容量，因为基于链表操作，集合的容量随着元素的加入自动增加
• LinkedList删除元素后集合占用的内存自动缩小，无需像ArrayList一样调用trimToSize()方法
• LinkedList的所有方法没有进行同步，因此它也不是线程安全的，应该避免在多线程环境下使用