LinkedList源码分析1.8

一、LinkedList数据结构：

LinkedList底层使用的双向链表结构，有一个头结点和一个尾结点，双向链表意味着我们可以从头开始正向遍历，或者是从尾开始逆向遍历，并且可以针对头部和尾部进行相应的操作

注：源码中先将index与长度size的一半比较，如果index<size/2，就只从位置0往后遍历到位置index处，而如果 index>size/2，就只从位置size往前遍历到位置index处。这样可以减少一部分不必要的遍历

二、内部类和属性

1、内部类：内部类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;
        }
    }

2、类的属性：

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包含了三个重要的对象：first、last 和 size。
(1) first 是双向链表的表头，它是双向链表节点所对应的类Node的实例
(2) last 是双向链表的最后一个元素，它是双向链表节点所对应的类Node的实例
(3) size 是双向链表中节点的个数。
注意：头结点、尾结点都有transient关键字修饰，这也意味着在序列化时该域是不会序列化的

3、构造函数：

• 无参构造：

public LinkedList() {
}

• LinkedList(Collection<? extends E>)型构造函数：

public LinkedList(Collection<? extends E> c) {
        // 调用无参构造函数
        this();
        // 添加集合中所有的元素
        addAll(c);
    }

三、核心代码分析：

1、添加元素：头插入addFirst(E e)、尾插入addLast(E e)、add(E e)、addAll(Collection<? extends E> c)、addAll(int index, Collection<? extends E> c)、add(int index, E element)这些添加元素的方法

• add(E e)方法：

 public boolean add(E e) {
        // 添加到末尾
        linkLast(e);
        return true;
    }

add函数用于向LinkedList中添加一个元素，并且添加到链表尾部，调用linkLast方法

void linkLast(E e) {
        // 保存尾结点，l为final类型，不可更改
        final Node<E> l = last;
        // 新生成结点的前驱为l,后继为null
        final Node<E> newNode = new Node<>(l, e, null);
        // 重新赋值尾结点
        last = newNode;    
        if (l == null) // 尾结点为空
            first = newNode; // 赋值头结点
        else // 尾结点不为空
            l.next = newNode; // 尾结点的后继为新生成的结点
        // 大小加1    
        size++;
        // 结构性修改加1
        modCount++;
    }

• add(int index, E element)方法：

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

        if (index == size)
            linkLast(element);//index是最后一个就直接插到最后
        else
            linkBefore(element, node(index));
    }

    //将节点插入到目标节点前面
    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)//同linkLast中设置后驱节点为目标节点
            first = newNode;
        else
            pred.next = newNode;
        size++;
        modCount++;
    }

2、删除元素：头删除removeFirst()、尾删除removeLast()、remove(int index)、remove(Object o)、clear()这些删除元素的方法

//移除首节点，并返回该节点的元素值
    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

    //删除非空的首节点f
    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; //将原首节点的next节点设置为首节点
        if (next == null)  //如果原链表只有一个节点，即原首节点，删除后，链表为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);
    }

    //删除非空的尾节点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; //将原尾节点的prev节点设置为尾节点
        if (prev == null) //如果原链表只有一个节点,则删除后，链表为null
            first = null;
        else
            prev.next = null;
        size--;
        modCount++;
        return element;
    }

 //移除此列表中指定位置上的元素
    public E remove(int index) {
        checkElementIndex(index);  //index >= 0 && index < size
        return unlink(node(index));
    }

    //删除非空节点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; // help GC
        size--;
        modCount++;
        return element;
    }

//移除列表中首次出现的指定元素(如果存在)，LinkedList中允许存放重复的元素
    public boolean remove(Object o) {
        //由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
        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 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++;
    }

3、查找元素：getFirst()、getLast()、contains(Object o)、get(int index)、indexOf(Object o)、lastIndexOf(Object o)这些查找元素的方法

//返回列表首节点元素值
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)  //如果首节点为null
            throw new NoSuchElementException();
        return f.item;
    }

    //返回列表尾节点元素值
    public E getLast() {
        final Node<E> l = last;
        if (l == null) //如果尾节点为null
            throw new NoSuchElementException();
        return l.item;
    }

    //判断列表中是否包含有元素值o，返回true当列表中至少存在一个元素值e，使得(o==null?e==null:o.equals(e))
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

    //返回指定索引处的元素值
    public E get(int index) {
        checkElementIndex(index); //index >= 0 && index < size
        return node(index).item;  //node(index)返回指定索引位置index处的节点
    }

    //返回指定索引位置的节点
    Node<E> node(int index) {
        // assert isElementIndex(index);
        //折半思想，当index < size/2时，从列表首节点向后查找
        if (index < (size >> 1)) {
            Node<E> x = first;
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {  //当index >= size/2时，从列表尾节点向前查找
            Node<E> x = last;
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }

    //正向查找，返回LinkedList中元素值Object o第一次出现的位置，如果元素不存在，则返回-1
    public int indexOf(Object o) {
        int index = 0;
        //由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
        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;
    }

    //逆向查找，返回LinkedList中元素值Object o最后一次出现的位置，如果元素不存在，则返回-1
    public int lastIndexOf(Object o) {
        int index = size;
        //由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
        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;
    }

4、修改元素： set(int index, E element)方法来修改指定索引上的值

  //替换指定索引位置节点的元素值，并返回旧值
    public E set(int index, E element) {
        checkElementIndex(index); //index >= 0 && index < size
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    }

5、Queue操作：提供了peek()、element()、poll()、remove()、offer(E e)这些方法

//获取但不移除此队列的头；如果此队列为空，则返回 null
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

    //获取但不移除此队列的头；如果此队列为空，则抛出NoSuchElementException异常
    public E element() {
        return getFirst();
    }

    //获取并移除此队列的头，如果此队列为空，则返回 null
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    //获取并移除此队列的头，如果此队列为空，则抛出NoSuchElementException异常
    public E remove() {
        return removeFirst();
    }

    //将指定的元素值(E e)插入此列表末尾
    public boolean offer(E e) {
        return add(e);
    }

6、Deque（双端队列）操作：提供了offerFirst(E e)、offerLast(E e)、peekFirst()、peekLast()、pollFirst()、pollLast()、push(E e)、pop()、removeFirstOccurrence(Object o)、removeLastOccurrence(Object o)这些方法

//获取但不移除此队列的头；如果此队列为空，则返回 null
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

//获取但不移除此队列的头；如果此队列为空，则抛出NoSuchElementException异常
    public E element() {
        return getFirst();
    }

//获取并移除此队列的头，如果此队列为空，则返回 null
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

//获取并移除此队列的头，如果此队列为空，则抛出NoSuchElementException异常
    public E remove() {
        return removeFirst();
    }

//将指定的元素值(E e)插入此列表末尾
    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;
    }

  //获取，但不移除此双端队列的第一个元素；如果此双端队列为空，则返回 null
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }

    //获取，但不移除此双端队列的最后一个元素；如果此双端队列为空，则返回 null
    public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

    //获取并移除此双端队列的第一个元素；如果此双端队列为空，则返回 null
    public E pollFirst() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    //获取并移除此双端队列的最后一个元素；如果此双端队列为空，则返回 null
    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();
    }

    //从此双端队列移除第一次出现的指定元素，如果列表中不包含次元素，则没有任何改变
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

    //从此双端队列移除最后一次出现的指定元素,如果列表中不包含次元素，则没有任何改变
    public boolean removeLastOccurrence(Object o) {
        //由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
        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;
    }

四、LinkedList的运用
LinkedList实现堆栈：借鉴http://www.cnblogs.com/CherishFX/p/4608880.html