LinkedList源码分析

问题提出

• LinkedList底层的数据结构是什么？

• LinkedList是线程安全的吗？

• 下面源码可以知道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;
    }
}

重要属性

transient int size = 0;

/**
 * Pointer to first node.
 */
transient Node<E> first;

/**
 * Pointer to last node.
 */
transient Node<E> last;

构造函数

public LinkedList() {
}
//构造一个包含指定Collection的 list
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}
//按照指定集合的​​迭代器返回的顺序，将指定集合中的所有元素追加到此列表的末尾。
public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

构造函数中涉及到addAll(size,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;
    //pred 存放要添加节点的前一个节点
    //succ 存放要添加的节点（这部分自己画图理解会更清楚）
    Node<E> pred, succ;
    //要存放的位置在链表尾部
    if (index == size) {
        succ = null;
        pred = last; //前一个节点就是尾节点
    } else {
        //要存放的位置在链表中间
        succ = node(index);  //找出要放入位置的节点
        pred = succ.prev;  //找出前一个节点
    }
    //遍历数组a，为每个元素创建一个节点
    for (Object o : a) {
        @SuppressWarnings("unchecked") E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        if (pred == null) //pred==null说明当前节点是头节点
            //更新头节点
            first = newNode;
        else //若不是头节点
            //前一个节点的next指向新节点
            pred.next = newNode;
        pred = newNode;
    }

    if (succ == null) {
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }

    size += numNew;
    modCount++;
    return true;
}

• 看下面这个图，有助于理解~~~可惜我不会做动图，那样会更清楚

  
  LinkedList-addAll (1).jpg

相关方法

添加元素

• 将指定元素插入末尾

public void addLast(E e) {
    linkLast(e);
}

• 将指定的元素追加到此LinkedList的末尾。

public boolean add(E e) {
    linkLast(e);
    return true;
}
void linkLast(E e) {
    final Node<E> l = last;
    //创建一个新节点，将之前的last赋值给新节点的pre
    final Node<E> newNode = new Node<>(l, e, null);
    //更新尾节点last
    last = newNode;
    //若当前链表长度为0，直接将新节点设置为头节点 
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    size++;
    modCount++;
}

LinkLast的执行过程如下：

LinkedList-addLast.jpg

• 将元素插入指定位置

public void add(int index, E element) {
    //越界检测
    checkPositionIndex(index);

    if (index == size)
        linkLast(element); //尾部插入的源码上面已经分析过了
    else
        linkBefore(element, node(index));
}
//下面看linkBefore(element, node(index))
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++;
}

linkBefore的执行过程如下：

LinkedList-linkBefore.jpg

• 将指定元素插入开头

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

LinkedList-addFirst.jpg

• 这几个方法的源码上面都已经分析过了

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

删除元素

• 删除指定元素

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 boolean removeFirstOccurrence(Object o) {
    return remove(o);
}

-删除最后一次出现的指定元素

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 remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

上面这几个方法最终都是调用unlink方法，现在来分析一下该方法

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

unlink的执行过程如下：

LinkedList-unlink.jpg

下面这几个方法比较简单，就不画图了。

• 删除列表的头

public E remove() {
    return removeFirst();
}

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;
    //要删除的头节点置为null
    f.item = null;
    f.next = null; // help GC
    //更新头节点
    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;
    l.prev = null; // help GC
    //更新尾节点
    last = prev;
    if (prev == null)
        first = null;
    else
        prev.next = null;
    size--;
    modCount++;
    return element;
}

• 删除列表中的所有元素

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 getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}
public E element() {
    return getFirst();
}

• 返回此列表中最后一个元素

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

• 返回此列表中指定位置的元素

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;
}
public E peekFirst() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

• 返回尾节点，若列表为null,返回null

public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

• 检索并删除此列表的头

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 void push(E e) {
    addFirst(e);
}

• 从此列表表示的堆栈中弹出一个元素

public E pop() {
    return removeFirst();
}

小结

1.LInkedList使用链表来存储数据。

2. 通过源码可以看出lInkedList是线程不安全的。_