看源码之LinkedList

首先扯点别的，桌子上的栀子花已经放了好几天了，有点枯萎了，但是依然芳香浓郁。感觉比玫瑰花强多了，玫瑰花也不见得比栀子花好看，不仅没香味而且还有刺。但是还是好多人喜欢玫瑰花。让我想起一篇古文《爱莲说》。

看一下LinkedList的继承结构

1. LinkedList 继承AbstractSequentialList，实现了List接口和Deque接口，元素可以为null。
2. 非线程安全。
3. LinkedList 内部使用的数据结构是一个双向链表。如果要经常执行插入和删除操作，可以考虑使用LinkedList。使用迭代器遍历LinkedList。

LinkedList成员变量

//LinkedList中元素的数量
transient int size = 0;
//第一个元素
transient Node<E> first;
//最后一个元素
transient Node<E> 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;
        }
    }

下面就从LinkedList构造函数开始

无参构造函数，什么也没有，可以直接略过。

public LinkedList() {
}

有参构造函数，把集合c中的元素添加到LinkedList中。

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

addAll方法内部调用了两个参数的addAll(int index, Collection<? extends E> c)方法，这个方法会把集合c中的所有元素从position为index的方法插入到LinkList中，如果原本index右边有元素的话，那么这些元素会被向右移动，举个例子。

//原本LinkdeList中有4个元素
[1,2,3,4];
//集合 c
[7,8]
//调用addAll(2, c)后，LinkedList变成
[1,2,7,8,3,4]

public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index);
		//把c转化成数组
        Object[] a = c.toArray();
        int numNew = a.length;
        //如果数组中没有元素，返回false
        if (numNew == 0)
            return false;

        Node<E> pred, succ;
        if (index == size) {
        //如果index为size，那么index位置上的node为null，node的前一个节点是last
            succ = null;
            pred = last;
        } else {
        //找到当前index位置上的node，用succ表示。pred表示当前节点的前一个节点
            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;
    }

上面的方法就是把c中所有的元素插入LinkList，然后增加size，修改次数modCount加1。

LinkedList的offer方法,内部使用add()实现。

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

LinkedList的add方法，内部使用linkLast()方法实现。

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

    /**
     * 把元素e加入到LinkedList末尾，size加1，modCount加1。
     */
    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++;
    }

Linked的remove()方法，内部使用removeFirst()方法实现。

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

//移除并返回LinkedList中的第一个元素，内部使用unlinkFirst实现
public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

//删除node f，返回f的item，size减1，modCount加1，返回element
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;
    }

LinkedList的remove（int index）方法，首先检查index是否越界，然后使用unlink方法实现。

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

**node(index)**方法，用来获取index位置上的节点。如果index小于size的一半，就从前往后遍历，如果index大于等于size的一半，就从后往前遍历。

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

LinkedList的remove(Object o)方法，从前往后遍历，找到要删除的节点，然后调用unlink(Node x)方法。

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

LinkedList的peekFirst()方法，返回第一个节点。

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

LinkedList的pop()方法，删除并返回第一个节点，内部调用removeFirst()实现。

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

LinkedList的peekLast()方法，返回最后一个节点。

 public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

LinkedList的pollLast()方法，删除并返回最后一个元素，内部使用unlinkLast方法实现。

public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

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

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

结尾：并没有挨个看所有的方法。

参考链接：

• LinkedList源码分析（基于JDK8）