【集合类】源码解析之 AbstractSequentialList 抽象类、LinkedList类

AbstractSequentialList 抽象类

顺序列表，相对于RandomAccess标记接口而言，继承了RandomAccess接口表示其容器支持随机访问，这类容器优先使用索引进行操作，而对于不支持随机访问的容器通常使用迭代器进行操作

类声明

public abstract class AbstractSequentialList<E> extends AbstractList<E>

方法实现

通过迭代器对List的 get()、add()、set()、remove() 方法进行实现

protected AbstractSequentialList() {
}

public E get(int index) {
    try {
        return listIterator(index).next();
    } catch (NoSuchElementException exc) {
        throw new IndexOutOfBoundsException("Index: "+index);
    }
}

public E set(int index, E element) {
    try {
        ListIterator<E> e = listIterator(index);
        E oldVal = e.next();
        e.set(element);
        return oldVal;
    } catch (NoSuchElementException exc) {
        throw new IndexOutOfBoundsException("Index: "+index);
    }
}


public void add(int index, E element) {
    try {
        listIterator(index).add(element);
    } catch (NoSuchElementException exc) {
        throw new IndexOutOfBoundsException("Index: "+index);
    }
}

public E remove(int index) {
    try {
        ListIterator<E> e = listIterator(index);
        E outCast = e.next();
        e.remove();
        return outCast;
    } catch (NoSuchElementException exc) {
        throw new IndexOutOfBoundsException("Index: "+index);
    }
}

public boolean addAll(int index, Collection<? extends E> c) {
    try {
        boolean modified = false;
        ListIterator<E> e1 = listIterator(index);
        Iterator<? extends E> e2 = c.iterator();
        while (e2.hasNext()) {
            e1.add(e2.next());
            modified = true;
        }
        return modified;
    } catch (NoSuchElementException exc) {
        throw new IndexOutOfBoundsException("Index: "+index);
    }
}


// Iterators

public Iterator<E> iterator() {
    return listIterator();
}

public abstract ListIterator<E> listIterator(int index);

LinkedList

双向链表结构，线程不安全，增删快查询慢

类声明

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

基础单元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;
    }
}

重点字段

// 节点数
transient int size = 0;

// 指向头节点
transient Node<E> first;

// 指向尾节点
transient Node<E> last;

构造函数

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

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

List方法

（一）添加

// 将指定的元素追加到此链表的末尾
public boolean add(E e) {
    linkLast(e);
    return true;
}

public void add(int index, E element) {
    // 校验索引合理性 index >= 0 && index <= size
    checkPositionIndex(index);

    if (index == size)
        // 如果是最后一个位置，则直接追加到链表末尾
        linkLast(element);
    else
        // 否则添加到index节点前面
        linkBefore(element, node(index));
}

// 将集合元素添加到链表末尾
public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

public boolean addAll(int index, Collection<? extends E> c) {
	// 校验索引的合法性 index >= 0 && index <= size
    checkPositionIndex(index);

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

    // pred是插入位置的前一个节点，succ是插入位置的原节点
    Node<E> pred, succ;
    if (index == size) {
        // 若是在链表尾部添加，则last节点为pred
        succ = null;
        pred = last;
    } else {
        // 查找index的节点元素，该元素的前继节点即为pred
        succ = node(index);
        pred = succ.prev;
    }

    for (Object o : a) {
        @SuppressWarnings("unchecked") E e = (E) o;
        // 以 pred 作为前继节点，e作为当前元素，null作为后继节点构成新节点
        Node<E> newNode = new Node<>(pred, e, null);
        if (pred == null)
            // 如果 pred 为空则代表新节点插入在头节点之前，要将头节点更新为新节点
            first = newNode;
        else
            // 将前继节点的下个节点更新为新节点
            pred.next = newNode;
        // 将当前节点作为前继节点继续循环
        pred = newNode;
    }

    if (succ == null) {
        // 如果是在尾部添加，则将循环的最后一个元素置为尾元素
        last = pred;
    } else {
        // 否则循环的最后一个元素的下个节点为succ(插入位置的原节点)
        pred.next = succ;
        // succ的前继节点为循环的最后一个元素
        succ.prev = pred;
    }

    // 更新链表大小和修改次数
    size += numNew;
    modCount++;
    return true;
}

（二）删除

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

// 先找到该索引的元素再调用unlink删除
public E remove(int index) {
	// 校验索引的合法性 index >= 0 && index < size
    checkElementIndex(index);
    return unlink(node(index));
}

// 通过for循环将每个节点清空
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 set(int index, E element) {
	// 校验索引的合法性 index >= 0 && index < size
    checkElementIndex(index);
    Node<E> x = node(index);
    E oldVal = x.item;
    x.item = element;
    return oldVal;
}

（四）查询

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

public int size() {
    return size;
}

// 通过索引获取节点
public E get(int index) {
	// 校验索引的合法性 index >= 0 && index < size
    checkElementIndex(index);
    return node(index).item;
}

// 循环对比 next
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;
}

// 倒序循环对比 prev
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 {
        for (Node<E> x = last; x != null; x = x.prev) {
            index--;
            if (o.equals(x.item))
                return index;
        }
    }
    return -1;
}

// 返回数组副本
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;

    if (a.length > size)
        a[size] = null;

    return a;
}

Deque方法

（一）添加 通过linkFirst、linkLast实现

// 向链表头部添加元素
public void addFirst(E e) {
    linkFirst(e);
}

// 向链表尾部添加元素
public void addLast(E e) {
    linkLast(e);
}

// 入队
public boolean offer(E e) {
    return add(e); // 也是调用linkLast(e)
}

// 队头入队
public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

// 队尾入队
public boolean offerLast(E e) {
    addLast(e);
    return true;
}

// 入栈
public void push(E e) {
    addFirst(e);
}

（二）删除 通过unlinkFirst、unlinkLast实现

// 删除链表头节点
public E remove() {
    return removeFirst();
}

// 删除链表头节点
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);
}

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

// 队头出队
public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

// 队尾出队
public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

// 出栈
public E pop() {
    return removeFirst();
}

// 从此deque中删除指定元素的第一个匹配项  for next
public boolean removeFirstOccurrence(Object o) {
    return remove(o);
}

// 从此deque中删除指定元素的最后一个匹配项 for prev
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;
}

（三）查询

// 获取第一个元素 头节点
public E element() {
    return getFirst();
}

// 获取第一个元素 头节点
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;
}

// 返回但不删除第一个元素 头节点
public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

// 返回但不删除第一个元素 头节点
public E peekFirst() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

// 返回但不删除最后一个元素 尾节点
public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

工具方法

// 查找第index个元素
Node<E> node(int index) {
    // index和size中值做对比，如果小于中值则从前往后找，如果大于等于中值则从后往前找
    if (index < (size >> 1)) {
        Node<E> x = first;
        for (int i = 0; i < index; i++)
           	// 直到找到i=index-1为止，next指向的下个节点就是需要查找的节点
            x = x.next;
        return x;
    } else {
        Node<E> x = last;
        for (int i = size - 1; i > index; i--)
            // 直到找到i=index+1为止，next指向的上个节点就是需要查找的节点
            x = x.prev;
        return x;
    }
}

// 将元素添加至链表头部
private void linkFirst(E e) {
    // 头节点
    final Node<E> f = first;
    // 以 null 作为前继节点，e作为当前元素，f 作为后继节点构成新节点
    final Node<E> newNode = new Node<>(null, e, f);
    // 将头节点更新为新节点
    first = newNode;
    if (f == null)
        // 如果链表为null，则将尾节点更新为新节点，即新节点既是头节点也是尾结点
        last = newNode;
    else
        // 如果链表不为空，则将原头节点（现在是第二个节点）前继节点更新为新节点
        f.prev = newNode;
    size++;
    modCount++;
}

// 将元素添加至链表尾部
void linkLast(E e) {
    // 尾结点
    final Node<E> l = last;
    // 以 l 作为前继节点，e作为当前元素，null作为后继节点构成新节点
    final Node<E> newNode = new Node<>(l, e, null);
    // 将尾结点更新为新节点
    last = newNode;
    if (l == null)
        // 如果链表为null，则将头节点更新为新节点，即新节点既是头节点也是尾结点
        first = newNode;
    else
        // 如果链表不为空，则将原尾节点（现在是倒数第二个节点）的后继节点更新为新节点
        l.next = newNode;
    // 更新链表大小和修改次数
    size++;
    modCount++;
}

// 在succ节点之前插入元素
void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    // succ的原前继节点
    final Node<E> pred = succ.prev;
    // 以 pred 作为前继节点，e作为当前元素，succ作为后继节点构成新节点
    final Node<E> newNode = new Node<>(pred, e, succ);
    // 将succ的前继节点更新为新节点
    succ.prev = newNode;
    if (pred == null)
        // 如果 pred 为空则代表新节点插入在头节点之前，要将头节点更新为新节点
        first = newNode;
    else
        // 否则将succ原前继节点的后继节点更新为新节点
        pred.next = newNode;
    // 更新链表大小和修改次数
    size++;
    modCount++;
}

// 删除链表头节点
private E unlinkFirst(Node<E> f) {
    // 头节点
    final E element = f.item;
    // 第二个节点
    final Node<E> next = f.next;
    f.item = null;
    f.next = null; // help GC
    // 将头节点更新为第二个节点
    first = next;
    if (next == null)
        // 如果第二个节点为null，代表删除头节点后队列为空，将尾节点置为null
        last = null;
    else
        // 否则将第二个节点（新头节点）的前继节点置为null
        next.prev = null;
    // 更新链表大小和修改次数
    size--;
    modCount++;
    return element;
}

// 删除链表尾节点
private E unlinkLast(Node<E> l) {
    // 尾节点
    final E element = l.item;
    // 倒数第二个节点
    final Node<E> prev = l.prev;
    l.item = null;
    l.prev = null; // help GC
    // 将尾节点更新为倒数第二个节点
    last = prev;
    if (prev == null)
        // 如果第倒数二个节点为null，代表删除尾节点后队列为空，将头节点置为null
        first = null;
    else
        // 否则将倒数第二个节点（新尾节点）的后继节点置为null
        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) {
        // 如果前置节点为空，则代表删除的是头节点，将头节点更新为当前节点的下个节点
        first = next;
    } else {
        // 否则将前置节点的下个节点更新为当前节点的下个节点
        prev.next = next;
        // 将当前节点的前置节点置为null
        x.prev = null;
    }

    if (next == null) {
        // 如果后置节点为空，则代表删除的是尾节点，将尾节点更新为当前节点的上个节点
        last = prev;
    } else {
        // 否则将下个节点的前置节点更新为当前节点的上个节点
        next.prev = prev;
        // 将当前节点的后置节点置为null
        x.next = null;
    }

    // 将当前被删除元素置为null
    x.item = null;
    // 更新链表大小和修改次数
    size--;
    modCount++;
    return element;
}

序列化

private static final long serialVersionUID = 876323262645176354L;

private void writeObject(java.io.ObjectOutputStream s)
    throws java.io.IOException {
    // Write out any hidden serialization magic
    s.defaultWriteObject();

    // Write out size
    s.writeInt(size);

    // Write out all elements in the proper order.
    for (Node<E> x = first; x != null; x = x.next)
        s.writeObject(x.item);
}

@SuppressWarnings("unchecked")
private void readObject(java.io.ObjectInputStream s)
    throws java.io.IOException, ClassNotFoundException {
    // Read in any hidden serialization magic
    s.defaultReadObject();

    // Read in size
    int size = s.readInt();

    // Read in all elements in the proper order.
    for (int i = 0; i < size; i++)
        linkLast((E)s.readObject());
}

其余方法

public ListIterator<E> listIterator(int index) {
    checkPositionIndex(index);
    return new ListItr(index);
}

private class ListItr implements ListIterator<E> {
   ...
}

public Iterator<E> descendingIterator() {
    return new DescendingIterator();
}

private class DescendingIterator implements Iterator<E> {
   ...
}

@Override
public Spliterator<E> spliterator() {
    return new LLSpliterator<E>(this, -1, 0);
}

static final class LLSpliterator<E> implements Spliterator<E> {
    ...
}

@SuppressWarnings("unchecked")
private LinkedList<E> superClone() {
    try {
        return (LinkedList<E>) super.clone();
    } catch (CloneNotSupportedException e) {
        throw new InternalError(e);
    }
}

public Object clone() {
    LinkedList<E> clone = superClone();

    // Put clone into "virgin" state
    clone.first = clone.last = null;
    clone.size = 0;
    clone.modCount = 0;

    // Initialize clone with our elements
    for (Node<E> x = first; x != null; x = x.next)
        clone.add(x.item);

    return clone;
}