Java 集合 - LinkedList

一、源码解析

(1). 属性

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

// 链首和链尾
transient Node<E> first;
transient Node<E> last;

内部类节点类：

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

(2). 构造方法

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

// 创建一个包含了 collection 的 LinkedList
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

(3). 增加元素

在链首增加元素的方法

// 在链首增加元素
public void addFirst(E e) {
    linkFirst(e);
}

// 同上
public void push(E e) {
    addFirst(e);
}

// 同上
// 不同的是有返回值，增加成功返回 true
public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

这些方法归根结底都是调用了 linkFirst 方法。如下：

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

改变指针指向即可，不需要像 ArrayList 那样还得将后面的元素往后挪动一个位置。

后面将要介绍的 linkLast、linkBefore 等方法是同样的原理。

在链尾增加元素的方法

// 在链尾增加一个元素
public void addLast(E e) {
    linkLast(e);
}

// 同上
// 有返回值，增加成功就返回 true
public boolean offerLast(E e) {
    addLast(e);
    return true;
}

// 同上
public boolean add(E e) {
    linkLast(e);
    return true;
}

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

归根揭底都是调用了 linkLast 方法。如下：

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

在链表中间位置增加元素的方法

public void add(int index, E element) {
    checkPositionIndex(index);
    if (index == size)
        linkLast(element);
    else
        linkBefore(element, node(index));
}

如果插入位置正好是链尾，调用 linkLast。否则就调用 linkBefore。

// 在 succ 节点之前插入元素 e
void linkBefore(E e, Node<E> succ) {
    final Node<E> pred = succ.prev;
    final Node<E> newNode = new Node<>(pred, e, succ);
    succ.prev = newNode;
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    size++;
    modCount++;
}

public boolean addAll(Collection<? extends E> c)：将一个 collection 的元素依次插入到链尾

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

public boolean addAll(int index, Collection<? extends E> c)：将一个 collection 插入到链表 index 位置之后

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

    Object[] a = c.toArray();
    int numNew = a.length;
    if (numNew == 0)
        return false;

    Node<E> pred, succ;
    if (index == size) {
        succ = null;
        pred = last;
    } else {
        succ = node(index);
        pred = succ.prev;
    }

    for (Object o : a) {
        E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        pred = newNode;
    }

    if (succ == null) {
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }

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

(4). 删除元素

删除链首节点的方法

// 删除链首节点
// 链首不能为空，否则抛出异常
// 删除链首节点并且返回该节点的元素
public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

// 同上
public E remove() {
    return removeFirst();
}

// 同上
public E pop() {
    return removeFirst();
}

// 允许链首为空
// 链首为空，返回 NULL。
// 链首不为空，删除链首节点并且返回该节点的元素
public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

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

归根揭底都是调用了 unlinkFirst 方法。如下：

private E unlinkFirst(Node<E> f) {
    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;
}

传进来的参数必须是链首节点。

返回值为链首节点的元素。

删除链尾节点的方法

// 若链尾为空，会抛出异常
// 链尾不为空，删除链尾节点并且返回该节点的元素
public E removeLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}

// 同上
// 不同的是允许链尾为空，此时返回 NULL
public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

归根到底，删除链尾节点的方法是 unlinkLast。如下：

private E unlinkLast(Node<E> l) {
    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)：删除 index 位置的节点

public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

先得到 index 位置的节点，然后调用 unlink 删除该节点并且返回该节点元素。

Node<E> node(int index)：返回 index 位置的节点

Node<E> node(int 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;
    }
}

E unlink(Node<E> x)：删除这个节点

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

返回删除的节点的元素。

public boolean remove(Object o)：删除这个元素

public boolean removeFirstOccurrence(Object o)：同上

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

public boolean removeFirstOccurrence(Object o) {
    return remove(o);
}

链表中可能有多个元素和这个元素相等。删除第一次出现的。顺序遍历。

public boolean removeLastOccurrence(Object o)：删除这个元素

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

链表中可能有多个元素和这个元素相等。删除最后一次出现的。倒序遍历。

public void clear()：清空链表，删除所有节点

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

(5). 修改元素

public E set(int index, E element)：index 位置的元素设置为 element

public E set(int index, E element) {
    checkElementIndex(index);
    Node<E> x = node(index);
    E oldVal = x.item;
    x.item = element;
    return oldVal;
}

(6). 查询元素

获得链首元素的方法

// 链首不能为空，否则会抛出异常。
// 返回值为链首的元素
public E getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}

// 同上
public E element() {
    return getFirst();
}

// 链首为空，返回 NULL
// 链首不为空，返回链首的元素
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

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

获得链尾元素的方法

// 链尾不能为空，否则抛出异常
// 返回值为链尾的元素
public E getLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return l.item;
}

// 链尾为空，返回 NULL
// 链尾不为空，返回链尾的元素
public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

public E get(int index)：获得 index 位置的元素

public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

越界检测。

node 方法找到该 index 位置的节点。

得到该节点的元素。

(7). 其他方法

// 判断是否包含一个元素
public boolean contains(Object o) {
    return indexOf(o) != -1;
}

// 链表长度
public int size() {
    return size;
}

// 克隆，数据复制
public Object clone() {
    LinkedList<E> clone = superClone();
    clone.first = clone.last = null;
    clone.size = 0;
    clone.modCount = 0;
    for (Node<E> x = first; x != null; x = x.next)
        clone.add(x.item);
    return clone;
}

private LinkedList<E> superClone() {
    try {
        return (LinkedList<E>) super.clone();
    } catch (CloneNotSupportedException e) {
        throw new InternalError();
    }
}

// 链表转换为数组
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;
}

public <T> T[] toArray(T[] a) {
    if (a.length < size)
        a = (T[])java.lang.reflect.Array.newInstance(
                            a.getClass().getComponentType(), size);
    int i = 0;
    Object[] result = a;
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;

    if (a.length > size)
        a[size] = null;

    return a;
}

二、总结

1). 由双向链表实现。

2). 非同步非线程安全。

3). 在 index 位置增加元素或删除元素时只需要修改链表指针指向即可，而 ArrayList 需要对 index 位置之后的所有元素进行挪动，所以 LinkedList 插入和删除的效率高。

4). 查询 index 位置的元素时 ArrayList 效率比 LinkedList 高（因为数组查询基于下标查询很快，而链表需要遍历查询）

5). 适合进行堆栈和队列操作。因为可以方便的操作链首和链尾。

6). 允许元素为空。

7). fast-fail 机制：原理同 ArrayList