JDK源码阅读—2.LinkedList

一，全局变量

// 链表的长度
transient int size = 0;
// 链表的头节点
transient Node<E> first;
// 链表的尾节点
transient Node<E> last;

二，静态内部类

// 因为LinkedList内部采用的是双向链表，所以实际存储内容的结构是一个名为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;
        }
}

三，构造方法

1.无参构造方法

public LinkedList() {
}

2.有参构造方法

// 直接根据传入集合构建一个集合出来
public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
}

  // addAll(int index, Collection<? extends E> c) 这个是主要的方法
  // index 表示开始插入的位置    
  public boolean addAll(int index, Collection<? extends E> c) {
        // 检测下标有无越界
        checkPositionIndex(index);
        // 将集合转为数组
        Object[] a = c.toArray();
        // 如果数组长度为0则不用添加直接返回
        int numNew = a.length;
        if (numNew == 0)
            return false;
        // pred表示前节点，succ表示当前节点
        Node<E> pred, succ;
        // 判断要插入的下标位置是否和集合的长度一样，如果一样直接在集合尾部开始插入
        if (index == size) {
            // 将当前节点置空
            succ = null;
            // 将尾节点赋值给pred
            pred = last;
        } else {
            // 如果下标位置不等于集合长度，说明要在index前面的位置开始插入元素
            // node方法是根据下标获取当前下标的元素(node方法在下面)
            succ = node(index);
            pred = succ.prev;
        }
        // 遍历要插入的集合
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            // 构建一个新的Node对象,值为e,前节点为pred
            Node<E> newNode = new Node<>(pred, e, null);
            // 如果前节点为空说明当前节点succ就是头节点，只有头节点的前节点会为空
            if (pred == null)
                // 将当前Node对象作为头节点
                first = newNode;
            else
                // 如果不是头节点，则将前面节点的next指向新Node对象
                pred.next = newNode;
            // 将新Node对象赋值给pred这样在下一波循环中可以直接使用newNode作为前节点
            // 后续元素直接添加到尾部就可以
            pred = newNode;
        }
        // 如果succ为空 说明是在原集合的尾部进行插入，那么将尾节点赋值为pred就可以了，此时         // pred是最后一个对象
        if (succ == null) {
            last = pred;
        } else {
            // 否则将添加完成的最后一个元素的后继节点指向，index后面的节点，然后将此节点
            // 的前驱节点指向最后一个节点，这样就完成了一个链表相连的过程
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;
        modCount++;
        return true;
    }
/**
 * 例：原集合元素为：1,2,3,4  要插入的集合为6,7 要插入的位置index为2 也就是需要在3前面的位置 
 * 插入6,7两个元素, 操作完成之后，正确结果为：1,2,6,7,3,4
 * 1.判断 index == size 此时index=2 size=4,所以走else逻辑，此时succ,pred值为：
 *        succ = 3;pred=2;
 * 2.遍历要插入的集合,构建一个节点newNode,前节点为pred也就是2,值为6,后节点为null
 * 3.判断pred是否为空，如果为空说明succ为头节点,所以走else逻辑,将pred的后节点指向newNode,
 *   然后将pred赋值为newNode，此时succ,pred和原集合元素为:
 *        succ = 3;pred = 6;原集合元素1,2,6
 *   因为此时6的后节点为空，所以暂时找不到后面的元素
 * 4.第二次循环,构建节点newNode,前节点为pred也就是6,值为7,后结点为空,将pred的后节点指向
 *   newNode,然后将pred赋值为newNode，此时succ,pred和原集合元素为:
 *        succ = 3;pred = 7;原集合元素1,2,6,7
 * 5.此时循环已走完,判断succ是否为空,succ为3,所以走else逻辑,将pred的后节点指向succ,
 *   将succ的前节点指向pred,所以此时7元素和2后面的元素已经成功建立连接,此时集合为
 *        1,2,6,7,3,4
 * 
 */

四，常用方法

1.add(E e) 添加方法，默认尾部添加

public boolean add(E e) {
        // 调用尾部添加方法
        linkLast(e);
        return true;
}

2.linkLast(E e) 在尾部添加元素方法

void linkLast(E e) {
        // 将尾节点last赋值给l
        final Node<E> l = last;
        // 构建一个新Node节点newNode,此时newNode前节点指向l也就是尾节点
        final Node<E> newNode = new Node<>(l, e, null);
        // 然后将尾节点指向newNode此时尾节点是newNode
        last = newNode;
        // 判断l是否为空，如果为空说明last尾节点为空，也就是说此时链表中还没有元素，那么newNode
        // 就是第一个元素，所以将头节点也指向newNode节点
        if (l == null)
            first = newNode;
        else
            // 如果不是第一个元素，那就将l的后节点指向新节点，l就是上一个尾节点，这样就完成了
            // 新节点和尾节点的相互指向
            l.next = newNode;
        size++;
        modCount++;
}

3. add(int index, E element) 在指定下标位置插入元素

public void add(int index, E element) {
        // 检测下标是否越界
        checkPositionIndex(index);
        // 如果传入的下标和链表的长度相等，则直接在尾节点插入元素
        if (index == size)
            linkLast(element);
        else
            // 在传入下标的前面插入元素，node和linkBefore方法在下面
            linkBefore(element, node(index));
}

4. node(int index)返回指定下标位置的元素

 Node<E> node(int index) {
        // 判断index是否小于链表长度的一半，如果小于则从头开始遍历，如果大于则从尾部开始遍历
        // 提升效率
        if (index < (size >> 1)) {
            Node<E> x = first;
            // 遍历链表，直到找到index位置前面一个元素，然后取前面元素的后继节点返回
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {
            Node<E> x = last;
            // 从链表尾部开始遍历，直到找到index后面一个位置的元素，然后取此元素的前驱节点返回
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
 }

5.linkBefore(E e, Node<E> succ) 在指定的下标之前插入元素

void linkBefore(E e, Node<E> succ) {
        // 当前元素的前节点
        final Node<E> pred = succ.prev;
        // 构建新节点newNode,newNode前节点指向pred后节点指向succ，所以相当于将e元素
        // 插在了succ的前面
        final Node<E> newNode = new Node<>(pred, e, succ);
        // 将succ的前节点指向newNode，此时完成了newNode和succ的相互指向
        succ.prev = newNode;
        // 判断前节点是否为空，如果为空说明当前节点succ为头节点，那么直接将头节点替换为newNode
        if (pred == null)
            first = newNode;
        else
            // 否则将pred的后节点指向newNode，这样就完成了pred和next的相互指向，此时元素
            // 成功插入到两个元素中间
            pred.next = newNode;
        size++;
        modCount++;
}

6.addFirst(E e) 插入头节点

public void addFirst(E e) {
        // 方法在下面
        linkFirst(e);
}

7.linkFirst(E e) 将元素e插入头节点

private void linkFirst(E e) {
        // 先将头节点赋值给f，后面要用
        final Node<E> f = first;
        // 构建新节点newNode，因为newNode要成为头节点所以newNode前节点为空，后节点为头节点f
        final Node<E> newNode = new Node<>(null, e, f);
        // 将头节点指向newNode
        first = newNode;
        // 如果f等于null，说明链表中还没有元素，此时newNode插入的是第一个元素，所以将尾节点
        // last也指向newNode
        if (f == null)
            last = newNode;
        else
            // 如果不是，直接将f也就是上一个头节点的前节点指向新节点，至此就完成了新节点和
            // 头节点的相互指向
            f.prev = newNode;
        size++;
        modCount++;
}

8.get(int index) 获取元素

public E get(int index) {
        // 检测下标是否越界
        checkElementIndex(index);
        // 返回对应index位置的元素，node方法在上面有写
        return node(index).item;
}

9. getFirst() 获取链表中的第一个元素

public E getFirst() {
        final Node<E> f = first;
        // 判断头节点是否为空，如果为空说明链表中还没有元素，直接抛出异常
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
}

10.getLast() 获取尾节点的元素

方法同上

11.indexOf(Object o) 找出给定元素在链表中的下标位置

 public int indexOf(Object o) {
        int index = 0;
        if (o == null) {
            // 从头开始遍历元素，每遍历一次则将index+1 直到尾节点，如果找不到则返回-1
            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;
 }

12. clear() 清空链表中的元素

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

13.peek() 返回链表中的头节点

// 此方法和getFirst()不同的地方是在getFirst中如果头节点为空，会抛出
// NoSuchElementException()
// peek()则会直接返回空
public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
}

14.poll() 移除头节点并返回

public E poll() {
        final Node<E> f = first;
        // 主要看下面的unlinkFirst方法
        return (f == null) ? null : unlinkFirst(f);
}

15.unlinkFirst(Node<E> 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;
        f.next = null; // help GC
        // 将头节点赋值指向next节点
        first = next;
        // 如果后节点为空说明要移除的已经是链表中的最后一个元素，
        // 然后将尾节点置空
        if (next == null)
            last = null;
        else
            // 此时next已经为头节点，所以将前节点置空
            next.prev = null;
        size--;
        modCount++;
        return element;
 }

16.pollLast() 移除尾元素并且返回

public E pollLast() {
        final Node<E> l = last;
        // 主要看unlinkLast() 方法 在下面
        return (l == null) ? null : unlinkLast(l);
}

17.unlinkLast(Node<E> l) 移除尾节点

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
        // 将尾节点指向pre节点
        last = prev;
        // 如果prev为空 说明要移除的节点已经是链表中的最后一个元素
        // 所以将头节点置空
        if (prev == null)
            first = null;
        else
            // 此时prev已经是尾节点，所以将他的后节点置空
            prev.next = null;
        size--;
        modCount++;
        return element;
}

18.pop() 移除头节点

 public E pop() {
        // 此方法会直接调用移除头节点的方法，和poll不同的是，如果头节点为空则会抛出异常
        return removeFirst();
 }

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

19.push(E e) 将元素添加为连表的头节点

public void push(E e) {
        // 内部调用的是addaddFirst(),此方法在上面
        addFirst(e);
}

20.E remove() 删除头元素并返回

public E remove() {
        // 此方法和pop一样，都是返回头节点，如果链表为空则抛出异常
        return removeFirst();
}

21.remove(int index) 移除指定下标的元素

public E remove(int index) {
        // 检测下标有无越界
        checkElementIndex(index);
        // 主要看unlink方法，在下面
        return unlink(node(index));
}

22.E unlink(Node<E> x) 删除链表中指定的元素

E unlink(Node<E> x) {
        // 去除指定元素节点的值用来返回
        final E element = x.item;
        // 指定元素的后节点
        final Node<E> next = x.next;
        // 指定元素的前节点
        final Node<E> prev = x.prev;
        // 如果前节点为空，说明x是头节点，那么直接将头节点的后节点指向x的后节点就可以
        if (prev == null) {
            first = next;
        } else {
            // 否则将x的前结点的后节点执行x的后节点
            prev.next = next;
            // 然后将x的前结点置空
            x.prev = null;
        }
        // 如果x的后节点为空，则说明x是尾节点，所以直接将尾节点指向x的前节点
        if (next == null) {
            last = prev;
        } else {
            // 否则将x的后节点指向x的前节点，相当于直接跳过x进行链接
            next.prev = prev;
            // 将x的后节点置空
            x.next = null;
        }

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

23.remove(Object o) 移除指定 元素

/**
* 该方法主要是从头遍历链表知道找出和指定元素相等的元素，然后移除
*/
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;
}

24.set(int index, E element) 将指定位置的元素替换成指定元素

public E set(int index, E element) {
        // 检测下标是否越界
        checkElementIndex(index);
        // 去除下标位置的元素，然后直接替换成新元素，将老元素返回
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
}