LinkedList 源码解析

LinkedList 源码解析

三冬今足用,谁笑腹空虚

前面讲了ArrayList 的源码 ,作为 ArrayList 的近亲的 LinkedList,今天我们也来讲讲。

写在开篇

说 LinkedList 之前,我们先来回忆一下 数组链表

数组是一个线性的数据结构,便于检索,但是不利于中间插入(结尾插入很简单)和删除。所以 ArrayList 的 getset方法的时间复杂度都是O(1),但是remove方法却很复杂。

链表是一个链表形式数据结构,便于插入和删除,但是检索很麻烦。这也可以得出 LinkedList适用于频繁插入和删除的业务场景,也适合集合元素先入先出和先入后出的场景。

LinkedList 的整体架构

LinkedList 的底层数据结构是一个双向链表。基本的数据结构如下

LinkedList 底层结构图

我们先来对上图做一个说明:

  1. LinkedList 链表的每一个节点被称为 Node,没有个 Node 都有 prev 和 next。分别代表前一个节点的位置和后一个节点的位置。
  2. 没有链表都有一个 头节点:first和尾节点: last
  3. 头节点的 prev为 null ,尾节点的 next为 null
  4. 当链表中没有数据时,first 和 last 是同一个节点,前后指向都是 null;
  5. 因为是个双向链表,只要机器内存足够强大,是没有大小限制的。

LinkedList 类注释

和之前一样,我们还是先来看看 LinkedList 的类注释,并提取有用信息。

  • LinkedList 是一个双向链表, 实现所有可选的 List 操作,并允许所有元素的值为 null
  • LinkedList 不是一个线程安全的类, 可以使用List list = Collections.synchronizedList(new LinkedList(...));
  • 增强 for 循环,或者使用迭代器迭代过程中,如果数组大小被改变,会快速失败,抛出异常。

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 的源码很简单,里面只有三个属性:itemnextprev。 这三个属性的意思如下:

  • item: 当前节点的值
  • prev:表示前一个节点的位置
  • next:表示下一个节点的位置

这个内部类是 LinkedList 的核心。

这里就不讲 LinkedList 的构造函数了,下面来讲一些常用的方法,比如:add、remove

LinkedList 的 add 方法

我们直接看源码。

transient Node<E> first; // 头节点
transient Node<E> last; // 尾节点
public boolean add(E e) {
  // 从尾节点开始追加
    linkLast(e);
    return true;
}
// 从尾节点开始追加
void linkLast(E e) {
  // 1.将尾节点缓存起来
  final Node<E> l = last;
  // 2.新建一个节点,这个节点的前一个节点为 l, 下一个节点为 null ,也就是新的尾节点
  final Node<E> newNode = new Node<>(l, e, null);
  // 新的节点为尾节点
  last = newNode;
  // 3. 如果上一个节点为 null, 表示是空链表
  if (l == null)
    first = newNode;
  else
    // 新节点链接到链表尾部
    l.next = newNode;
  // 4. 链表的长度加1, 以及版本号变更
  size++;
  modCount++;
}

这个 add 方法其实就是在链表尾部追加一个新节点,在上面的代码片段,我们已经一步一步的解析了,我们进行一下说明。

  1. 这里的 modCount 和 ArrayList 中的 modCount 是一个意思;
  2. linkFirstlinkLast 的代码差不多,只是 linkFirst 里面是 prev。

5d5fc69600013e4803600240

LinkedList 的 remove 方法

public E remove() {
  // 从头节点开始删除
  return removeFirst();
}
public E removeFirst() {
  final Node<E> f = first;
  if (f == null)
    throw new NoSuchElementException();
  // 从头节点开始删除
  return unlinkFirst(f);
}

//从头删除节点 f 是链表头节点
private E unlinkFirst(Node<E> f) {
  // assert f == first && f != null;
  // 拿出头节点的值,作为方法的返回值
  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;
  else
    next.prev = null;
  //修改链表大小和版本
  size--;
  modCount++;
  return element;
}

LinkedList 类的 remove 方法,默认是从头节点开始删除。

节点查询

和 ArrayList 不同的是,LinkedList 获取指定节点的值比较复杂,需要遍历节点来获取指定节点。

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

可以看到,LinkedList 的查询方法,并不是逐个遍历节点来实现。而是通过二分查找算法。首先看看 index 是在链表的前半部分,还是后半部分。如果是前半部分,就从头开始寻找,反之亦然。通过这种方式,使循环的次数至少降低了一半,提高了查找的性能,这种思想值得我们借鉴。

关于二分查找算法,可以看看之前的一篇文章。二分查找算法

迭代器

因为 LinkedList 要实现双向的迭代访问,所以我们使用 Iterator 接口肯定不行了,因为 Iterator 只支持从头到尾的访问。Java 新增了一个迭代接口,叫做:ListIterator,这个接口提供了向前和向后的迭代方法,如下所示:

迭代顺序方法
从尾到头迭代方法hasPrevious、previous、previousIndex
从头到尾迭代方法hasNext、next、nextIndex

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 的全部了,我们在下一篇中自己实现一个 链表。

Copyright: 采用 知识共享署名4.0 国际许可协议进行许可

Links: https://baozi.fun/2020/02/16/java-linkedlist-source

Buy me a cup of coffee ☕.