Java容器（二）LinkedList

一、简介

LinkedList是实现了List和Deque接口的双端链表。底层的链表结构是支持高效插入删除的原因，另外实现了Deque接口使其具有队列的特性；LinkedList不是线程安全的，如果想要获得线程安全的LinkedList，可以调用静态类Collections类的synchronizedList方法：

List list = Collections.synchronizedList(new LinkedList(.....));

private static class Node {
        E item;//节点值
        Node next;//后继节点
        Node prev;//前驱节点

        Node(Node prev, E element, Node next) {
            this.item = element;
            this.next = next;
            this.prev = prev;
        }
    }

既然是链表，则就包含三个链表节点的属性：前驱、后继和元素节点

二、源码分析

1.创建LinkedList:通过已有的集合创建链表的构造方法：

public LinkedList(Collection c) {
        this();
        addAll(c);
    }

2.add方法：将元素追加到链表的尾部

• add(E e)

public boolean add(E e) {
        linkLast(e);//这里就只调用了这一个方法
        return true;
    }
   /**
     * 链接使e作为最后一个元素。
     */
    void linkLast(E e) {
        final Node l = last;
        final Node newNode = new Node<>(l, e, null);
        last = newNode;//新建节点
        if (l == null)
            first = newNode;
        else
            l.next = newNode;//指向后继元素也就是指向下一个元素
        size++;
        modCount++;
    }

• add(int Index,E e):在指定的位置添加元素

public void add(int index, E element) {
        checkPositionIndex(index); //检查索引是否处于[0-size]之间

        if (index == size)//添加在链表尾部
            linkLast(element);
        else//添加在链表中间
            linkBefore(element, node(index));
    }

其中的linkBefore方法需要给定两个参数，一个节点的值，一个指定的node节点，又通过node(index)方法查询index对应的node

• addAll(Collection c )：将集合插入到链表尾部

public boolean addAll(Collection c) {
        return addAll(size, c);
    }

• addAll(int index, Collection c)： 将集合从指定位置开始插入

public boolean addAll(int index, Collection c) {
        //1:检查index范围是否在size之内
        checkPositionIndex(index);

        //2:toArray()方法把集合的数据存到对象数组中
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        //3：得到插入位置的前驱节点和后继节点
        Node pred, succ;
        //如果插入位置为尾部，前驱节点为last，后继节点为null
        if (index == size) {
            succ = null;
            pred = last;
        }
        //否则，调用node()方法得到后继节点，再得到前驱节点
        else {
            succ = node(index);
            pred = succ.prev;
        }

        // 4：遍历数据将数据插入
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            //创建新节点
            Node newNode = new Node<>(pred, e, null);
            //如果插入位置在链表头部
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }

        //如果插入位置在尾部，重置last节点
        if (succ == null) {
            last = pred;
        }
        //否则，将插入的链表与先前链表连接起来
        else {
            pred.next = succ;
            succ.prev = pred;
        }

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

根据源码可以看出addAll方法通常包括以下几个步骤：
1.检查index范围是否在size之内
2.toArray()方法将集合的数据存到对象的数组中
3.得到插入位置的前驱和后继节点
4.遍历数据，将数据插入到指定位置

• addFirst(E e)： 将元素添加到链表头部

 public void addFirst(E e) {
        linkFirst(e);
    }
private void linkFirst(E e) {
        final Node f = first;
        final Node newNode = new Node<>(null, e, f);//新建节点，以头节点为后继节点
        first = newNode;
        //如果链表为空，last节点也指向该节点
        if (f == null)
            last = newNode;
        //否则，将头节点的前驱指针指向新节点，也就是指向前一个元素
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

• addLast(E e)： 将元素添加到链表尾部，与 add(E e) 方法一样

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

根据位置取数据的方法

• get(int index)： 根据指定索引返回数据

public E get(int index) {
        //检查index范围是否在size之内
        checkElementIndex(index);
        //调用Node(index)去找到index对应的node然后返回它的值
        return node(index).item;
    }

获取头节点（index=0）数据方法:

public E getFirst() {
        final Node f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }
public E element() {
        return getFirst();
    }
public E peek() {
        final Node f = first;
        return (f == null) ? null : f.item;
    }

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

区别： getFirst(),element(),peek(),peekFirst() 这四个获取头结点方法的区别在于对链表为空时的处理，是抛出异常还是返回null，其中getFirst() 和element() 方法将会在链表为空时，抛出异常

element()方法的内部就是使用getFirst()实现的。它们会在链表为空时，抛出NoSuchElementException
获取尾节点（index=-1）数据方法:

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

两者区别： getLast() 方法在链表为空时，会抛出NoSuchElementException，而peekLast() 则不会，只是会返回 null。
注：获取头部元素和获取尾部元素，推荐使用peekFirst()和peekLast()方法，不会跑出异常。
根据对象得到索引的方法

• int indexOf(Object o)： 从头遍历找

public int indexOf(Object o) {
        int index = 0;
        if (o == null) {
            //从头遍历
            for (Node x = first; x != null; x = x.next) {
                if (x.item == null)
                    return index;
                index++;
            }
        } else {
            //从头遍历
            for (Node x = first; x != null; x = x.next) {
                if (o.equals(x.item))
                    return index;
                index++;
            }
        }
        return -1;
    }

int lastIndexOf(Object o)： 从尾遍历找

public int lastIndexOf(Object o) {
        int index = size;
        if (o == null) {
            //从尾遍历
            for (Node x = last; x != null; x = x.prev) {
                index--;
                if (x.item == null)
                    return index;
            }
        } else {
            //从尾遍历
            for (Node x = last; x != null; x = x.prev) {
                index--;
                if (o.equals(x.item))
                    return index;
            }
        }
        return -1;
    }

检查链表是否包含某对象的方法：

contains(Object o)： 检查对象o是否存在于链表中

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

删除方法

• remove() ,removeFirst(),pop(): 删除头节点

public E pop() {
        return removeFirst();
    }
public E remove() {
        return removeFirst();
    }
public E removeFirst() {
        final Node f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }
removeLast(),pollLast(): 删除尾节点

public E removeLast() {
        final Node l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
public E pollLast() {
        final Node l = last;
        return (l == null) ? null : unlinkLast(l);
    }

区别： removeLast()在链表为空时将抛出NoSuchElementException，而pollLast()方法返回null。
注：在删除头部元素或尾部元素推荐使用pollFirst()、pollLast();

• remove(Object o): 删除指定元素

public boolean remove(Object o) {
        //如果删除对象为null
        if (o == null) {
            //从头开始遍历
            for (Node x = first; x != null; x = x.next) {
                //找到元素
                if (x.item == null) {
                   //从链表中移除找到的元素
                    unlink(x);
                    return true;
                }
            }
        } else {
            //从头开始遍历
            for (Node x = first; x != null; x = x.next) {
                //找到元素
                if (o.equals(x.item)) {
                    //从链表中移除找到的元素
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

当删除指定对象时，只需调用remove(Object o)即可，不过该方法一次只会删除一个匹配的对象，如果删除了匹配对象，返回true，否则false。

• unlink(Node x) 方法：

E unlink(Node x) {
        // assert x != null;
        final E element = x.item;
        final Node next = x.next;//得到后继节点
        final Node 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) {
        //检查index范围
        checkElementIndex(index);
        //将节点删除
        return unlink(node(index));
    }