基于jdk1.8的LinkedList的源码分析

基于jdk1.8的LinkedList的源码分析

LinkedList的特点

排列有序可重复

底层使用双向链表数据结构

查询速度慢，增删快

线程不安全

理解LinkedList主要需要理解几个概念：

首节点：只要指导首节点就可以根据首节点的下一个节点依此查找到其他节点。

尾节点：通过尾节点的上一个节点就可以依次查找到其他节点。

节点：节点包含上一个节点、节点元素、下一个节点；每一个节点需要保存上一个节点和下一个节点。对LinkedList的操作都是改变节点中上一个节点和下一个节点的指向。

LinkedList的成员变量

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{
    /**
     * 链表节点的个数
     * 关键字transient，序列化对象的时候，这个属性就不会被序列化
     */
    transient int size = 0;

    /**
     * 链表首节点
     */
    transient Node<E> first;

    /**
     * 链表尾节点
     */
    transient Node<E> last;
}

LinkedList的静态内部类

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

    /**
     * 先调用无参构造器，在通过addAll方法将元素加入到链表中
     */
    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }

LinkedList添加元素的方法

• 添加元素

  public boolean add(E e) {
        linkLast(e);//将元素添加到链表尾部
        return true;
    }
void linkLast(E e) {
        //将最后一个元素赋值给l
        final Node<E> l = last;
        //创建一个新节点，新节点的前一个节点是尾节点，后一个节点为null
        final Node<E> newNode = new Node<>(l, e, null);
        //将新节点作为新的尾节点
        last = newNode;
        //判断链表是否为空链表
        if (l == null)
            //如果是空链表则将新节点作为新的首节点
            first = newNode;
        else
            //如果链表不为空则将原尾节点的next指向新节点
            l.next = newNode;
        //更新链表节点个数
        size++;
        //更新链表修改次数
        modCount++;
    }

• 在链表首部添加元素

public void addFirst(E e) {
        linkFirst(e);
    }
  private void linkFirst(E e) {
        //将首节点赋值给f
        final Node<E> f = first;
      //创建一个新节点，由于是在首部添加，所以新节点的前一个节点为null，后一个节点为原先的首节点
        final Node<E> newNode = new Node<>(null, e, f);
      //将新节点作为新的首节点
        first = newNode;
      //如果原先链表为空
        if (f == null)
            //同时将新节点作为尾节点，即如果链表中只有一个节点，这个节点即是首节点也是尾节点
            last = newNode;
        else
            //如果链表不为空，则将原先首节点的前一个节点设置为新节点
            f.prev = newNode;
       //更新链表节点个数
        size++;
        //更新链表修改次数
        modCount++;
    }

• 在链表尾部添加元素

 public void addLast(E e) {
        linkLast(e);
    }
 void linkLast(E e) {
        //将尾节点赋值给l
        final Node<E> l = last;
       //创建一个新节点，新节点的前一个节点为原先的尾节点，后一个节点为null
        final Node<E> newNode = new Node<>(l, e, null);
       //将新节点作为新的尾节点
        last = newNode;
        //如果链表为空时
        if (l == null)
            //将新节点作为新的首节点
            first = newNode;
        else
            //如果链表不为空，则将原先尾节点的下一个节点设置为新节点
            l.next = newNode;
        //更新链表节点个数
        size++;
        //更新链表修改次数
        modCount++;
    }

• 指定位置添加元素

public void add(int index, E element) {
       //判断是否越界：index >= 0 && index <= size
        checkPositionIndex(index);
        //如果插入的位置为链表尾部，则走linkLast的逻辑，详细代码解析见：在链表尾部添加元素
        if (index == size)
            linkLast(element);
        else
            //指定位置添加元素
            linkBefore(element, node(index));
    }
//获取指定位置的节点
Node<E> node(int index) {
        //如果指定位置小于size的一半，则从头部节点开始遍历，一直获取x的下一个节点
        //如果指定位置大于size的一半，则从尾部节点开始遍历，一直获取x的上一个节点
        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;
        }
    }

 void linkBefore(E e, Node<E> succ) {
        // 获取指定位置节点的前一个节点
        final Node<E> pred = succ.prev;
        //创建一个新节点，新节点的前一个节点为succ节点的前一个节点，新节点的后一个节点为succ
        final Node<E> newNode = new Node<>(pred, e, succ);
        //新节点作为succ的前一个节点
        succ.prev = newNode;
        //如果succ为首节点
        if (pred == null)
            //则将新节点作为新的首节点
            first = newNode;
        else
            //否则将新节点作为pred的下一个节点
            pred.next = newNode;
         //更新链表节点个数
        size++;
        //更新链表修改次数
        modCount++;
    }
 

• 批量插入集合元素

public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }
public boolean addAll(int index, Collection<? extends E> c) {
        //判断是否越界：index >= 0 && index <= size
        checkPositionIndex(index);
        //集合转成数组
        Object[] a = c.toArray();
        int numNew = a.length;
        //判断数组是否为空
        if (numNew == 0)
            return false;

        Node<E> pred, succ;
        //如果在链表末尾插入集合，则当前节点succ为null,前一个节pred点为尾节点
        if (index == size) {
            succ = null;
            pred = last;
        } else {
          //如果不是在链表尾部插入，则通过node获取指定位置的节点赋值给succ，pred为cucc的前一个节点
            succ = node(index);
            pred = succ.prev;
        }
        //遍历数组
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            //创建一个新的节点，前一个节点为pred,后一个节点为null
            Node<E> newNode = new Node<>(pred, e, null);
            //如果pred为null则将新节点作为首节点否则将新节点作为pred节点的下一个节点
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            //将新节点作为新的前一个节点，这个是相对于后一个需要添加的元素而言的，通过debug更容易理解
            pred = newNode;
        }
        //所有元素添加完成后，判断当前元素是否为空，如果为空则将pred作为新的尾节点
 
        if (succ == null) {
            last = pred;
        } else {
            //否则将succ作为pred节点的下一个节点；将pred作为succ的前一个节点
            pred.next = succ;
            succ.prev = pred;
        }
        //更新链表节点个数 
        modCount++;
        size += numNew;
        //更新链表修改次数
        modCount++;
        return true;
    }

• 总结：

​ 添加元素主要分为三大类：

      1. 在头部添加元素
      2. 在尾部添加元素
      3. 在中部添加元素

LinkedList删除元素

• 删除头节点

 public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }
private E unlinkFirst(Node<E> f) {
        //获取首节点的元素值
        final E element = f.item;
        //获取首节点的下一个节点
        final Node<E> next = f.next;
        //将首节点的元素置为空等待GC
        f.item = null;
        将首节点的next置为空等待GC
        f.next = null; // help GC
        //将原首节点的下一个节点作为新的头节点
        first = next;
        //如果原先链表中只有头部节点，那原先的头部节点即是头节点也是尾节点,头部节点删除后，头节点和尾         //节点都置为null
        if (next == null)
            last = null;
        else
            //新的头部节点的前一个节点为null
            next.prev = null;
        // 更新链表节点个数 
        size--;
         //更新链表修改次数
        modCount++;
        return element;
    }

• 删除方法

//无参的删除方法默认删除头部节点，源码解析见：删除头节点
public E remove() {
        return removeFirst();
    }

• 删除尾节点

public E removeLast() {
        final Node<E> l = last;
        //判断是否是空链表
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }
 private E unlinkLast(Node<E> l) {
        // 获取尾节点的元素
        final E element = l.item;
        //获取尾节点的上一个节点
        final Node<E> prev = l.prev;
        //将尾节点的元素置为null等待GC
        l.item = null;
        //将尾节点的prev置为null等待GC
        l.prev = null; // help GC
        //将原先尾节点的前一个节点作为新的尾节点
        last = prev;
         //如果原先链表中只有尾部节点，那原先的头部节点即是头节点也是尾节点,头部节点删除后，头节点和尾         //节点都置为null
        if (prev == null)
            first = null;
        else
            //新尾部节点的next置为null
            prev.next = null;
        // 更新链表节点个数 
        size--;
         //更新链表修改次数
        modCount++;
        return element;
    }

• 删除指定元素

public boolean remove(Object o) {
        //LinkList中允许插入null，匹配null时使用==
        if (o == null) {
            //从头节点到尾节点开始遍历，直到匹配到第一个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;
    }
   unlink(Node<E> x) {
        //获取待删除节点的item值
        final E element = x.item;
        //获取待删除节点的下一个节点
        final Node<E> next = x.next;
        //获取待删除节点的上一个节点
        final Node<E> prev = x.prev;
        //如果上一个节点为空，表示删除的是头节点，头节点删除需要将原头节点的下一个节点作为新的头节点
        if (prev == null) {
            first = next;
        } else {
           //如果上一个节点不为空，则将上一个节点的next指向待删除节点的下一个节点。并将待删除节点的              //prev置为null,等待GC
            prev.next = next;
            x.prev = null;
        }
       //如果下一个节点为空，表示删除的是尾节点，尾节点删除需要将原尾节点的上一个节点作为新的尾节点
        if (next == null) {
            last = prev;
        } else {
        //如果下一个节点不为空，则将下一个节点的prev指向待删除节点的上一个节点。并将待删除节点的              //next置为null,等待GC
            next.prev = prev;
            x.next = null;
        }
       //将待删除节点的item置为null，等待GC
        x.item = null;
        // 更新链表节点个数 
        size--;
        //更新链表修改次数
        modCount++;
        return element;
    }

• 删除指定位置的节点

public E remove(int index) {
       //检查是否越界
        checkElementIndex(index);
      //通过node获取节点，通过unlink删除节点，这两个方法的源码分析在上面以分析过，请参考上面
        return unlink(node(index));
    }

• 总结

• • 删除元素主要分为三大类
  1. 删除头部节点
  2. 删除中部节点
  3. 删除尾部节点

获取元素

 //获取指定位置的元素
 public E get(int index) {
        //校验是否越界
        checkElementIndex(index);
        //通过node方法获取节点，通过item属性获取元素
        return node(index).item;
    }
  //获取首节点
  public E getFirst() {
        //直接通过first获取首节点
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }
    //获取尾节点
   public E getLast() {
        //直接通过last获取尾节点
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

LinkedList 队列操作

    /**
     *获取头节点的值
     */
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

    /**
     * 获取头节点的值
     */
    public E element() {
        return getFirst();
    }
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

    /**
     * 删除头部节点
     */
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }
    /**
     * 在尾部添加元素
     */
 public boolean offer(E e) {
        return add(e);
    }

    // Deque operations
    /**
     * 在头部添加元素
     */
    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();
    }