java容器篇（三）——LinkedList源码分析

上面两篇讲了ArrayList和Vector，这一篇分析的是LinkedList ；一样的 还是结合源码（此处版本：jdk8）进行分析。

一 ：数据结构

LinkedList底层是基于双向链表实现，使用 Node 存储链表节点信息。大概模型如下:

二 ： 继承关系

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

对比于List的另外两个子类，其相同的点在于，LinkedList一样实现 List 接口（能对它进行列表操作）、实现了Cloneable接口，即覆盖了函数clone()以及实现了java.io.Serializable接口，(支持序列化，能通过序列化去传输);而不同的在于LinkedList继承了AbstractSequentialList，而其他两个继承的是AbstractList；并且LinkedList不具备快速访问能力；

LinkedList 是一个继承于AbstractSequentialList的双向链表。它也可以被当作堆栈、队列或双端队列进行操作。

LinkedList 实现 Deque 接口，即能将LinkedList当作双端队列使用。

三:LinkedList的核心成员变量

直接附上源码：

transient int size = 0;

transient Node<E> first;

transient Node<E> last;

其中，size是指当前包含的节点数；first是指向链表的第一个节点的引用，而last则是指向链表的最后一个节点的引用。这里面用到了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;
        }
    }

其中,item是当前节点值。next是指向后一个节点的引用，而perv指向前一节点；看到这里应该会明白上面那张图了。

四：构造函数

LinkedList有两个构造函数，分别是：

  /**
     * Constructs an empty list.
     */
    public LinkedList() {
    }

    /**
     * Constructs a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     *
     * @param  c the collection whose elements are to be placed into this list
     * @throws NullPointerException if the specified collection is null
     */
    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(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;

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

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

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

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

addAll方法实际上是在index位置进行链表的插入操作；在代码逻辑上，首先会进行一个标记它是在链表尾部还是中间部分进行插入；如果是尾部，那么最后的last就指向包含集合类的最后一个元素的节点即可，如果是在中间部分，则需要对原来处于这个位置的节点的prev值进行修改。当然，如果是空链表的话，那么还需要将first指向包含集合类中第一个元素的节点。

五:插入修改

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

这个方法实际上是将传入的元素e链接成为首节点，代码逻辑上是新建一个节点，把这个节点的next指向原来的first指向的节点，然后把first指向这个节点；最后把原来的first指向的节点的前驱修改为这个新节点（若之前为空链表则把last也指向这个新节点即可）

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

这个方法和上面的linkFirst很相似，实际上是将传入的元素e链接成为末节点，代码逻辑上一样是新建一个节点，把这个节点的前驱指向原来的last指向的节点，然后把last指向这个节点；最后把原来的末节点的后继修改为这个新节点（若之前为空链表则把first也指向这个新节点即可）

linkBefore

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

linkBefore实际上是在某个非空节点succ之前去插入一个节点，实现过程如下：新建一个节点，把这个节点的前驱指向succ原本的前驱，把这个节点的后继指向succ，然后再去修改原来succ的前驱节点的后继指向以及succ的前驱指向。

add

    public boolean add(E e) {
        linkLast(e);
        return true;
    }
     public void add(int index, E element) {
        checkPositionIndex(index);

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

源码可以看到，LinkedList两个add方法的区别在于一个是没有指明位置默认放到链表最后，实际上的实现还是去调用linkLast（）和linkBefore（）这两个方法

set

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

这个方法其是将index处的节点的item元素更换为传入的元素，最后再把原先的元素的值返回。

六：删除

unlinkFirst

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

这个方法是进行头节点的删除，代码逻辑是先获取first元素值，然后获取first的next元素，接着将first节点指向next，再把原来的first节点的属性值置为null（包括item和next）；如果next节点（原first节点的nex节点）为null，则将last置为null值；如果不为null，则将next节点的prev属性置为null;
最后修正元素个数以及修改次数（size和modCount）。

unlinkLast

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

这个方法是进行尾节点的删除，代码逻辑是先获取last元素值，然后获取last的prev元素，接着将last节点指向prev，再原来的last节点的属性值置为null（包括item和prev）；如果prev节点为null，则将first置为null值；如果不为null，则将prev节点的next属性置为null;
最后修正元素个数以及修改次数（size和modCount）。

unlink

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

这个方法是对某个指定节点的删除，代码逻辑是先获取指定节点的所有元素值，然后看这个指定节点的前驱节点是否为null，如果为null则把first指向这个指定节点的后继节点，如果不为null，则修改前驱节点的next值并且把指定节点的prev值置为null；接着看这个指定节点的后继节点是否为null。如果为null则把last指向这个制定节点的前驱节点，如果不为null，则修改这个后继节点的prev值，并且把指定节点的next值置为null；
最后把指定节点的item值置为null并且修正元素个数以及修改次数（size和modCount）并将删除的节点的元素值返回。

remove

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 E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }

 public E remove() {
        return removeFirst();
    }
    

LinkedList的remove方法主要是上面这三个，分别是对移除指定元素，移除指定位置的元素以及默认移除，而默认的移除则是移除第一个元素，实际上还是通过removeFirst方法去实现的；而另外两个移除方法则都是通过unlink方法去进行元素的移除

七：查询搜索

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

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

这个方法是进行特定位置的节点的元素的获取。

indexOf

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

这个方法的作用是从头结点开始寻找和传入的元素相等的元素，如果找到了，则返回其在链表中的位置（下标）；若没找到，则返回-1；要注意的一点是，需要把情况分为是null和不是null；因为如果是null情况下还使用equals()方法会出现空指针异常。

lastIndex(Object o)

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

这个方法的作用是从链表的尾节点至头节点逆向搜索元素.

八、LinkedList的一些其他方法

contains

public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

这个方法的作用是查看链表中是否含有某个元素，实际上还是通过indexOf来实现的

 public void clear() {
        // Clearing all of the links between nodes is "unnecessary", but:
        // - helps a generational GC if the discarded nodes inhabit
        //   more than one generation
        // - is sure to free memory even if there is a reachable Iterator
        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++;
    }

这个方法的作用是将链表清空

 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无法随机访问，只能通过遍历的方式找到相应的节点，这里为了提高效率，把当前位置先和元素数量的中间位置开始判断，小于中间位置则从头节点开始遍历，大于中间位置则从尾节点开始遍历

九：队列相关操作

//弹出第一个元素的值
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

    //获取第一个元素
    public E element() {
        return getFirst();
    }

    //弹出第一元素，并删除
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }


    //添加到尾部
    public boolean offer(E e) {
        return add(e);
    }

    //添加到头部
    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }

    //插入到最后一个元素
    public boolean offerLast(E e) {
        addLast(e);
        return true;
    }
    //队列操作
    //尝试弹出第一个元素，但是不删除元素
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }
    //队列操作
    //尝试弹出最后一个元素，不删除
    public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }
    
    //弹出第一个元素，并删除
    public E pollFirst() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    //弹出最后一个元素，并删除
    public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

    //如队列，添加到头部
    public void push(E e) {
        addFirst(e);
    }

    //出队列删除第一个节点
    public E pop() {
        return removeFirst();
    }
    

十：总结

1、不ArrayList和Vector继承于 AbstractList, LinkedList继承于 AbstractSequentialList；

2、ArrayList和Vector基于动态数组， LinkedList基于双向链表；

3、对于随机访问，ArrayList 和Vector支持随机访问，LinkedList 不支持；但是LinkedList 在任意位置添加删除元素更快；

4、LinkedList需要更多的内存，因为ArrayList和Vector的每个索引的位置是实际的数据，而 LinkedList中的每个节点中存储的是实际的数据和前后节点的位置；

5、ArrayList 和 LinkedList都是非同步的集合；

6、和ArrayList一样，LinkedList也是非线程安全的，只有在单线程下才可以使用。

7、LinkedList没有实现自己的 Iterator，使用的是 ListIterator

8、LinkedList是一个功能很强大的类，可以被当作List集合，双端队列和栈来使用