Java源码系列(6) -- LinkedList

Posted by phantomVK on January 16, 2018

一、介绍

Java常用的List实现有ArrayList和LinkedList。ArrayList通过数组实现,LinkedList通过链表实现。由于Java没有指针的概念,所以通过保存下一实例引用的方式实现链表。

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable

二、数据成员

LinkedList中保存元素的总数量,每次增删元素都会修改此值。

transient int size = 0;

头指针

// Invariant: (first == null && last == null) || (first.prev == null && first.item != null)
transient Node<E> first;

尾指针

// Invariant: (first == null && last == null) || (last.next == null && last.item != null)
transient Node<E> last;

三、构造方法

默认构造方法

public LinkedList() {
}

用指定集合构建列表,传入集合元素访问顺序由集合迭代器决定

public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c); // 若c为空抛空指针异常
}

四、成员方法

4.1 插入

把元素作为首节点插入列表。新节点作为列表的头节点,所以新节点的前导节点为空。下一个节点是否为空,取决于列表是否已保存其他元素。

如果列表原本为空,则新节点的后继节点为空,头指针和尾指针同时指向该新添加的节点。

private void linkFirst(E e) {
    final Node<E> f = first;
    // 上一个元素为null,节点item为e,下一个元素为f
    final Node<E> newNode = new Node<>(null, e, f);
    // 新节点作为头结点
    first = newNode;
    // 处理新节点的后继节点引用
    if (f == null)
        last = newNode;
    else
        f.prev = newNode;
    size++;
    modCount++;
}

把元素作为最后一个节点插入

void linkLast(E e) {
    final Node<E> l = last;
    // 上一个元素为l,节点item为e,下一个元素为null
    final Node<E> newNode = new Node<>(l, e, null);
    // 新节点作为尾节点
    last = newNode;
    // 处理新节点的上一节点引用
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    size++;
    modCount++;
}

在一个非空节点succ之前插入元素e

void linkBefore(E e, Node<E> succ) {
    // succ的前一个节点pred
    final Node<E> pred = succ.prev;

    // 创建新节点newNode,分别设置其前后指针为pred和succ
    final Node<E> newNode = new Node<>(pred, e, succ);

    // 把succ向前方向的指针从指向pred改为指向newNode
    succ.prev = newNode;

    // succ原前指针为null可推断succ是头结点,然后把新插入newNode作为头结点
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    size++;
    modCount++;
}

4.2 解除链接

解链接第一个非空的节点,私有方法

private E unlinkFirst(Node<E> f) {
    final E element = f.item;
    final Node<E> next = f.next;
    f.item = null; // 移除f的负载
    f.next = null; // 清除f对后继节点的引用
    first = next;  // 修改头指针到f的下一个节点
    
    // f的下一个节点为null可推断原链表有且仅有f一个节点
    if (next == null)
        // 链表没有任何元素,尾指针置空
        last = null;
    else
        // 下一个节点的前指针置空,避免指向f节点造成内存泄漏
        next.prev = null;
    size--;
    modCount++;
    return element;
}

解链接最后一个非空节点,私有方法,逻辑类似上述unlinkFirst

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

解连接非空节点

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) {
        // x是头结点,把后继节点成为头结点
        first = next;
    } else {
        // x是中间节点,把prev.next指向x后继节点
        prev.next = next;
        // 清除x的前指针
        x.prev = null;
    }

    if (next == null) {
        // x是尾节点,把倒数第二个节点设为尾节点
        last = prev;
    } else {
        // x是中间节点,把next.prev指向x前节点
        next.prev = prev;
        // 清除x的后指针
        x.next = null;
    }

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

4.3 获取头尾元素

获取列表的头元素

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

获取列表的尾节点。由于有尾指针,所以不需要遍历整条链表。

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

4.4 移除头尾元素

如果仅有一个元素,那么头指针和尾指针指向的是同一个元素。头指针为空或尾指针为空,有且只有在列表为空时成立,并且是同时成立。

// 移除并返回列表的第一个元素
public E removeFirst() {
    final Node<E> f = first;
    // 列表是空的,没有元素可以移除,抛出异常
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

// 移除并返回列表的最后一个元素
public E removeLast() {
    final Node<E> l = last;
    // 列表是空的,没有元素可以移除,抛出异常
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}

4.5 增删查改

当列表中存在该对象时返回true,否则返回false

public boolean contains(Object o) {
    return indexOf(o) != -1;
}

把指定元素附加到列表最后,和addLast()一样,尾插法

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

从列表中移除第一个与对象o相同且存在的元素。如果列表不存在该元素,列表数据不会修改。

public boolean remove(Object o) {
    if (o == null) {
        // 移除遇到第一个item为null的节点
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        // 移除遇到第一个item为o的节点
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

把集合内元素通过尾插法插入到链表中,插入顺序由集合的迭代器决定。如果列表正在加入集合的元素,同时集合本身元素也在变化,那导致最终结果是不可预知的。

public boolean addAll(int index, Collection<? extends E> c) {
    // 检查索引是否越界
    checkPositionIndex(index);

    // 指定集合转换为Object数组
    Object[] a = c.toArray();
    // 计算指定集合元素的数量
    int numNew = a.length;
    // 指定集合没有元素,直接返回false
    if (numNew == 0)
        return false;

    Node<E> pred, succ;
    if (index == size) {
        // 刚好插入在已有元素尾部的下一个位置
        succ = null;
        pred = last;
    } else {
        // 新集合元素插入到(原index)元素和(原index+1)元素之间
        succ = node(index);
        pred = succ.prev;
    }

    for (Object o : a) {
        @SuppressWarnings("unchecked") E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        // succ.pred为空表示succ是头结点
        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 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 void add(int index, E element) {
    checkPositionIndex(index);

    if (index == size)
        linkLast(element);
    else
        linkBefore(element, node(index));
}

// 在列表中移除指定位置元素,被移除元素作为结果返回。
public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

// 检查参数index是否为一个存在元素的索引值
private boolean isElementIndex(int index) {
    return index >= 0 && index < size;
}

// 检查参数index是否是一个迭代器的有效索引值或是一个添加操作
private boolean isPositionIndex(int index) {
    return index >= 0 && index <= size;
}

// 返回指定索引位置的非空节点
Node<E> node(int 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;
    }
}

// 查找遇到的第一个与指定元素相同的节点的下标
// 列表不包含该元素则返回-1
public int indexOf(Object o) {
    int index = 0;
    // 如果o为空,就查找第一个遇到item为null节点的下标
    if (o == null) {
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null)
                return index;
            index++;
        }
    } else {
        // 否则会把每个节点下的item与指定对象检查一致
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item))
                return index;
            index++;
        }
    }
    return -1;
}

// 查找遇到的最后一个与指定元素相同节点的下标
// 列表不包含该元素则返回-1
public int lastIndexOf(Object o) {
    int index = size;
    if (o == null) {
        // 倒序遍历
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (x.item == null)
                return index;
        }
    } else {
        // 否则会把每个节点下的item与指定对象检查一致
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (o.equals(x.item))
                return index;
        }
    }
    return -1;
}

// 获取头指针指向节点的item,该操作不会移除节点
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

// 获取头指针指向节点的item,该操作不会移除节点
public E element() {
    return getFirst();
}

// 获取头指针指向节点的item,该操作会移除节点
public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

// 取出并移除列表的头结点
public E remove() {
    return removeFirst();
}

// 把元素作为尾节点添加到列表中
public boolean offer(E e) {
    return add(e);
}

// 把元素作为列表头结点加入
public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

// 把元素作为列表的尾节点加入
public boolean offerLast(E e) {
    addLast(e);
    return true;
}

// 获取但不移除列表第一个节点元素,列表为空返回null
public E peekFirst() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
 }

// 获取但不移除列表第一个节点元素,列表为空返回null
public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

// 获取并移除列表第一个节点元素,列表为空返回null
public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

// 获取并移除列表最后一个节点元素,列表为空返回null
public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

// 把一个元素压到一个相当于栈的列表里面
// 换句话说就是在列表首位插入元素
public void push(E e) {
    addFirst(e);
}

// 把一个元素从一个相当于栈的列表中弹出
// 换句话说就是移除并返回列表的第一个元素
// 这个功能相当于removeFirst()
public E pop() {
    return removeFirst();
}

// 移除第一个包含指定实例的节点,成功返回true,否者返回false,且列表不做改变
// 此方法顺序遍历
public boolean removeFirstOccurrence(Object o) {
    return remove(o);
}

// 移除最后一个包含指定实例的节点,成功返回true,否者返回false,且列表不做改变
// 此方法倒序遍历
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;
}

六、链表节点模型

这是双向链表的模型,包含上一个节点的指针,下一个节点的指针,和节点持有的实例

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

七、列表转数组

返回一个包含所有元素的数组,元素顺序从链表第一位到最后一位。如果列表是空列表,会安全返回一个元素数量为0的数组对象。由于返回的数组与原链表无关,所以对数组的修改不会影响原链表。

public Object[] toArray() {
    // 首先构造一个与链表中元素数量一致的数组
    Object[] result = new Object[size];
    int i = 0;
    // 顺序遍历链表,把元素按照对应下表放入数组
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;
    // 返回数组
    return result;
}

返回一个包含所有链表元素的数组,数组元素保存顺序与链表顺序一致。数组的返回类型由数组声明的类型为准,而不是链表节点保存的类型。

如果数组空间足够保存所有链表元素,则正常返回传入数组。否则创建一个与数组类型一致,容量与链表长度一致的新数组。如果传入数组的容量大于链表的长度,则把最后链表节点对应数组位置的下一个数组空间置空。这样有助于计算数组实际包含的元素数。

@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
    if (a.length < size)
        // 通过反射构造一个新的,有足够空间的新数组
        a = (T[])java.lang.reflect.Array.newInstance(
                            a.getClass().getComponentType(), size);
    int i = 0;
    Object[] result = a;
    // 顺序遍历链表,把元素按照对应下标放入数组
    for (Node<E> x = first; x != null; x = x.next)
        result[i++] = x.item;

    // 还有剩余数组空间,则把第一个遇到的空闲空间置为null
    if (a.length > size)
        a[size] = null;

    // 返回数组
    return a;
}