Java集合—LinkedList源码分析

简介

LinkedList实现了List和Deque接口。 实现所有可选列表操作，并允许所有元素（包括null ）。LinkedList底层使用的双向链表结构使插入和删除操作更加高效。注意，LinkedList是线程不安全的。如果多个线程同时访问链接列表，并且至少有一个线程在结构上修改列表，则必须在外部进行同步。可以使用Collections类中的synchronizedList方法(这最好在创建时完成，以防止意外的不同步访问列表)：

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

结构分析

上图就是LinkedList的结构。我们看到LinkedList类中有一个内部类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。这个类有三个属性

• next：前驱结点
• prev：后继节点
• item：节点的值

源码分析

构造方法

空构造方法

    public LinkedList() {
    }

构造一个包含指定集合的元素的列表，按照它们由集合的迭代器返回的顺序

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

方法

• add(E e)：将指定的元素追加到此列表的末尾

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

• addLast(E e): 将指定的元素追加到此列表的末尾。

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

这里我们看到add()、addLast()两个方法都是调用linkLast()这个方法。所以说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++;
    }

• add(int index, E element)：在此列表中的指定位置插入指定的元素。

    /**
     *将指定元素插入此列表中的指定位置。将当前位置的元素（如果有）和后续元素移
     *动到右侧（将索引添加一个）。
     */
    public void add(int index, E element) {
        //判断参数是迭代器或添加操作的有效位置的索引。
        //也就是检查索引是否处于[0-size]之间
        checkPositionIndex(index);  

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

linkBefore需要传入两个参数，一个插入的值，一个指定的node，所以这里有调用了node(index)方法去找到index对应的node

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

• addAll(Collection<? extends E> c)：按照指定集合的迭代器返回的顺序将指定集合中的所有元素追加到此列表的末尾。

    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

• addAll(int index, Collection<? extends E> c):将指定集合中的所有元素插入到此列表中，从指定的位置开始。

public boolean addAll(int index, Collection<? extends E> c) {
       //1.检查index是否在size之内
        checkPositionIndex(index);
        
        //2.toArray()方法把集合的数据保存到对象数组中
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;
        
        //3.得到插入位置的前驱结点和后继节点
        Node<E> 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<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;
    }

• **addFirst(E e) **：在该列表开头插入指定的元素。

    public void addFirst(E e) {
        linkFirst(e);
    }

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

根据位置取数据

• get(int index)：返回此列表中指定位置的元素。

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

• **获取头节点(index=0)数据方法

    //返回此列表中的第一个元素。 
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }
    
    //检索但不删除此列表的头（第一个元素）。 
    public E element() {
        return getFirst();
    }
    
    //检索但不删除此列表的头（第一个元素）。 
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }
    
    //检索但不删除此列表的第一个元素，如果此列表为空，则返回 null 。
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }

区别：
这四个获取头节点方法的区别在于对链表为空时的处理，是抛出异常还是返回null。 getFirst()、element() 方法将会在链表为空时，抛出异常:NoSuchElementException
而另外两个方法会在链表为空时返回null

• 获取尾节点(index=-1)数据方法：

    //返回此列表中的最后一个元素。 
    public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }
    
    //检索但不删除此列表的最后一个元素，如果此列表为空，则返回 null 。 
    public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

区别： getLast()方法在链表为空时会抛出NoSuchElementException异常；而peekLast()列表为空时返回null

根据对象得到索引

• indexOf(Object o): 返回此列表中指定元素的第一次出现的索引，如果此列表不包含元素，则返回-1。

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

• lastIndexOf(Object o): 返回此列表中指定元素的最后一次出现的索引，如果此列表不包含元素，则返回-1。

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

检查链表是否包含某元素的方法:

• contains(Object o)： 如果此列表包含指定的元素，则返回 true 。

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

删除方法

删除头节点

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

    public E remove() {
        return removeFirst();
    }
    
        public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

删除尾节点

    
    //从此列表中删除并返回最后一个元素。 
   public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
    
    //检索并删除此列表的最后一个元素，如果此列表为空，则返回 null 。 
     public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

• remove(Object o): 从列表中删除指定元素的第一个出现（如果存在）。

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

• unlink(Node 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;  //得到前驱节点

        //删除前驱结点
        //如果前驱结点为null，也就是头节点
        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) {
        checkElementIndex(index);
        return unlink(node(index));
    }