「OpenJdk-11 源码-系列」 LinkedList

定义

List中除了之前讲到的ArrayList外，还有LinkedList也非常常用，之前在学习这两个类的时候，只是简单的记录了它们各自的特性。如果我们需要多次添加新元素，很少有从中间get的操作，那么就使用LinkedList，反之则使用ArrayList。之前我们在研究ArrayList源码时发现，当我们在添加元素时，如果size = capacity的时候，那么就会进行扩容，在扩容的时候就回影响性能，而LinkedList则不会有这个问题。先来看看定义：

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{
    transient int size = 0;

    transient Node<E> first;

    transient Node<E> last;
}
复制代码

从定义上，我们可以看出来 , linkedList继承了AbstractSequenttialList以及实现了List，Deque，Clone，Serializable接口。实现了List的基本操作，以及可以进行clone和序列化，和ArrayList最大的区别在于，ArrayList实现了RandomAccess接口，而LinkedList实现的是Deque双向队列(Double-ended queue)接口，双向队列即同时具备栈和队列的性质的数据结构。队列中的元素可以从两端进行操作，也可以从两端添加。

`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的数据结构很简单，只包含了三个属性

E item : 当前Node的value
Node next：当前Node的下一个Node是什么
Node prev：当前Node的上一个Node是什么

举个例子来讲，有一个LinkedList，有两个元素A和B，依次添加A和B，那么B就是A的next，而A就是B的prev。

构造函数

LinkedList有俩构造函数

无参构造函数

public LinkedList() {}
复制代码

可以发现，啥都没干，啥都没干也就意味着LinkedList中的两个属性Node first和Node last都为null，即LinkedList为空。

有参构造函数

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

可以看到，传入了一个collection来初始化：

首先会先调用this()来使用空参构造函数来初始化LinkedList
调用addAll方法（这个地方的index就是size，默认是0）

//在 index 所在的node前添加 c 集合节点
public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index); // index >=0 && index <=size

        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;
		//保存 index 的节点为 succ，当前节点的上一个节点为 pred
        Node<E> pred, succ;
    	//如果 index == size ，说明在尾部进行添加，即当前节点为null，当前节点的上一个节点为 
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index); // 查找 index 所在的 node
            pred = succ.prev;
        }

        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            Node<E> newNode = new Node<>(pred, e, null);
            //如果 pred 为null，则说明 LinkedList 为空，那么当前节点就为first
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }
		//如果succ为空，则说明是要在尾部进行添加
        if (succ == null) {
            last = pred;
        } else {
            //否则pred（即添加的最后一个节点）的下一个节点指向当前节点（index所在的节点）
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;
        modCount++;
        return true;
    }
复制代码

添加

LinkedList的添加方法包含了add,addFirst,addLast,add(int index,E e)，add == addLast，也就是说，我们可以在LinkedList中的任意位置插入一个节点，而所有的add操作，最终都是调用了下面的两个方法

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++;
    }
void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        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++;
    }
复制代码

实现也就比较简单了，就不赘述了。

删除

LinkedList的删除方法包含了remove,removeFirst,removeLast,remove(Object obj),其中remove == removeFirst，默认先会remove最先进入的节点。和add方法类似，remove方法最终也会调用俩方法

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;
    }
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;
    }
复制代码

值得说明的一点是将待删除的节点的信息设置为null，目的是为了释放头节点的next/prev 指针和 element 下次 gc 的时候回收这个内部类

获取

LinkedList的获取节点的方法也是相似的，分为了getFirst,getLast和get(int index),对于getFirst和getLast比较简单，只需要获取first或last的value就好了。值得一看的是get(int index),最主要的方法

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;
        }
    }
复制代码

看到这个关键的if (index < (size >> 1))，如果想要查找的index处于size当前长度的后半段，那么就从后往前找，否则从前往后着，以此来提高效率。可见，如果我们需要大量的查找操作，特别是通过index来查找，那么推荐使用ArrayList，而不是LinkedList。