精尽 JDK 源码解析 —— 集合（二）链表 LinkedList

最新推荐文章于 2023-06-13 20:01:34 发布

路从脚起

最新推荐文章于 2023-06-13 20:01:34 发布

阅读量120

点赞数 1

文章标签： java 链表开发语言

本文链接：https://blog.csdn.net/weixin_39042870/article/details/129524580

版权

1. 概述

LinkedList ，基于节点实现的双向链表的 List ，每个节点都指向前一个和后一个节点从而形成链表。

相比 ArrayList 来说，我们日常开发使用 LinkedList 相对比较少。打开 IDEA ，搜下项目中 LinkedList 后，会发现使用的少之又少。

2. 类图

LinkedList 实现的接口、继承的抽象类，如下图所示：

类图

如下 3 个接口是 ArrayList 一致的：

如下 1 个接口是少于 ArrayList 的：

java.util.RandomAccess 接口，LinkedList 不同于 ArrayList 的很大一点，不支持随机访问。

如下 1 个接口是多于 ArrayList 的：

java.util.Deque 接口，提供双端队列的功能，LinkedList 支持快速的在头尾添加元素和读取元素，所以很容易实现该特性。

注意，以为 LinkedList 实现了 Deque 接口，所以我们在「5. 添加单个元素」和「7. 移除单个元素」中，会看到多种方法，可以快速看过去即可。因为确实蛮多的。

也因为实现 Deque 即可以作为队列使用，也可以作为栈使用。当然，作为双端队列，也是可以的。

继承了 java.util.AbstractSequentialList 抽象类，它是 AbstractList 的子类，实现了只能连续访问“数据存储”（例如说链表）的 #get(int index)、#add(int index, E element) 等等随机操作的方法。可能这样表述有点抽象，点到 java.util.AbstractSequentialList 抽象类中看看这几个方法，基于迭代器顺序遍历后，从而实现后续的操作。

但是呢，LinkedList 和 ArrayList 多是一个有点“脾气”的小伙子，都为了结合自身的特性，更加高效的实现，多选择了重写了 AbstractSequentialList 的方法，嘿嘿。
不过一般情况下，对于支持随机访问数据的继承 AbstractList 抽象类，不支持的继承 AbstractSequentialList 抽象类。

3. 属性

LinkedList 一共有 3 个属性。如下图所示：

LinkedList

通过 Node 节点指向前后节点，从而形成双向链表。
first 和 last 属性：链表的头尾指针。
- 在初始时候，first 和 last 指向 null ，因为此时暂时没有 Node 节点。
- 在添加完首个节点后，创建对应的 Node 节点 node1 ，前后指向 null 。此时，first 和 last 指向该 Node 节点。
- 继续添加一个节点后，创建对应的 Node 节点 node2 ，其 prev = node1 和 next = null ，而 node1 的 prev = null 和 next = node2 。此时，first 保持不变，指向 node1 ，last 发生改变，指向 node2 。
size 属性：链表的节点数量。通过它进行计数，避免每次需要 List 大小时，需要从头到尾的遍历。

对应代码如下：

// LinkedList.java

/**
 * 链表大小
 */
transient int size = 0;

/**
 * 头节点
 *
 * Pointer to first node.
 */
transient Node<E> first;

/**
 * 尾节点
 *
 * Pointer to last node.
 */
transient Node<E> last;

/**
 * 节点
 *
 * @param <E> 元素泛型
 */
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. 构造方法

ArrayList 一共有两个构造方法，我们分别来看看。代码如下：

public LinkedList() {
}

public LinkedList(Collection<? extends E> c) {
    this();
    // 添加 c 到链表中
    addAll(c);
}

相比 ArrayList 来说，因为没有容量一说，所以不需要提供 #ArrayList(int initialCapacity) 这样的构造方法。

5. 添加单个元素

#add(E e) 方法，顺序添加单个元素到链表。代码如下：

// LinkedList.java

public boolean add(E e) {
    // <X> 添加末尾
    linkLast(e);
    return true;
}

void linkLast(E e) {
    // <1> 记录原 last 节点
    final Node<E> l = last;
    // <2> 创建新节点
    // 第一个参数表示，newNode 的前一个节点为 l 。
    // 第二个参数表示，e 为元素。
    // 第三个参数表示，newNode 的后一个节点为 null 。
    final Node<E> newNode = new Node<>(l, e, null);
    // <3> last 指向新节点
    last = newNode;
    // <4.1> 如果原 last 为 null ，说明 first 也为空，则 first 也指向新节点
    if (l == null)
        first = newNode;
    // <4.2> 如果原 last 非 null ，说明 first 也非空，则原 last 的 next 指向新节点。
    else
        l.next = newNode;
    // <5> 增加链表大小
    size++;
    // <6> 增加数组修改次数
    modCount++;
}

<X> 处，调用 #linkLast(E e) 方法，将新元素添加到链表的尾巴。所以，#add(E e) 方法，实际就是 #linkLast(E e) 方法。
总体来说，代码实现比较简单。重点就是对 last 的处理。
相比 ArrayList 来说，无需考虑容量不够时的扩容。

看懂这个方法后，我们来看看 #add(int index, E element) 方法，插入单个元素到指定位置。代码如下：

// LinkedList.java

public void add(int index, E element) {
    // 校验不要超过范围
    checkPositionIndex(index);

    // <1> 如果刚好等于链表大小，直接添加到尾部即可
    if (index == size)
        linkLast(element);
    // <2> 添加到第 index 的节点的前面
    else
        linkBefore(element, node(index));
}

<1> 处，如果刚好等于链表大小，直接调用 #linkLast(E element) 方法，添加到尾部即可。
<2> 处，先调用 #node(int index) 方法，获得第 index 位置的 Node 节点 node 。然后，调用 #linkBefore(E element, Node node) 方法，将新节点添加到 node 的前面。相当于说，node 的前一个节点的 next 指向新节点，node 的 prev 指向新节点。

#node(int index) 方法，获得第 index 个 Node 节点。代码如下：

// LinkedList.java

Node<E> node(int index) {
    // assert isElementIndex(index);

    // 如果 index 小于 size 的一半，就正序遍历，获得第 index 个节点
    if (index < (size >> 1)) {
        Node<E> x = first;
        for (int i = 0; i < index; i++)
            x = x.next;
        return x;
    // 如果 index 大于 size 的一半，就倒序遍历，获得第 index 个节点
    } else {
        Node<E> x = last;
        for (int i = size - 1; i > index; i--)
            x = x.prev;
        return x;
    }
}

这里 LinkedList 做的一个小骚操作，根据 index 是否超过链表的一半大小，选择是否使用倒序遍历替代正序遍历，从而减少遍历次数。

#linkBefore(E e, Node<E> succ) 方法，添加元素 e 到 succ 节点的前面。代码如下：

// LinkedList.java

void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    // 获得 succ 的前一个节点
    final Node<E> pred = succ.prev;
    // 创建新的节点 newNode
    final Node<E> newNode = new Node<>(pred, e, succ);
    // <Y> 设置 succ 的前一个节点为新节点
    succ.prev = newNode;
    // 如果 pred 为 null ，说明 first 也为空，则 first 也指向新节点
    if (pred == null)
        first = newNode;
    // 如果 pred 非 null ，说明 first 也为空，则 pred 也指向新节点
    else
        pred.next = newNode;
    // 增加链表大小
    size++;
    // 增加数组修改次数
    modCount++;
}

逻辑上，和 #linkLast(E e) 方法差不多。差别在于 <Y> 处，设置 succ 的前一个节点为新节点。

因为 LinkedList 实现了 Deque 接口，所以它实现了 #addFirst(E e) 和 #addLast(E e) 方法，分别添加元素到链表的头尾。代码如下：

// LinkedList.java 实现 Deque 接口

public void addFirst(E e) {
    linkFirst(e);
}
public boolean offerFirst(E e) {
    addFirst(e); // 调用上面的方法
    return true;
}

public void addLast(E e) {
    linkLast(e);
}
public boolean offerLast(E e) {
    addLast(e); // 调用上面的方法
    return true;
}

#linkLast(E e) 方法，和 #add(E e) 方法是一致的，就不哔哔了。

#addFirst(E e) 方法，调用 #linkFirst(E e) 方法，添加元素到队头。代码如下：

// LinkedList.java

private void linkFirst(E e) {
    // 记录原 first 节点
    final Node<E> f = first;
    // 创建新节点
    final Node<E> newNode = new Node<>(null, e, f);
    // first 指向新节点
    first = newNode;
    // 如果原 first 为空，说明 last 也为空，则 last 也指向新节点
    if (f == null)
        last = newNode;
    // 如果原 first 非空，说明 last 也非空，则原 first 的 next 指向新节点。
    else
        f.prev = newNode;
    // 增加链表大小
    size++;
    // 增加数组修改次数
    modCount++;
}

逻辑上，和 #linkLast(E e) 方法差不多。就不重复哔哔了。

因为 LinkedList 实现了 Queue 接口，所以它实现了 #push(E e) 和 #offer(E e) 方法，添加元素到链表的头尾。代码如下：

// LinkedList.java 实现 Queue 接口

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

public boolean offer(E e) {
    return add(e);
}

总的来说，添加单个元素，分成三个情况：

添加元素到队头
添加元素到队尾
添加元素到中间

对于链表的操作，代码会比较简洁。

6. 链表扩容

LinkedList 不存在扩容的需求，因为通过 Node 的前后指向即可。

7. 添加多个元素

#addAll(Collection<? extends E> c) 方法，批量添加多个元素。代码如下：

// LinkedList.java

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

public boolean addAll(int index, Collection<? extends E> c) {
    checkPositionIndex(index);

    // <1> 将 c 转成 a 数组
    Object[] a = c.toArray();
    int numNew = a.length;
    if (numNew == 0) // 如果无添加元素，直接返回 false 数组未变更
        return false;

    // <2> 获得第 index 位置的节点 succ ，和其前一个节点 pred
    Node<E> pred, succ;
    if (index == size) { // 如果 index 就是链表大小，那说明插入队尾，所以 succ 为 null ，pred 为 last 。
        succ = null;
        pred = last;
    } else { // 如果 index 小于链表大小，则 succ 是第 index 个节点，prev 是 succ 的前一个二节点。
        succ = node(index);
        pred = succ.prev;
    }

    // <3> 遍历 a 数组，添加到 pred 的后面
    for (Object o : a) {
        // 创建新节点
        @SuppressWarnings("unchecked") E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        // 如果 pred 为 null ，说明 first 也为 null ，则直接将 first 指向新节点
        if (pred == null)
            first = newNode;
        // pred 下一个指向新节点
        else
            pred.next = newNode;
        // 修改 pred 指向新节点
        pred = newNode;
    }

    // <4> 修改 succ 和 pred 的指向
    if (succ == null) { // 如果 succ 为 null ，说明插入队尾，则直接修改 last 指向最后一个 pred
        last = pred;
    } else { // 如果 succ 非 null ，说明插入到 succ 的前面
        pred.next = succ; // prev 下一个指向 succ
        succ.prev = pred; // succes 前一个指向 pred
    }

    // <5> 增加链表大小
    size += numNew;
    // <6> 增加数组修改次数
    modCount++;
    // 返回 true 数组有变更
    return true;
}

#addAll(Collection<? extends E> c) 方法，其内部调用的是 #addAll(int index, Collection<? extends E> c) 方法，表示在队列之后，继续添加 c 集合。
<2> 处，获得第 index 位置的节点 succ ，和其前一个节点 pred 。分成两种情况，看注释。实际上，ArrayList 在添加 c 集合的时候，也是分成跟 LinkedList 一样的两种情况，只是说 LinkedList 在一个方法统一实现了。
<3> 处，遍历 a 数组，添加到 pred 的后面。其实，我们可以把 pred 理解成“尾巴”，然后不断的指向新节点，而新节点又称为新的 pred 尾巴。如此反复插入~
<4> 处，修改 succ 和 pred 的指向。根据 <2> 处分的两种情况，进行处理。
虽然很长，但是还是很简单的。

8. 移除单个元素

#remove(int index) 方法，移除指定位置的元素，并返回该位置的原元素。代码如下：

// LinkedList.java

public E remove(int index) {
    checkElementIndex(index);
    // 获得第 index 的 Node 节点，然后进行移除。
    return unlink(node(index));
}

首先，调用 #node(int index) 方法，获得第 index 的 Node 节点。然后偶，调用 #unlink(Node<E> x) 方法，移除该节点。

#unlink(Node<E> x) 方法，代码如下：

// LinkedList.java

E unlink(Node<E> x) {
    // assert x != null;
    // <1> 获得 x 的前后节点 prev、next
    final E element = x.item;
    final Node<E> next = x.next;
    final Node<E> prev = x.prev;

    // <2> 将 prev 的 next 指向下一个节点
    if (prev == null) { // <2.1> 如果 prev 为空，说明 first 被移除，则直接将 first 指向 next
        first = next;
    } else { // <2.2> 如果 prev 非空
        prev.next = next; // prev 的 next 指向 next
        x.prev = null; // x 的 pre 指向 null
    }

    // <3> 将 next 的 prev 指向上一个节点
    if (next == null) { // <3.1> 如果 next 为空，说明 last 被移除，则直接将 last 指向 prev
        last = prev;
    } else { // <3.2> 如果 next 非空
        next.prev = prev; // next 的 prev 指向 prev
        x.next = null; // x 的 next 指向 null
    }

    // <4> 将 x 的 item 设置为 null ，帮助 GC
    x.item = null;
    // <5> 减少链表大小
    size--;
    // <6> 增加数组的修改次数
    modCount++;
    return element;
}

<2> 处，将 prev 的 next 指向下一个节点。其中，<2.1> 处，是移除队头 first 的情况。
<3> 处，将 next 的 prev 指向上一个节点。其中，<3.1> 处，如果 next 为空，说明队尾 last 被移除的情况。

#remove(Object o) 方法，移除首个为 o 的元素，并返回是否移除到。代码如下：

// LinkedList.java

public boolean remove(Object o) {
    if (o == null) { // o 为 null 的情况
        // 顺序遍历，找到 null 的元素后，进行移除
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        // 顺序遍历，找到等于 o 的元素后，进行移除
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

相比 #remove(int index) 方法来说，需要去寻找首个等于 o 的节点进行移除。当然，最终还是调用 #unlink(Node<E> x) 方法，移除该节点。

#removeFirstOccurrence(Object o) 和 #removeLastOccurrence(Object o) 方法，分别实现移除链表首个节点和最后节点。代码如下：

// LinkedList.java 实现 Deque 接口

public boolean removeFirstOccurrence(Object o) { // 移除首个
    return remove(o);
}

public boolean removeLastOccurrence(Object o) {
    if (o == null) { // o 为 null 的情况
        // 倒序遍历，找到 null 的元素后，进行移除
        for (Node<E> x = last; x != null; x = x.prev) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        // 倒序遍历，找到等于 o 的元素后，进行移除
        for (Node<E> x = last; x != null; x = x.prev) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

#remove() 方法，移除链表首个节点。代码如下：

// LinkedList.java 实现 Queue 接口

public E remove() {
    return removeFirst();
}

public E removeFirst() {
    final Node<E> f = first;
    // <1> 如果链表为空，抛出 NoSuchElementException 异常
    if (f == null)
        throw new NoSuchElementException();
    // <2> 移除链表时首个元素
    return unlinkFirst(f);
}

private E unlinkFirst(Node<E> f) {
    // assert f == first && f != null;
    final E element = f.item;
    // 获得 f 的下一个节点
    final Node<E> next = f.next;
    // 设置 f 的 item 为 null ，帮助 GC
    f.item = null;
    // 设置 f 的 next 为 null ，帮助 GC
    f.next = null; // help GC
    // 修改 fisrt 指向 next
    first = next;
    // 修改 next 节点的 prev 指向 null
    if (next == null) // 如果链表只有一个元素，说明被移除后，队列就是空的，则 last 设置为 null
        last = null;
    else
        next.prev = null;
    // 链表大小减一
    size--;
    // 增加数组修改次数
    modCount++;
    return element;
}

<1> 处，如果链表为空，抛出 NoSuchElementException 异常。
<2> 处，移除链表时首个元素。因为 LinkedList 有 first 和 last 头尾节点，所以添加和删除操作，都可能需要小心处理。

#removeLast() 方法，移除链表最后一个节点。代码如下：

// LinkedList.java 实现 Deque 接口

public E removeLast() {
    final Node<E> l = last;
    // 如果链表为空，则抛出 NoSuchElementException 移除
    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;
    // 获得 f 的上一个节点
    final Node<E> prev = l.prev;
    // 设置 l 的 item 为 null ，帮助 GC
    l.item = null;
    // 设置 l 的 prev 为 null ，帮助 GC
    l.prev = null; // help GC
    // 修改 last 指向 prev
    last = prev;
    // 修改 prev 节点的 next 指向 null
    if (prev == null) // 如果链表只有一个元素，说明被移除后，队列就是空的，则 first 设置为 null
        first = null;
    else
        prev.next = null;
    // 链表大小减一
    size--;
    // 增加数组修改次数
    modCount++;
    return element;
}

和 #removeFirst() 方法相反，当然实现上是差不多。

#poll() 和 # 方法，移除链表的头或尾，差异点在于链表为空时候，不会抛出 NoSuchElementException 异常。代码如下：

// LinkedList.java 实现 Queue 接口

public E poll() { // 移除头
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

public E pop() {
    return removeFirst(); // 这个方法，如果队列为空，还是会抛出 NoSuchElementException 异常。不知道放在哪里哈。这里来凑凑~
}

// LinkedList.java 实现 Deque 接口

public E pollFirst() { // 移除头
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

public E pollLast() { // 移除尾
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

9. 移除多个元素

#removeAll(Collection<?> c) 方法，批量移除指定的多个元素。代码如下：

// AbstractCollection.java

public boolean removeAll(Collection<?> c) {
    Objects.requireNonNull(c);
    boolean modified = false;
    // 获得迭代器
    Iterator<?> it = iterator();
    // 通过迭代器遍历
    while (it.hasNext()) {
        // 如果 c 中存在该元素，则进行移除
        if (c.contains(it.next())) {
            it.remove();
            modified = true; // 标记修改
        }
    }
    return modified;
}

该方法，是通过父类 AbstractCollection 来实现的，通过迭代器来遍历 LinkedList ，然后判断 c 中如果包含，则进行移除。

#retainAll(Collection<?> c) 方法，求 LinkedList 和指定多个元素的交集。简单来说，恰好和 #removeAll(Collection<?> c) 相反，移除不在 c 中的元素。代码如下：

// AbstractCollection.java

public boolean retainAll(Collection<?> c) {
    Objects.requireNonNull(c);
    boolean modified = false;
    // 获得迭代器
    Iterator<E> it = iterator();
    // 通过迭代器遍历
    while (it.hasNext()) {
        // <X> 如果 c 中不存在该元素，则进行移除
        if (!c.contains(it.next())) {
            it.remove();
            modified = true;
        }
    }
    return modified;
}

逻辑比较简单，<X> 处的判断条件进行了调整。

10. 查找单个元素

#indexOf(Object o) 方法，查找首个为指定元素的位置。代码如下：

// LinkedList.java

public int indexOf(Object o) {
    int index = 0;
    if (o == null) { // 如果 o 为 null 的情况
        // 顺序遍历，如果 item 为 null 的节点，进行返回
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null)
                return index; // 找到
            index++;
        }
    } else { // 如果 o 非 null 的情况
        // 顺序遍历，如果 item 为 o 的节点，进行返回
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item))
                return index; // 找到
            index++;
        }
    }
    // 未找到
    return -1;
}

而 #contains(Object o) 方法，就是基于该方法实现。代码如下：

// LinkedList.java

public boolean contains(Object o) {
    return indexOf(o) >= 0;
}

有时我们需要查找最后一个为指定元素的位置，所以会使用到 #lastIndexOf(Object o) 方法。代码如下：

// LinkedList.java

public int lastIndexOf(Object o) {
    int index = size;
    if (o == null) { // 如果 o 为 null 的情况
        // 倒序遍历，如果 item 为 null 的节点，进行返回
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (x.item == null)
                return index; // 找到
        }
    } else { // 如果 o 非 null 的情况
        // 倒序遍历，如果 item 为 o 的节点，进行返回
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (o.equals(x.item))
                return index; // 找到
        }
    }
    // 未找到
    return -1;
}

11. 获得指定位置的元素

#get(int index) 方法，获得指定位置的元素。代码如下：

// LinkedList.java

public E get(int index) {
    checkElementIndex(index);
    // 基于 node(int index) 方法实现
    return node(index).item;
}

随机访问 index 位置的元素，时间复杂度为 O(n) 。

因为 LinkedList 实现了 Deque 接口，所以它实现了 #peekFirst() 和 #peekLast() 方法，分别获得元素到链表的头尾。代码如下：

// LinkedList.java 实现 Deque 接口

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

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

因为 LinkedList 实现了 Queue 接口，所以它实现了 #peek() 和 #peek() 和 #element() 方法，分别获得元素到链表的头。代码如下：

// LinkedList.java 实现 Queue 接口

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

public E element() { // 如果链表为空识，抛出 NoSuchElementException 异常
    return getFirst();
}
public E getFirst() {
    final Node<E> f = first;
    if (f == null) // 如果链表为空识，抛出 NoSuchElementException 异常
        throw new NoSuchElementException();
    return f.item;
}

12. 设置指定位置的元素

#set(int index, E element) 方法，设置指定位置的元素。代码如下：

// LinkedList.java

public E set(int index, E element) {
    checkElementIndex(index);
    // 获得第 index 位置的节点
    Node<E> x = node(index);
    E oldVal = x.item;
    // 修改对应的值
    x.item = element;
    return oldVal;
}

13. 转换成数组

#toArray() 方法，将 ArrayList 转换成 [] 数组。代码如下：

// LinkedList.java

public Object[] toArray() {
    // 创建 Object 数组
    Object[] result = new Object[size];
    // 顺序遍历节点，设置到 Object 数组中
    int i = 0;
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;
    return result;
}

实际场景下，我们可能想要指定 T 泛型的数组，那么我们就需要使用到 #toArray(T[] a) 方法。代码如下：

// LinkedList.java

public <T> T[] toArray(T[] a) {
    // <1> 如果传入的数组小于 size 大小，则直接复制一个新数组返回
    if (a.length < size)
        a = (T[])java.lang.reflect.Array.newInstance(
                            a.getClass().getComponentType(), size);
    // <2> 顺序遍历链表，复制到 a 中
    int i = 0;
    Object[] result = a;
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;

    // <2.1> 如果传入的数组大于 size 大小，则将 size 赋值为 null
    if (a.length > size)
        a[size] = null;

    // <2.2> 返回 a
    return a;
}

14. 求哈希值

#hashCode() 方法，求 LinkedList 的哈希值。代码如下：

// AbstractList.java

public int hashCode() {
    int hashCode = 1;
    // 遍历，求哈希
    for (E e : this)
        hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
    return hashCode;
}

该方法，是通过父类 AbstractList 来实现的，通过 for 来遍历 LinkedList ，然后进行求哈希。可能有不了解 for( : ) 语法糖，它最终会编译转换成 Iterator 迭代器。

15. 判断相等

#equals(Object o) 方法，判断是否相等。代码如下：

// AbstractList.java

public boolean equals(Object o) {
    // 如果 o 就是自己，直接返回 true
    if (o == this)
        return true;
    // 如果不为 List 类型，直接返回 false
    if (!(o instanceof List))
        return false;

    // 创建迭代器，顺序遍历比对
    ListIterator<E> e1 = listIterator();
    ListIterator<?> e2 = ((List<?>) o).listIterator();
    while (e1.hasNext() && e2.hasNext()) {
        E o1 = e1.next();
        Object o2 = e2.next();
        if (!(o1==null ? o2==null : o1.equals(o2))) // 如果不相等，返回 false
            return false;
    }
    // 如果有迭代器没有遍历完，说明两者长度不等，所以就不相等；否则，就相等了
    return !(e1.hasNext() || e2.hasNext());
}

该方法，是通过父类 AbstractList 来实现的，通过迭代器，实现遍历比对。

16. 清空链表

#clear() 方法，清空链表。代码如下：

// LinkedList.java

public void clear() {
    // Clearing all of the links between nodes is "unnecessary", but:
    // - helps a generational GC if the discarded nodes inhabit
    //   more than one generation
    // - is sure to free memory even if there is a reachable Iterator
    // 顺序遍历链表，设置每个节点前后指向为 null
    // 通过这样的方式，帮助 GC
    for (Node<E> x = first; x != null; ) {
        // 获得下一个节点
        Node<E> next = x.next;
        // 设置 x 的 item、next、prev 为空。
        x.item = null;
        x.next = null;
        x.prev = null;
        // 设置 x 为下一个节点
        x = next;
    }
    // 清空 first 和 last 指向
    first = last = null;
    // 设置链表大小为 0
    size = 0;
    // 增加数组修改次数
    modCount++;
}

17. 序列化链表

#writeObject(java.io.ObjectOutputStream s) 方法，实现 LinkedList 的序列化。代码如下：

// LinkedList.java

@java.io.Serial
private void writeObject(java.io.ObjectOutputStream s)
    throws java.io.IOException {
    // Write out any hidden serialization magic
    // 写入非静态属性、非 transient 属性
    s.defaultWriteObject();

    // Write out size
    // 写入链表大小
    s.writeInt(size);

    // Write out all elements in the proper order.
    // 顺序遍历，逐个序列化
    for (Node<E> x = first; x != null; x = x.next)
        s.writeObject(x.item);
}

18. 反序列化链表

#readObject(java.io.ObjectInputStream s) 方法，反序列化数组。代码如下：

// LinkedList.java

@java.io.Serial
private void readObject(java.io.ObjectInputStream s)
    throws java.io.IOException, ClassNotFoundException {
    // Read in any hidden serialization magic
    // 读取非静态属性、非 transient 属性
    s.defaultReadObject();

    // Read in size
    // 读取 size
    int size = s.readInt();

    // Read in all elements in the proper order.
    // 顺序遍历，逐个反序列化
    for (int i = 0; i < size; i++)
        linkLast((E)s.readObject()); // 添加到链表尾部
}

19. 克隆

#clone() 方法，克隆 LinkedList 对象。代码如下：

// LinkedList.java

public Object clone() {
    // 调用父类，进行克隆
    LinkedList<E> clone = superClone();

    // Put clone into "virgin" state
    // 重置 clone 为初始化状态
    clone.first = clone.last = null;
    clone.size = 0;
    clone.modCount = 0;

    // Initialize clone with our elements
    // 遍历遍历，逐个添加到 clone 中
    for (Node<E> x = first; x != null; x = x.next)
        clone.add(x.item);

    return clone;
}

注意，first、last 等都是重新初始化进来，不与原 LinkedList 共享。

20. 创建子数组

#subList(int fromIndex, int toIndex) 方法，创建 ArrayList 的子数组。代码如下：

// AbstractList.java

public List<E> subList(int fromIndex, int toIndex) {
    subListRangeCheck(fromIndex, toIndex, size());
    // 根据判断 RandomAccess 接口，判断是否支持随机访问
    return (this instanceof RandomAccess ?
            new RandomAccessSubList<>(this, fromIndex, toIndex) :
            new SubList<>(this, fromIndex, toIndex));
}

该方法，是通过父类 AbstractList 来实现的。
根据判断 RandomAccess 接口，判断是否支持随机访问，从而创建 RandomAccessSubList 或 SubList 对象。

21. 创建 Iterator 迭代器

#iterator() 方法，创建迭代器。代码如下：

// AbstractSequentialList.java
public Iterator<E> iterator() {
    return listIterator();
}

// AbstractList.java
public ListIterator<E> listIterator() {
    return listIterator(0);
}

// AbstractSequentialList.java
public abstract ListIterator<E> listIterator(int index);

该方法，是通过父类 AbstractSequentialList 来实现的。
整个调用过程是，iterator() => listIterator() => listIterator(int index) 的顺序，就是我们在代码里贴进去的顺序。最终呢，是调用 LinkedList 对 #listIterator(int index) 的实现，我们在「22. 创建 ListIterator 迭代器」小节来看。

22. 创建 ListIterator 迭代器

#listIterator(int index) 方法，创建 ListIterator 迭代器。代码如下：

// LinkedList.java

public ListIterator<E> listIterator(int index) {
    checkPositionIndex(index);
    return new ListItr(index);
}

创建 ListItr 迭代器。

因为 ListItr 的实现代码比较简单，我们就不逐个来看了，直接贴加了注释的代码。代码如下：

// LinkedList.java

private class ListItr implements ListIterator<E> {

    /**
     * 最后返回的节点
     */
    private Node<E> lastReturned;
    /**
     * 下一个节点
     */
    private Node<E> next;
    /**
     * 下一个访问元素的位置，从下标 0 开始。
     *
     * 主要用于 {@link #nextIndex()} 中，判断是否遍历结束
     */
    private int nextIndex;
    /**
     * 创建迭代器时，数组修改次数。
     *
     * 在迭代过程中，如果数组发生了变化，会抛出 ConcurrentModificationException 异常。
     */
    private int expectedModCount = modCount;

    ListItr(int index) {
        // assert isPositionIndex(index);
        // 获得下一个节点
        next = (index == size) ? null : node(index);
        // 下一个节点的位置
        nextIndex = index;
    }

    public boolean hasNext() {
        return nextIndex < size;
    }

    public E next() {
        // 校验是否数组发生了变化
        checkForComodification();
        // 如果已经遍历到结尾，抛出 NoSuchElementException 异常
        if (!hasNext())
            throw new NoSuchElementException();

        // lastReturned 指向，记录最后访问节点
        lastReturned = next;
        // next 指向，下一个节点
        next = next.next;
        // 下一个节点的位置 + 1
        nextIndex++;
        // 返回 lastReturned
        return lastReturned.item;
    }

    public boolean hasPrevious() {
        return nextIndex > 0;
    }

    public E previous() {
        // 校验是否数组发生了变化
        checkForComodification();
        // 如果已经遍历到结尾，抛出 NoSuchElementException 异常
        if (!hasPrevious())
            throw new NoSuchElementException();

        // 修改 lastReturned 和 next 的指向。此时，lastReturned 和 next 是相等的。
        lastReturned = next = (next == null) ? last : next.prev;
        // 下一个节点的位置 - 1
        nextIndex--;
        // 返回 lastReturned
        return lastReturned.item;
    }

    public int nextIndex() {
        return nextIndex;
    }

    public int previousIndex() {
        return nextIndex - 1;
    }

    public void remove() {
        // 校验是否数组发生了变化
        checkForComodification();
        // 如果 lastReturned 为空，抛出 IllegalStateException 异常，因为无法移除了。
        if (lastReturned == null)
            throw new IllegalStateException();

        // 获得 lastReturned 的下一个
        Node<E> lastNext = lastReturned.next;
        // 移除 lastReturned 节点
        unlink(lastReturned);
        // 此处，会分成两种情况
        if (next == lastReturned) // 说明发生过调用 `#previous()` 方法的情况，next 指向下一个节点，而 nextIndex 是无需更改的
            next = lastNext;
        else
            nextIndex--; // nextIndex 减一。

        // 设置 lastReturned 为空
        lastReturned = null;
        // 增加数组修改次数
        expectedModCount++;
    }

    public void set(E e) {
        // 如果 lastReturned 为空，抛出 IllegalStateException 异常，因为无法修改了。
        if (lastReturned == null)
            throw new IllegalStateException();
        // 校验是否数组发生了变化
        checkForComodification();
        // 修改 lastReturned 的 item 为 e
        lastReturned.item = e;
    }

    public void add(E e) {
        // 校验是否数组发生了变化
        checkForComodification();
        // 设置 lastReturned 为空
        lastReturned = null;
        // 此处，会分成两种情况
        if (next == null) // 如果 next 已经遍历到尾，则 e 作为新的尾节点，进行插入。算是性能优化
            linkLast(e);
        else // 插入到 next 的前面
            linkBefore(e, next);
        // nextIndex 加一。
        nextIndex++;
        // 增加数组修改次数
        expectedModCount++;
    }

    public void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        // 遍历剩余链表
        while (modCount == expectedModCount && nextIndex < size) {
            // 执行 action 逻辑
            action.accept(next.item);
            // lastReturned 指向 next
            lastReturned = next;
            //  next 指向下一个节点
            next = next.next;
            // nextIndex 加一。
            nextIndex++;
        }
        // 校验是否数组发生了变化
        checkForComodification();
    }

    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }

}

虽然有点长，但是保持淡定哟。

路从脚起

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
精尽 JDK 源码解析 —— 集合（二）链表 LinkedList

LinkedList ，基于节点实现的双向链表的 List ，每个节点都指向前一个和后一个节点从而形成链表。相比 ArrayList 来说，我们日常开发使用 LinkedList 相对比较少。打开 IDEA ，搜下项目中 LinkedList 后，会发现使用的少之又少。
复制链接

扫一扫