Debug LinkedList

Debug LinkedList源码

前置知识

• LinkedList基于链表，LinkedList的Node节点定义

• 成员变量

   	//链表中元素的数量
      transient int size = 0;
  
      /**
       * 链表的头节点：用于遍历
       */
      transient Node<E> first;
  
      /**
  	* 链表的尾节点：用于添加元素
       */
      transient Node<E> last;
  

2.1 Debug 分析第一个元素是如何进入链表的

编写测试代码，打上断点：

进入方法内部：

• add方法默认添加到链表的尾部
• 该方法等同于addLast（区别就是add方法需要返回一个true，而addLast没有任何返回值）

进入linkLast方法内部：

	/**
     * 当前方法执行完后，若添加的节点为第一个节点，链表的last和first都指向新节点
     */
    void linkLast(E e) {
        //获取到链表的最后一个元素
        final Node<E> l = last;
        //创建一个节点，前一个节点为当前链表的last，后一个节点为空
        final Node<E> newNode = new Node<>(l, e, null);
        //修改last为新添加的节点
        last = newNode;
        //若链表为空，first节点为新添加的节点，否则添加前最后一个节点的next指向新节点
        if (l == null)
            first = newNode;
        else
            l.next = newNode;

            //链表长度加一
        size++;
        	//链表修改次数加1
        modCount++;
    }

//=================================================================

    Node带三个参数的构造函数：
    Node(Node<E> prev, E element, Node<E> next) {
            this.item = element;
            this.next = next;
            this.prev = prev;
        }

2.2 Debug 分析如何通过下标插入指定位置add（index，e）

编写测试用例：

进入方法内部：

public void add(int index, E element) {
		//检查下标是否合法：大于等于0小于等于size【return index >= 0 && index <= size;】
        checkPositionIndex(index);

		//若等于size，相当于在链表尾部添加节点
        if (index == size)
            linkLast(element);
        else
        //linkBefore中的Before指的是传入索引元素前
            linkBefore(element, node(index));
    }

进入node（index）方法：返回索引为index的元素

Node<E> node(int index) {
        // assert isElementIndex(index);

	   //查找元素的思路是遍历一半，先折半分区，然后若在小于折半的区域就从first开始往后遍历，反之从last往前遍历
	   //右移一位相当于除以2
        if (index < (size >> 1)) {
        //获取到first节点
            Node<E> x = first;
            //从first遍历到index的位置
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {

        //获取到next的节点
            Node<E> x = last;
            //从last往前遍历到index的位置
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }

回到linkBefore方法：

void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        //获取index节点的上一个节点
        final Node<E> pred = succ.prev;
        //创建新节点，下一个节点指向index节点，上一个节点指向index节点的上一个节点
        final Node<E> newNode = new Node<>(pred, e, succ);
        //index节点的上一个节点指向变为指向新节点
        succ.prev = newNode;
        //**若index节点的头节点为空，相当于从头部插入节点，直接将新节点赋给first节点
        if (pred == null)
            first = newNode;
        else
        //index的上一个节点的下一个节点指向改为新节点
            pred.next = newNode;

            //节点长度+1
        size++;
            //链表修改次数+1
        modCount++;
    }

2.3 Debug 分析如何通过下标获取指定元素

编写测试代码，打上断点：

进入get方法内部：

public E get(int index) {
		//检查下标范围
        checkElementIndex(index);
        //遍历一半，返回节点的值
        return node(index).item;
    }

LinkedList支持的查询除了通过下标获取外，还支持getLast和getFirst

get(0)和getFirst时间复杂度有区别吗？

理论上来说，getFirst和getLast都是直接获取到节点，时间复杂度为O（1），而通过get(index)方法查询节点，都会折半后遍历一半的元素，时间复杂度为O（n）。但实际情况下，for循环遍历的第一个元素就100%是头节点或尾节点，不会进入之后的循环，实际运行的也是O（1）。

2.4 Debug 分析如何通过下标删除元素

打上断点：

进入方法内部：

public E remove(int index) {
		//检查下标范围
        checkElementIndex(index);
        //node(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节点
            first = next;
        } else {
        //若删除的节点为中间节点，将当前节点的上一个节点的下一个节点指向变为当前节点的下一个节点（step1）
            prev.next = next;
            //当前节点的上一个节点指向置为null（step2）
            x.prev = null;
        }

        if (next == null) {
        //若删除的节点为尾节点，将当前节点的上一个节点赋给last
            last = prev;
        } else {
        //若删除的节点为中间节点，将当前节点的下一个节点的上一个节点指向变为当前节点的上一个节点（step3）
            next.prev = prev;
            //当前节点的下一个节点指向置为null（step4）
            x.next = null;
        }

		//节点元素内容置为空
        x.item = null;
        //链表长度-1
        size--;
        //链表修改次数+1
        modCount++;
        //返回删除节点内容
        return element;
    }

2.5 Debug 分析如何通过对象删除节点（内容）

public boolean remove(Object o) {
		//若节点为null，从first往下遍历（说明LinkedList是允许为空值的，并且允许多个）
        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;
    }