JDK1.8源码阅读之java.util.LinkedList

JDK1.8源码阅读之java.util.LinkedList

节点

在LinkedList内有一个Node<E>静态内部类。用于表示节点，其代码如下

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

可以看到这个链表是一个双向链表。在Node的构造方法中，只将本节点的prev和next标记了。而prev.next与next.prev的标记放到了具体添加节点的时候。

构造方法

// 无参构造
public LinkedList() {
}

// 有参构造，输入的是集合
// 先将集合通过toArray转换成数组，然后遍历数组，生成节点插入即可
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(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;
}

插入节点的方法

// 在链表首部添加节点
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++;
}

// 在链表尾部添加节点
// add与addLast的区别仅在返回值上体现。
public boolean add(E e) {
    linkLast(e);
    return true;
}
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++;
}

// 在某个节点前面添加节点
public void add(int index, E element) {
    checkPositionIndex(index);

    if (index == size)
        linkLast(element);
    else
    	// 先找到第index个Node，在这个Node前加上一个节点
        linkBefore(element, node(index));
}
Node<E> node(int index) {
    // assertisElementIndex(index);

	// 计算index与size/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;
    }
}
void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    final Node<E> pred = succ.prev;
    final Node<E> newNode = new Node<>(pred, e, succ);
    succ.prev = newNode;
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    size++;
    modCount++;
}

删除节点的方法

// 删除第index个节点
public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}
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;
}

// 删除链表第一个节点
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;
    // 断开与下一个节点的链接，释放其的引用，有助于JVM的GC
    f.next = null; 
    first = next;
    if (next == null)
        last = null;
    else
        next.prev = null;
    size--;
    modCount++;
    return element;
}

// 删除链表的最后一个节点
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;
    // 断开与前一个节点的链接，释放其的引用，有助于JVM的GC
    l.prev = null; 
    last = prev;
    if (prev == null)
        first = null;
    else
        prev.next = null;
    size--;
    modCount++;
    return element;
}

// remove能够与o equals或者都是null的节点
// 这里的输入为什么是Object而不是泛型E？
// 解答看https://blog.csdn.net/Turnhead/article/details/83537387
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;
}

// 删除所有
public void clear() {
	// 遍历链表
    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++;
}

获取与设置元素

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

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

// 获取第一个元素
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}
// 如果第一个元素是null，则扔出异常NoSuchElementException
public E element() {
    return getFirst();
}
// 获取第一个元素，并将它移除链表
public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}