JAVA容器系列一：LinkedList源码解读

香气袭人知骤暖

已于 2022-02-07 19:13:30 修改

阅读量385

点赞数

分类专栏： java类库文章标签： java 容器链表

于 2019-04-04 11:21:26 首次发布

本文链接：https://blog.csdn.net/qq_34748010/article/details/89017023

版权

java类库专栏收录该内容

10 篇文章 1 订阅

订阅专栏

LinkedList是一个实现了List接口和Deque接口的双端链表。
有关索引的操作可能从链表头开始遍历到链表尾部，也可能从尾部遍历到链表头部，这取决于看索引更靠近哪一端。
LinkedList不是线程安全的，如果想使LinkedList变成线程安全的，可以使用如下方式：

List list=Collections.synchronizedList(new LinkedList(...));

LinkedList的继承关系如下图所示：
在这里插入图片描述
从上图可以看出LinkedList与ArrayList的不同之处，ArrayList直接继承自AbstractList，而LinkedList继承自AbstractSequentialList，然后再继承自AbstractList。另外，LinkedList还实现了Dequeu接口，双端队列。

LinkedList的API

boolean add(E e) 
     将指定元素添加到此列表的结尾。
 void   add(int index, E element) 
     在此列表中指定的位置插入指定的元素。
 boolean    addAll(Collection<? extends E> c) 
     添加指定 collection 中的所有元素到此列表的结尾，顺序是指定 collection 的迭代器返回这些元素的顺序。
 boolean    addAll(int index, Collection<? extends E> c) 
      将指定 collection 中的所有元素从指定位置开始插入此列表。
 void   addFirst(E e) 
      将指定元素插入此列表的开头。
 void   addLast(E e) 
     将指定元素添加到此列表的结尾。
 void   clear() 
    从此列表中移除所有元素。
 Object clone() 
     返回此 LinkedList 的浅表副本。
 boolean    contains(Object o) 
     如果此列表包含指定元素，则返回 true。
 Iterator<E>    descendingIterator() 
     返回以逆向顺序在此双端队列的元素上进行迭代的迭代器。
 E  element() 
    获取但不移除此列表的头（第一个元素）。
 E  get(int index) 
   返回此列表中指定位置处的元素。
 E  getFirst() 
    返回此列表的第一个元素。
 E  getLast() 
    返回此列表的最后一个元素。
 int    indexOf(Object o) 
    返回此列表中首次出现的指定元素的索引，如果此列表中不包含该元素，则返回 -1。
 int    lastIndexOf(Object o) 
    返回此列表中最后出现的指定元素的索引，如果此列表中不包含该元素，则返回 -1。
 ListIterator<E>    listIterator(int index) 
   返回此列表中的元素的列表迭代器（按适当顺序），从列表中指定位置开始。
 boolean    offer(E e) 
    将指定元素添加到此列表的末尾（最后一个元素）。
 boolean    offerFirst(E e) 
    在此列表的开头插入指定的元素。
 boolean    offerLast(E e) 
    在此列表末尾插入指定的元素。
 E  peek() 
    获取但不移除此列表的头（第一个元素）。
 E  peekFirst() 
    获取但不移除此列表的第一个元素；如果此列表为空，则返回 null。
 E  peekLast() 
   获取但不移除此列表的最后一个元素；如果此列表为空，则返回 null。
 E  poll() 
    获取并移除此列表的头（第一个元素）
 E  pollFirst() 
     获取并移除此列表的第一个元素；如果此列表为空，则返回 null。
 E  pollLast() 
     获取并移除此列表的最后一个元素；如果此列表为空，则返回 null。
 E  pop() 
    从此列表所表示的堆栈处弹出一个元素。
 void   push(E e) 
    将元素推入此列表所表示的堆栈。
 E  remove() 
    获取并移除此列表的头（第一个元素）。
 E  remove(int index) 
   移除此列表中指定位置处的元素。
 boolean    remove(Object o) 
     从此列表中移除首次出现的指定元素（如果存在）。
 E  removeFirst() 
    移除并返回此列表的第一个元素。
 boolean    removeFirstOccurrence(Object o) 
     从此列表中移除第一次出现的指定元素（从头部到尾部遍历列表时）。
 E  removeLast() 
    移除并返回此列表的最后一个元素。
 boolean    removeLastOccurrence(Object o) 
     从此列表中移除最后一次出现的指定元素（从头部到尾部遍历列表时）。
 E  set(int index, E element) 
    将此列表中指定位置的元素替换为指定的元素。
 int    size() 
    返回此列表的元素数。
 Object[]   toArray() 
    返回以适当顺序（从第一个元素到最后一个元素）包含此列表中所有元素的数组。
<T> T[] toArray(T[] a) 
     返回以适当顺序（从第一个元素到最后一个元素）包含此列表中所有元素的数组；返回数组的运行时类型为指定数组的类型。

内部结构

LinkedList内部是一个双端链表结构，有两个变量，first指向链表头部，last指向链表尾部。
LinkedtList内部的成员变量如下：

transient int size = 0;//链表中Node个数  index == size时为链表尾；

transient Node<E> first;//链表头

transient Node<E> last;//链表尾

其中size表示当前链表中的数据个数。下面是Node节点的定义，Node类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;
        }
    }

从Node的定义可以看出链表是一个双端链表的结构。
构造方法
LinkedList有两个构造方法，一个用于构造一个空的链表，一个用已有的集合创建链表。如下：

  public LinkedList() {
        }
    
        public LinkedList(Collection<? extends E> c) {
            this();
            addAll(c);//添加集合中所有元素
        }

当使用第二个构造方法时，会调用addAll()方法将集合中的元素添加到链表中，添加的操作后面会详细介绍。

添加操作

因为LinkedList即实现了List接口，又实现了Deque接口，所以LinkedList既可以添加将元素添加到尾部，也可以将元素添加到指定索引位置，还可以添加添加整个集合；另外既可以在头部添加，又可以在尾部添加。下面我们分别从List接口和Deque接口分别介绍。（在（index）节点之前加入）

List接口的添加操作
add(E e)
add(E e)用于将元素添加到链表尾部（后驱结点为NULL），实现如下:

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);//以尾部为前驱节点创建一个新节点
        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); //检查索引是否处于[0-size]之间

        if (index == size)//添加在链表尾部
            linkLast(element);
        else//添加在链表中间
            linkBefore(element, node(index));
    }

从上面代码可以看到，主要分为3步：

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

linkLast方法前面已经讨论了，下面看一下linkBefore的实现。在看linkBefore之前，先看一下node(int 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;
        }
    }

从上面可以看到，node(int index)方法将根据index是靠近头部还是尾部选择不同的遍历方向。一旦得到了指定索引位置的节点，再看linkBefore()方法，实现如下：

void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        //linkBefore(element, node(index))
        
        final Node<E> pred = succ.prev;
        final Node<E> newNode = new Node<>(pred, e, succ); //+2
        succ.prev = newNode; //+1
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode; //+1
        size++;
        modCount++;

linkBefore()方法在第二个参数节点之前插入一个新节点。

addAll方法

addAll有两个重载方法，一个参数的方法表示将集合元素添加到链表尾部，而两个参数的方法指定了开始插入的位置。实现如下：

public boolean addAll(Collection<? extends E> c) {
//将集合插入到链表尾部，即开始索引位置为size
        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;
            //创建新节点，与前驱节点连接（1）
            Node<E> newNode = new Node<>(pred, e, null);//+1
            //如果插入位置在链表头部
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;//+1
            pred = newNode;//把新插入节点当做前驱节点，和后面链表连接（2）
        }

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

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

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

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

Deque接口的添加操作

addFirst(E e)方法
addFirst()方法用于将元素添加到链表头部，其实现如下:

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;
        //如果链表为空，last节点也指向该节点
        if (f == null)
            last = newNode;
        //否则，将头节点的前驱指针指向新节点
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

从上面的代码看到，实现就是在头节点插入一个节点使新节点成为新节点，但是和linkLast一样需要注意当链表为空时，对last节点的设置。

addLast(E e)方法
addLast()方法用于将元素添加到链表尾部，与add()方法一样。所以实现也一样，如下：

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

检索操作

获取任意位置的get(int index)方法
get(int index)方法根据指定索引返回数据，如果索引越界，那么会抛出异常。实现如下：

public E get(int index) {
        //检查边界
        checkElementIndex(index);
        return node(index).item;
    }

根据对象得到索引
根据对象得到索引分为两种，一种是第一个匹配的索引，一个是最后一个匹配的索引，实现的在于一个从前往后遍历，一个从后往前遍历。下面先看idnexOf()方法的实现：

//返回第一个匹配的索引
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;
    }

从上面的代码可以看到，LinkedList可以包含null元素，遍历方式都是从前往后，一旦匹配了，就返回索引。

删除操作

删除操作分为按照位置删除和按照对象删除，其中按照位置删除的方法又有区别，有的只是返回是否删除成功的标志，有的还需要返回被删除的元素。下面分别讨论。

删除指定对象
当删除指定对象时，只需调用remove(Object o)即可，不过该方法一次只会删除一个匹配的对象，如果删除了匹配对象，返回true，否则false。其实现如下：

public boolean remove(Object o) {
        //如果删除对象为null
        if (o == null) {
            //从前向后遍历
            for (Node<E> x = first; x != null; x = x.next) {
                //一旦匹配，调用unlink()方法和返回true
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            //从前向后遍历
            for (Node<E> x = first; x != null; x = x.next) {
                //一旦匹配，调用unlink()方法和返回true
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

从代码可以看到，由于LinkedList可以存储null元素，所以对删除对象以是否为null做区分。然后从链表头开始遍历，一旦匹配，就会调用unlink()方法将该节点从链表中移除。下面是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;
    }

按照位置删除对象

删除任意位置的对象
boolean remove(int index)方法用于删除任意位置的元素，如果删除成功将返回true，否则返回false。实现如下：

public E remove(int index) {
        //检查index范围
        checkElementIndex(index);
        //将节点删除
        return unlink(node(index));
    }

从上面可以看到remove(int index)操作有两步：

检查index范围，属于[0,size）
将索引出节点删除

香气袭人知骤暖

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
JAVA容器系列一：LinkedList源码解读

LinkedList是一个实现了List接口和Deque接口的双端链表。有关索引的操作可能从链表头开始遍历到链表尾部，也可能从尾部遍历到链表头部，这取决于看索引更靠近哪一端。LinkedList不是线程安全的，如果想使LinkedList变成线程安全的，可以使用如下方式：List list=Collections.synchronizedList(new LinkedList(...));...
复制链接

扫一扫