集合框架专题4—LinkedList

LinkedList

        前言： 本文所采用的jdk版本为：jdk1.8.0_111。

        一、成员变量

    transient int size = 0;

    transient Node<E> first;

    transient Node<E> last;

        这里我们可以看到Node<E>这个一个类，这是一个内部类，一个Node用于表示链表中的一个Node节点。我们可以看一下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;
        }
    }

        其中会包含一个元素、一个前节点、一个后节点。

        上面的成员变量中，我们可以看到直接定义了一个first和一个last，说明linkedList是一个双向链表。

二、 构造器

    public LinkedList() {
    }

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

        一个默认无参构造器，一个默认传入一个Collection的构造器。

三、 常用方法

3.1 getFirst()

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

        获取链表的第一个元素。

3.2 getLast()

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

        获取链表的尾部元素。

3.3  removeFirst()

    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(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;
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

        该方法是将链表中的第一个元素删除，这里有一个unlinkFirst(Node<E> f)方法，这个方法是执行这个功能的过程，源码中我们可以看出其过程，将第二个节点拿到，第一个节点置空，再将第一个节点关联去掉。

3.4 removeLast()

    public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(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;
        if (prev == null)
            first = null;
        else
            prev.next = null;
        size--;
        modCount++;
        return element;
    }

        删除最后一个元素。这里的实现过程放在unlinkLast(Node<E> l)中，源码中可以看到大致过程：将倒数第二个节点拿到，最后一个节点置空，再将最后一个节点的关联去掉。

3.5 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;
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

        将元素添加到链表头部。实现过程放在linkFirst(E e)中，大致过程是：将新的元素创建为一个新的Node，其中next节点指向原首节点，将新节点设成首节点。

3.6 addLast(E e)

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

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

        将元素添加到链表尾部。实现过程放在linkLast(E e)中，大致过程是：将新的元素创建一个新的Node，其中上一节点指向原尾部节点，将新的节点设置成尾部节点。

3.7 add(E e)

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

        添加一个元素置队尾。

3.8  remove(Object o)

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

        移除掉与参数相同的第一个元素。

3.9 addAll(Collection<? extends E> c)

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

        将参数中传入的元素添加到队尾，内部调用了addAll(size,c)来进行实现的。

3.10 addAll(int index, Collection<? extends E> c)

public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        Node<E> pred, succ;
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index);
            pred = succ.prev;
        }

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

        将传入的c集合中的元素插入到该链表中指定的位置。该方法属于比较典型的链表插入操作，可以深入理解其中的逻辑。

3.11 clear()

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

        将链表内元素清掉，源码中是从第一个元素开始，循环将所有Node的值都置为Null。

3.12 get(int index)

    public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }

    Node<E> node(int index) {
        // assert isElementIndex(index);

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

        获取指定位置的元素，这里着重讲一下实现过程，因为可以跟ArrayList去做一下比较，可以看出这里的指定位置获取，是从first或last开始，然后循环去找下一个或上一个Node，直至找到指定位置。所以linkedList是无法直接从中间拿到值的，这里是跟ArrayList相比的一个比较重要的区别。

3.13 set(int index, E element)

public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    }

        将元素set到指定位置，并返回原来被替换掉的元素。方法中，通过node(index)找到指定的Node，再将旧的值拿出来，新的值赋值进去。

3.14 peek() , poll()

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

    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

        这两个方法都是拿到队首的值，但是不同的是，peek仅仅拿到队首的值，而poll是拿到队首的值后，同时将其删除。

3.15 push()

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

        将元素插至队首。

        综合所属，LinkedList适合的场景是需要修改其链表本身结构的场景，比如队中的插入删除操作，排序操作等等，这些都远比ArrayList要高效很多。但是其不支持直接获取队中的值的功能，如果需要get某个位置的值，其需要从队首或队尾迭代进行查找，所以在查询方面，其效率比ArrayList低效很多。