Java集合框架源码——LinkedList解析

LinkedList 是一个链表，而 ArrayList 是基于数组来实现的。对于 LinkedList 来说，其插入和删除效率极高，因为不需要像 ArrayList 对数组进行拷贝等操作；但是其查找效率低，需要遍历来查找，而 ArrayList 使用数组来实现，直接通过下标来定位到元素。

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable

属性

三个属性都是不可序列化的：

    // List的容量
    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;
        }
    }

构造函数

有两个构造函数：

    // 空构造函数
    public LinkedList() {
    }
    // 根据给定的集合建立LinkedList
    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }

成员函数

增加元素

addFirst(E e)

addFirst 方法在 List 头部增加一个元素

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

    private void linkFirst(E e) {
        // 保存首节点的引用给f
        final Node<E> f = first;
        // 新增节点要作为第一个节点，其前驱节点为null，其后继节点为f
        final Node<E> newNode = new Node<>(null, e, f);
        // 将新增节点作为List的首节点
        first = newNode;
        // 如果f节点为null，末节点也是新增节点自身
        // 如果f不为null，那么f节点的前驱就是新增节点
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
        size++;
        // 快速失败modeCount值在结构改变后自增加一
        modCount++;
    }

addLast(E e)

addLast 方法在 List 的尾部添加一个元素。

    public void addLast(E e) {
        linkLast(e);
    }

    void linkLast(E e) {
        // 末尾节点last保留引用给l
        final Node<E> l = last;
        // 新建节点的后继为null，前驱为l节点
        final Node<E> newNode = new Node<>(l, e, null);
        last = newNode;
        if (l == null)
            first = newNode;
        else
            // 将新节点作为l节点的后继
            l.next = newNode;
        size++;
        modCount++;
    }

add(E e)

和 addLast 类似，在尾部增加节点，返回bool值

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

addAll(Collection<? extends E> c)

addAll 方法，将给定集合添加到当前 List 后。

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

    public boolean addAll(int index, Collection<? extends E> c) {
        // 检查当前添加的位置是否超过了List的大小
        checkPositionIndex(index);
        // 待添加的集合转化为数组
        Object[] a = c.toArray();
        // 待添加的数组长度如果为0，则不需要添加，返回false
        int numNew = a.length;
        if (numNew == 0)
            return false;

        // 声明两个引用
        Node<E> pred, succ;
        if (index == size) {
            // 如果刚好是在末尾添加，将当前last保存至pred
            succ = null;
            pred = last;
        } else {
            // 如果是在中间某目标位置添加，需要把目标位置的节点引用保存在succ中
            // 把succ的前驱节点保存在pred中
            // 等于把链从这里断开，新的节点需要加在这里
            succ = node(index);
            pred = succ.prev;
        }
        // 遍历数组，每一项组装节点，插入List中
        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;
        }
        // 如果是在末尾添加的，那只需要把最后的节点作为last即可
        if (succ == null) {
            last = pred;
        } else {
            // 如果不是在末尾添加的，那么需要把之前链断开的地方接上
            // 即将之前断开的第一个元素succ作为增加的最后一个元素pred的后继，即其前驱为pred
            // 这样整个链又衔接上了
            pred.next = succ;
            succ.prev = pred;
        }
        // List的大小增加了新数组的个数
        size += numNew;
        // 修改了List结构，modCount需要自增加一
        modCount++;
        return true;
    }

    private void checkPositionIndex(int index) {
        if (!isPositionIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

    private boolean isPositionIndex(int index) {
        return index >= 0 && index <= size;
    }

set(int index, E element)

在目标位置替换元素，返回老元素。替换只需要将节点的内容替换即可，前驱和后继节点都不需改动。

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

    private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

add(int index, E element)

在指定位置增加元素，和 addAll 类似，如果在末尾添加很简单，如果在中间添加，那么添加后需要把链“接上”。

    public void add(int index, E element) {
        checkPositionIndex(index);

        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }

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

删除元素

removeFirst()

删除头部节点，需要将头部节点的下一个节点，作为头部节点即可，其前驱置 null ，原头结点全置为 null 。

    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

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

removeLast()

移除末尾元素，与移除头元素同理。

    public E removeLast() {
        final Node<E> l = last;
        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;
        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;
    }

remove(Object o)

遍历List，删除指定的节点

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

remove(int index)

删除某个位置的节点。

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

clear()

所有节点置 null ，等GC回收，size 改为 0 。

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

查找元素

getFirst

获取第一个节点的内容。

    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

getLast

获取最后一个节点的内容。

    public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

get(int index)

返回某个位置上的元素。

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

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