LinkedList CRUD源码解析

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

• 对于第一个节点来说，prev 为 null；
• 对于最后一个节点来说，next 为 null；
• 其余的节点呢，prev 指向前一个，next 指向后一个。

新增

add 方法内部其实调用的是 linkLast 方法：

/**
     * Appends the specified element to the end of this list.
     *
     * <p>This method is equivalent to {@link #addLast}.
     *
     * @param e element to be appended to this list
     * @return {@code true} (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        linkLast(e);
        return true;
    }

linkLast，顾名思义，就是在链表的尾部链接：

/**
     * Links e as last element.
     */
    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++;
    }

• 添加第一个元素的时候，first 和 last 都为 null。
• 然后新建一个节点 newNode，它的 prev 和 next 也为 null。
• 然后把 last 和 first 都赋值为 newNode。

---

• 添加第二个元素的时候，first 和 last 都指向的是第一个节点。
• 然后新建一个节点 newNode，它的 prev 指向的是第一个节点，next 为 null。
• 然后把第一个节点的 next 赋值为 newNode。

---

• 添加第三个元素的时候，first 指向的是第一个节点，last 指向的是最后一个节点。
• 然后新建一个节点 newNode，它的 prev 指向的是第二个节点，next 为 null。
• 然后把第二个节点的 next 赋值为 newNode。

---

新增的两个方法：
addFirst() 方法将元素添加到第一位；
addLast() 方法将元素添加到末尾。

addFirst 内部其实调用的是 linkFirst：

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

linkFirst 负责把新的节点设为 first，并将新的 first 的 next 更新为之前的 first。

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

addLast 的内核其实和 addFirst 差不多

删除

remove()：删除第一个节点
remove(int)：删除指定位置的节点
remove(Object)：删除指定元素的节点
removeFirst()：删除第一个节点
removeLast()：删除最后一个节点

remove()内部调用的是 removeFirst

remove(int) 内部其实调用的是 unlink 方法。

public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

unlink 方法其实很好理解，就是更新当前节点的 next 和 prev，然后把当前节点上的元素设为 null。

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

remove(Object) 内部也调用了 unlink 方法，只不过在此之前要先找到元素所在的节点：

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

这内部就分为两种，一种是元素为 null 的时候，必须使用 == 来判断；一种是元素为非 null 的时候，要使用 equals 来判断。equals 是不能用来判 null 的，会抛出 NPE 错误。removeFirst 内部调用的是 unlinkFirst 方法：

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

unlinkFirst 负责的就是把第一个节点干掉，并且捎带把后一个节点的 prev 设为 null。

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

修改

可以调用 set() 方法来更新元素：

list.set(0, "kkkkk");

来看一下 set() 方法：

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

首先对指定的下标进行检查，看是否越界；然后根据下标查找原有的节点：

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

size >> 1：也就是右移一位，相当于除以 2。对于计算机来说，移位比除法运算效率更高，因为数据在计算机内部都是二进制存储的。

换句话说，node 方法会对下标进行一个初步判断，如果靠近前半截，就从下标 0 开始遍历；如果靠近后半截，就从末尾开始遍历。

找到指定下标的节点就简单了，直接把原有节点的元素替换成新的节点就 OK 了，prev 和 next 都不用改动。

查找

indexOf(Object)：查找某个元素所在的位置
get(int)：查找某个位置上的元素

indexOf 的内部分为两种，一种是元素为 null 的时候，必须使用 == 来判断；一种是元素为非 null 的时候，要使用 equals 来判断。因为 equals 是不能用来判 null 的，会抛出 NPE 错误。

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

get 方法的内核其实还是 node 方法，这个之前已经说明过了，这里略过。

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

还可以演化为其他的一些，比如说：

getFirst() 方法用于获取第一个元素；
getLast() 方法用于获取最后一个元素；
poll() 和 pollFirst() 方法用于删除并返回第一个元素（两个方法尽管名字不同，但方法体是完全相同的）；
pollLast() 方法用于删除并返回最后一个元素；
peekFirst() 方法用于返回但不删除第一个元素。