Java之LinkedList源码分析（第七篇：删除元素-Deque接口）

（注意：本文基于JDK1.8，不含迭代器、清除所有元素的删除方法） 

 Deque接口定义了双端队列具备的能力，截图为Deque接口中定义的移除方法，接下来就分析一下

 

remove（）方法分析

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

在Deque接口中定义了该抽象方法，用于删除链表头部的第一个元素

在该方法的内部直接调用了一个removeFirst（）方法完成实际的操作，而removeFirst方法的返回值会作为当前remove方法的返回值，返回值类型是参数类型E的对象。

注意：该方法在LinkedList没有持有元素时会抛出NoSuchElementException！（在内部调用的removeFirst方法会抛出……）

 

removeFirst（）方法分析

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

removeFirst方法用于删除链表头部第一个元素

1、首先从LinkedList对象持有的实例变量first中获取到目前指向的头结点对象，并赋值给局部变量f进行保存，局部变量f用final修饰，以防止无意的修改

2、处理没有元素的情况

当f为null时，证明LinkedList并没有持有任何元素，此时会抛出一个经典的NoSuchElementException异常对象

3、开始删除元素

通过LinkedList元素数量的检测后，接着调用将局部变量f传入到一个unLinkFirst方法中（见本文2号知识点）

4、向调用者返回删除后的元素对象

unLinkFirst方法的返回值会成为整个removeFirst方法最后的返回值（return一个类型参数E的对象）

 

unlinkFirst（）方法分析

    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;
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

1、首先获得传入的Node对象f持有的item，由局部变量element保存上

2、接着将传入的Node对象f持有的next（指向下一个Node对象）交给局部变量next持有，现在已经定义了两个局部变量，一个是element、另一个是next。

3、接下来将传入的Node对象f持有的item与next都赋值为null，这么做可以帮助Node通过item与next持有的对象被GC回收！

4、因为移除的头结点，所以需要将头结点first指向移除结点的后一个结点next

5、如果这个next为null则说明移除的结点不仅是头结点也是尾结点，此时就需要将last指向null，说明所有结点都被移除了，next不为null，说明被移除的结点不是最后一个结点，此时被移除的结点的后一个结点对象持有的prev需要指向null，这样就断开了对移除结点的引用。

6、最后更新元素总数

元素总数size需要减去1，modeCount需要更新+1

7、最终返回元素对象element

 

removeFirstOccurrence（）方法分析

    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

该方法用于移除与Object对象o匹配的元素，内部则是将传入的Object对象o又传入到一个remove方法中

 

remove（）方法分析

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

方法LinkList的头部开始遍历，匹配的元素会被删除

根据传入的Object对象o的不同分别进行了处理，这是因为LinkedList支持null元素的存储。

第一、o为null

局部变量x负责存储每次遍历的Node对象，局部变量x的初始值是LinkedList持有的第一个Node对象（头结点对象），每次遍历的过程中，第一次出现的Node对象持有的item等于null时，就开始执行移除方法unlink（见本文5号知识点），执行unlink方法后，执行return true语句，说明成功移除元素。

第二、o不为null

同样是遍历，此时判断方式改为利用Object对象的equals方法进行，匹配的元素，同样会传入到unlink方法中，执行完毕后，返回true代表成功移除元素

在上面两种情况均没有遍历到匹配的元素时，方法的最后会返回false，代表移除元素失败……

 

unlink（）方法分析

    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;
        size--;
        modCount++;
        return element;
    }

该方法的详细解答见Java之LinkedList源码分析（第六篇：删除元素-List接口）的3号知识点（同一个方法），它实际进行了结点对象的移除

 

removeLast（）方法分析

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

 移除双向链表最后一个结点的方法（尾结点），首先获取LinkedList对象持有的last指向的结点对象，由局部变量l保存上，当l为null时，抛出一个NoSuchElementException，说明对已经没有持有元素的LinkedList执行了移除操作，通过无元素检查后，会调用一个unlinkLast方法（见本文7号知识点），同时也将最后一个结点对象传了进去

 

unlinkLast（）方法分析

    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;
        if (prev == null)
            first = null;
        else
            prev.next = null;
        size--;
        modCount++;
        return element;
    }

 unlinkLast方法，正如其名，它是移除尾结点的方法

1、首先将传入的尾结点对象l持有的item，由局部变量element负责保存

2、接着取出尾结点对象持有的prev（上一个结点对象）由局部变量prev持有

3、将尾结点对象持有的item、prev，全部赋值为null，这样item、prev指向的对象会被GC回收

4、将LinkedList对象持有的last指向临时保存的prev，目的是为了更新尾结点对象

5、如果删除的尾部结点也是头结点（prev为null），此时就需要更新first为null，否则只需将新的尾结点对象的next赋值为null

6、元素总数size减去1

7、modCount增加1

8、最后则是返回被干掉的Node对象持有的元素对象element

 

removeLastOccurrence（）方法分析

    public boolean removeLastOccurrence(Object o) {
        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;
    }

从最后一个结点开始，遍历到第一个结点，这是该方法的遍历顺序，同样对null元素与非null元素分开处理，有匹配的元素，会将Node结点移除，同样是通过unlink方法进行的（见本文5号知识点），返回值true代表成功、flase代表失败