java基础:LinkedList — 源码分析

644 阅读7分钟

其他更多java基础文章:
java基础学习(目录)


概述

LinkedList是一个实现了List接口和Deque接口的双端链表,底层是双向链表,它也可以被当作堆栈、队列或双端队列进行操作。
有关索引的操作可能从链表头开始遍历到链表尾部,也可能从尾部遍历到链表头部,这取决于看索引更靠近哪一端。

  • LinkedList 实现 List 接口,能对它进行队列操作。
  • LinkedList 实现 Deque 接口,即能将LinkedList当作双端队列使用。
  • LinkedList 实现了Cloneable接口,即覆盖了函数clone(),能克隆。
  • LinkedList 实现java.io.Serializable接口,这意味着LinkedList支持序列化,能通过序列化去传输。
  • LinkedList不是线程安全的。

数据结构和基础字段

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

内部类Node就是实际的结点,用于存放实际的元素。LinkedList通过Node类和first、last两个特定意义的Node属性字段,来构建双向链表的底层结构。

从上图可以看出,LinkedList内部是一个双端链表结构,有两个变量,first指向链表头部,last指向链表尾部。 LinkedtList内部的成员变量如下:

transient Node<E> first;
transient Node<E> last;
//LinkedList的长度
transient int size = 0;

方法细节

add方法

add(E e)

add(E e)用于将元素添加到链表尾部,实现如下:

    public boolean add(E e) {
        linkLast(e);
        return true;
    }
    
    void linkLast(E e) {
        final Node<E> l = last; //保存原链表尾部节点
        final Node<E> newNode = new Node<>(l, e, null); //以原链表尾部节点为prev节点创建一个新节点
        last = newNode; //将链表尾部指向新节点
        if (l == null) //如果链表为空,那么该节点既是头节点也是尾节点
            first = newNode;
        else //链表不为空,那么将该结点作为原链表尾部的后继节点
            l.next = newNode;
        size++;
        modCount++;
    }

从上面代码可以看到,linkLast方法中就是一个链表尾部添加一个双端节点的操作,但是需要注意对链表为空时头节点的处理。

add(int index,E e)

add(int index,E e)用于在指定位置添加元素。实现如下:

    public void add(int index, E element) {
        checkPositionIndex(index);

        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }
    
    Node<E> node(int index) {
        // assert isElementIndex(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;
        }
    }
    
    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++;
    }

从上面代码可以看到,add(int index, E element)方法主要分为3步:

  1. 检查index的范围,否则抛出异常
  2. 如果插入位置是链表尾部,那么调用linkLast方法
  3. 如果插入位置是链表中间,那么调用linkBefore方法

node(int index)方法就比较简单,根据index是靠近头部还是尾部选择不同的遍历方向。

linkBefore(E e, Node succ)方法表示在succ节点前插入一个值为e的新节点,步骤如下:

  1. 将succ节点的前驱节点保存为pred
  2. 创建newNode节点,将newNode的后继指针指向succ,前驱指针指向pred
  3. 将succ的前驱指针指向newNode
  4. 根据pred是否为null,进行不同操作。
  • 如果pred为null,说明该节点插入在头节点之前,要重置first头节点
  • 如果pred不为null,那么直接将pred的后继指针指向newNode即可

addAll方法

    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }
    
    //将集合从指定位置开始插入
    public boolean addAll(int index, Collection<? extends E> c) {
        //Step 1:检查index范围
        checkPositionIndex(index);

        //Step 2:得到集合的数据
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

        //Step 3:得到插入位置的前驱节点和后继节点
        Node<E> pred, succ;
        //如果插入位置为尾部,前驱节点为last,后继节点为null
        if (index == size) {
            succ = null;
            pred = last;
        }
        //否则,调用node()方法得到后继节点,再得到前驱节点
        else {
            succ = node(index);
            pred = succ.prev;
        }

        //Step 4:遍历数据将数据插入
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            //创建新节点
            Node<E> newNode = new Node<>(pred, e, null);
            //如果插入位置在链表头部
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }

        //如果插入位置在尾部,重置last节点
        if (succ == null) {
            last = pred;
        }
        //否则,将插入的链表与先前链表连接起来
        else {
            pred.next = succ;
            succ.prev = pred;
        }

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

从上面的代码可以看到,addAll方法主要分为4步:

  1. 检查index索引范围
  2. 得到集合数据
  3. 得到插入位置的前驱和后继节点
  4. 遍历数据,将数据插入到指定位置

remove方法

    //删:remove目标节点
    public E remove(int index) {
        checkElementIndex(index);//检查是否越界 下标[0,size)
        return unlink(node(index));//从链表上删除某节点
    }

    //因为要考虑 null元素,也是分情况遍历
    public boolean remove(Object o) {
        if (o == null) {//如果要删除的是null节点(从remove和add 里 可以看出,允许元素为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;
    }
    
    //将节点x,从链表中删除,返回删除节点的值
    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) {//前置节点为null,
            first = next;//则首节点为next
        } else {//否则 更新前置节点的后置节点
            prev.next = next;
            x.prev = null;//记得将要删除节点的前置节点置null
        }
        //如果后置节点为null,说明是尾节点
        if (next == null) {
            last = prev;
        } else {//否则更新 后置节点的前置节点
            next.prev = prev;
            x.next = null;//记得删除节点的后置节点为null
        }
        //将删除节点的元素值置null,以便GC
        x.item = null;
        size--;//修改size
        modCount++;//修改modCount
        return element;//返回删除的元素值
    }

上面unlink方法的代码可以简单分为以下几个步骤:
第一步:得到待删除节点的前驱节点和后继节点
第二步:更新前驱节点和删除节点的prev
第三步:更新后继节点和删除节点的next
第四步:将删除节点的元素值置null,以便GC,修改size值
经过四步,待删除的结点就从链表中脱离了。需要注意的是删除位置是头节点或尾节点时候的处理。

Deque接口的方法

Deque 是 Double ended queue (双端队列) 的缩写,读音和 deck 一样,蛋壳。
Deque接口其具体方法的处理逻辑如下所示:

头部访问 尾部访问
操作 抛出异常 返回特殊值 抛出异常 返回特殊值
插入操作 addFirst(e) offerFirst(e) addLast(e) offerLast(e)
删除操作 removeFirst() pollFirst() removeLast() pollLast()
访问操作 getFirst() peekFirst() getLast() peekLast()

在LinkedList中,返回的特殊值为null或true。举两个简单的例子分析下:

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

很简单,当first为null时,getFirst()抛出异常,peekFirst()返回特殊值null。

    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }
    
    public void addFirst(E e) {
        linkFirst(e);
    }

offerFirst方法返回true,addFirst方法无返回。

Deque 接口能够当做队列(先进先出)、栈(后进先出)使用,具体就不在这阐述,可以看java.util.Deque学习笔记

总结

  • LinkedList 是双向列表,能存储null值
  • 链表批量增加,是靠for循环遍历原数组,依次执行插入节点操作。对比ArrayList是通过System.arraycopy完成批量增加的。增加一定会修改modCount。
  • 通过下标获取某个node 的时候,会根据index处于前半段还是后半段 进行一个折半,以提升查询效率
  • 删也一定会修改modCount。 按下标删,也是先根据index找到Node,然后去链表上unlink掉这个Node。 按元素删,会先去遍历链表寻找是否有该Node,如果有,去链表上unlink掉这个Node。
  • 改也是先根据index找到Node,然后替换值。改不修改modCount。
  • 查本身就是根据index找到Node。
  • LinkedList不光能够向前迭代,还能像后迭代,不光能当链表,还能当队列、栈使用