Source code analysis of adding and removing elements of LinkedList

LinkedList is based on doubly linked list storage

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

execute the following code

LinkedList<Integer> list = new LinkedList<>();
list.add(1);
list.add(2);
list.add(3);
list.remove(1);

1 add

When the add() method is called

public boolean add(E e) {
    // 将元素添加到链表末尾
    linkLast(e);
    return true;
}

linkLast method

void linkLast(E e) {
    // last 指向最后一个节点，在没有添加元素时为 null
    final Node<E> l = last;
    // 创建一个新节点，添加第一个元素时 l = null
    final Node<E> newNode = new Node<>(l, e, null);
    last = newNode;
    // 第一次添加元素成立，将 first 指向首节点
    if (l == null)
        first = newNode;
    else  // 将旧的尾节点指向新添加的节点
        l.next = newNode;
    size++;
    modCount++;
}

2 remove

list.remove(1);

remove() method

public E remove(int index) {
    // 检测 index 是否越界
    checkElementIndex(index);
    // 从链表移除 index 处的节点
    return unlink(node(index));
}

node method

// 返回指定索引处的节点
Node<E> node(int index) {
    // 指定的索引值与链表大小右移一位，及除以 2 进行比较
    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;
    }
}

unlink method

// 将指定节点从链表中移除，并返回移除的节点
E unlink(Node<E> x) {
    final E element = x.item;
    final Node<E> next = x.next;
    final Node<E> prev = x.prev;

    if (prev == null) { // 待移除节点是首节点，将 first 属性指向此节点的直接后继
        first = next;
    } else { // 非首节点，将待移除节点直接前驱的 next 属性指向待移除节点的直接后继
        prev.next = next;
        x.prev = null;
    }

    if (next == null) { // 待移除节点是尾节点，将 last 属性指向此节点的直接前驱
        last = prev;
    } else { // 非尾节点，将待移除节点直接后继的 prev 属性指向待移除节点的直接前驱
        next.prev = prev;
        x.next = null;
    }
    // 此时，指定节点已从链表中拆下来了

    x.item = null;
    size--;
    modCount++;
    return element;
}