(Queue)LinkedList

felix.shao2025-02-16

(Queue)LinkedList

简述

核心内容

数据结构。
初始化。
添加元素。
移除元素。
查找。
扩容（含自动扩容）。
队列方法。
栈方法。

LinkedList 简介

LinkedList 是 JDK1.2 开始支持的。
LinkedList 同时实现了 List 接口和 Deque 接口，也就是说它既可以看作一个顺序容器，又可以看作一个队列（Queue），同时又可以看作一个栈（Stack）。这样看来，LinkedList 简直就是个全能冠军。当你需要使用栈或者队列时，可以考虑使用 LinkedList，一方面是因为 Java 官方已经声明不建议使用 Stack 类，更遗憾的是，Java 里根本没有一个叫做 Queue 的类(它是个接口名字)。关于栈或队列，现在的首选是 ArrayDeque，它有着比 LinkedList （当作栈或队列使用时）有着更好的性能。

LinkedList 的实现方式决定了所有跟下标相关的操作都是线性时间，而在首段或者末尾删除元素只需要常数时间。为追求效率 LinkedList 没有实现同步（synchronized），如果需要多个线程并发访问，可以先采用Collections.synchronizedList() 方法对其进行包装。

详述

LinkedList 类图

AbstractSequentialList 抽象类：顺序访问的 list。
Deque: 双向队列

数据结构和核心方法

LinkedList 底层通过双向链表实现，本节将着重讲解插入和删除元素时双向链表的维护过程，也即是之间解跟 List 接口相关的函数，而将 Queue 和 Stack 以及 Deque 相关的知识放在对应小节讲。双向链表的每个节点用内部类 Node 表示。LinkedList 通过 first 和 last 引用分别指向链表的第一个和最后一个元素。注意这里没有所谓的哑元，当链表为空的时候 first 和 last 都指向 null。

public class LinkedList<E> ...{

    /** 链表长度 */
    transient int size = 0;

    /** 链表 head */
    transient Node<E> first;

    /** 链表 last */
    transient Node<E> last;

    public boolean addFirst(E e)...

    public boolean addLast(E e)...

    public boolean add(E e)...

    public boolean addAll(Collection<? extends E> c)...

    public boolean addAll(int index, Collection<? extends E> c)...

    public E get(int index)...

    public E getFirst()...

    public E getLast()...

    public E removeFirst()...

    public E removeLast()...
    
    public boolean remove(Object o)...
    
    public E remove(int index)...

    public void clear()...

    /** 链表节点结构 */
    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;
      }
    }
}

&emsp;数据结构主要是 first、last、size。

TIP

LinkedList 中 first、last、size 为什么被 transient 修饰?
答案同 ArrayList。

初始化

public LinkedList() {
}

public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

添加元素-add

/** 添加一个元素，直接添加链表 head */
public void addFirst(E e) {
    linkFirst(e);
}

/** 添加一个元素，直接添加链表 last */
public void addLast(E e) {
    linkLast(e);
}

/** 添加一个元素 */
public boolean add(E e) {
    linkLast(e);
    return true;
}

/** 添加节点到 head */
private void linkFirst(E e) {
    final Node<E> f = first;
    final Node<E> newNode = new Node<>(null, e, f);
    first = newNode;
    if (f == null)
        last = newNode;
    else
        f.prev = newNode;
    size++;
    modCount++;
}

/** 添加节点到 last */
void linkLast(E e) {
    final Node<E> l = last;
    final Node<E> newNode = new Node<>(l, e, null);
    last = newNode;
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    size++;
    modCount++;
}

添加元素-addAll

/** 在 last处开始添加集合的所有元素 */
public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

/** 在指定索引处开始添加集合的所有元素 */
public boolean addAll(int index, Collection<? extends E> c) {
    // 检查索引范围是否合理，代码略
    checkPositionIndex(index);

    // 新元素为空，直接返回
    Object[] a = c.toArray();
    int numNew = a.length;
    if (numNew == 0)
        return false;

    // 链表插入元素法，succ 保存 index 位置的节点，prev 开始为 index 节点的前驱节点
    Node<E> pred, succ;
    if (index == size) {
        // 相当于tail添加元素
        succ = null;
        pred = last;
    } else {
        succ = node(index);
        pred = succ.prev;
    }

    // 在 pred 元素后循环添加新节点
    for (Object o : a) {
        @SuppressWarnings("unchecked") E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        pred = newNode;
    }

    // index 位置的节点前驱节点指向已添加好节点的 pred
    if (succ == null) {
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }

    size += numNew;
    modCount++;
    return true;
}

移除元素-remove

/** 移除链表 head */
public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

/** 移除链表 head */
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;
    size--;
    modCount++;
    return element;
}

/** 移除链表 last */
public E removeLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}

/** 移除链表 last */
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;
    size--;
    modCount++;
    return element;
}

/** 移除指定索引上的元素 */
public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

/** 移除指定的元素 */
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;
}

/** 快速移除指定索引的元素 */
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;
}

查找元素-get

/** 查找元素 */
public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

/** 查找链表 head */
public E getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}

/** 查找链表 last */
public E getLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return l.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;
    }
}

扩容(含自动扩容)

LinkedList 不需要扩容，他的长度是没有限制的。

其他方法-indexOf、lastIndexOf

/** 获取元素的第一次出现的 index */
public int indexOf(Object o) {
    int index = 0;
    if (o == null) {
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null)
                return index;
            index++;
        }
    } else {
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item))
                return index;
            index++;
        }
    }
    return -1;
}

/** 获取元素的最后一次出现的 index */
public int lastIndexOf(Object o) {
    int index = size;
    if (o == null) {
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (x.item == null)
                return index;
        }
    } else {
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (o.equals(x.item))
                return index;
        }
    }
    return -1;
}

其他方法-toArray

 public Object[] toArray() {
    Object[] result = new Object[size];
    int i = 0;
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;
    return result;
}

其他方法-clear

为了让 GC 更快可以回收放置的元素，需要将 node 之间的引用关系赋空。

public void clear() {
    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;
    size = 0;
    modCount++;
}

队列方法

TIP

注意用作栈时，方法要对应上，如 offer 添加，则要使用 poll 取出元素，因为每个方法的栈顶元素逻辑不一致，可能 tail 是栈顶（offer/poll），可能 head 是栈顶（push/pop）。

LinkedList Queue 实现

基本是复用了前面提过的方法

/** 添加元素，会添加到栈顶(这里 tail 是栈顶)后面 */
public boolean offer(E e) {
    return add(e);
}

/** 取出且移除栈顶元素 */
public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

/** 取出但不移除元素 */
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

/** 移除 head 元素 */
public E remove() {
    return removeFirst();
}

/** 获取 head */
public E element() {
    return getFirst();
}

LinkedList Deque 实现

/** 在 head 处添加元素 */
public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

/** 在 last 处添加元素 */
public boolean offerLast(E e) {
    addLast(e);
    return true;
}

/** 从 head 处 poll 元素 */
public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

/** 从 last 处 poll 元素  */
public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

/** 从 head 处 peek 元素 */
public E peekFirst() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

/** 从 last 处 peek 元素 */
public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

/** 模拟栈结构，先入栈的先出栈，head 处对应栈顶, 这个为入栈方法 */
public void push(E e) {
    addFirst(e);
}

/** 模拟栈结构，先入栈的先出栈，head 处对应栈顶, 这个为出栈方法 */
public E pop() {
    return removeFirst();
}

/** 从 head 开始往后查找，移除第一个找到的元素 */
public boolean removeFirstOccurrence(Object o) {
    return remove(o);
}

/** 从 last 开始往前查找，移除第一个找到的元素 */
public boolean removeLastOccurrence(Object o) {
    if (o == null) {
        for (Node<E> x = last; x != null; x = x.prev) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        for (Node<E> x = last; x != null; x = x.prev) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

总结

TIP

元素存放的数据与放进去的顺序相同，允许放入 null 元素。
非线程安全。
LinkedList 容量没有限制
查找：在物理内存上采用非线程存储结构，因此查询元素较慢。

参考文献

Collection - LinkedList 源码解析open in new window

(Queue)LinkedList

(Queue)LinkedList

简述

详述

总结

参考文献

ON THIS PAGE