LinkedList源码分析

今天就来看下LinkedList的源码，先看下LinkedList的继承体系结构。

public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, java.io.Serializable

LinkedList实现了List、Deque接口。从这我们就可以联想到，ArrayList类底层是借助于数组来实现，LinkedList由于实现了Deque接口，则LinkedList类也具有双端队列的特性。

本篇博文的结构依然是从类的属性、构造函数开始介绍，接着介绍几个我们常用的一些函数的内部实现。

Node类

下面就是Node类的定义。
从源码可以看到，Node类只定义了存储的元素、前一个元素的指向、后一个元素的指向，这就是双向链表的节点的定义，每个节点只知道自己的前一个节点和后一个节点。

还有一个有参的构造函数，从参数中可以看出，创建一个新的Node对象时要提供新Node对象的前指针、本节点的value和后指针。虽然JAVA中没有指针，但这里称为指针便于理解。如果你不习惯指针这一说话，可以理解为此节点的前一个元素的指向和后一个元素的指向。

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

属性

LinkedList类中有三个属性，

1、LinkedList对象实例的大小

transient int size = 0;

2、头指针：指向LinkedList中的第一个元素

transient Node<E> first;

3、尾指针：指向LinkedList中的最后一个元素

transient Node<E> last;

既然上面的两个属性都是Node引用，也就是说，LinkedList类的实现就是依赖与Node节点来实现，因此有必要对此类进行一定的了解。

构造函数

ListedList共有两个构造函数，一个无参构造函数，一个有参构造函数。
下面将分别给予介绍。

1、无参构造函数

无参构造函数，即构造一个空链表。

public LinkedList() {
    }

2、有参构造函数

源码如下：

public LinkedList(Collection<? extends E> c) {
this();//调用无参构造方法构造一个空的链表
        addAll(c);
    }

有参构造函数，参数是一个Collection，此函数首先调用无参构造函数构造了一个空对象，然后调用了addAll(c)方法，既然它在构造函数中出现了，下面就先介绍这个方法。

addAll(Collection

public boolean addAll(Collection<? extends E> c) {
return addAll(size, c);
}

这个函数就是直接调用了addAll(int index, Collection

public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index);//索引有效性检查，即检查index>=0&&index<=size

        Object[] a = c.toArray();
int numNew = a.length;
if (numNew == 0)
return false;

        Node<E> pred, succ;
/*
 pred：用于表示即在此节点位置的后面插入新的节点
 succ：用于表示在此节点的前面位置插入节点，即插入之前此时此刻链表中的index位置的节点
 如果index==size，则在尾结点处插入
 否则：找到索引为index（从零开始）的位置节点
 */
if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index);
            pred = succ.prev;
        }
//将所有元素加入在pre指向之后
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
                pred.next = newNode;
            pred = newNode;
        }
/*
 在尾结点加入时，pred所指向的就是last的位置，
 否则，则将pred与succ的指向要进行连接起来。
 */
if (succ == null) {
            last = pred;
        } else {
            pred.next = succ;
            succ.prev = pred;
        }

        size += numNew;//更改链表大小
        modCount++;//增加修改次数
return true;
    }

函数的功能：将指定 collection 中的所有元素从指定位置开始插入此列表。

源码的实现也比较清晰，分成两步：第一步在链表中找到index的位置的节点，第二步就是将collection中的所有元素一个一个按顺序加入即可。源码中对index的两种情况进行了处理：一种是index==size，另一种是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;
        }
    }

此函数的功能：返回LinkedList对象中指定位置index处的非空结点。源码的实现比较简单，就是将index与链表的中心点的位置进行比较，然后从离得近的一段来进行搜索，得到我们想到的位置的节点。这样的好处相比我们从头搜索到尾可以更快的得到，这样方便提高性能。

add

上面分析了带有Collection参数的addAll(Collection

add(E e)

此函数的功能：添加指定的元素在LinkedList的末尾。

下面看下源码是如何来实现的。

public boolean add(E e) {
        linkLast(e);
return true;
    }

源码比较简单，它直接借用了linkLast(Element e)来实现，下面我们来看下linkLast的源码。

/**
 * Links e as last element.
 */
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++;
    }

从源码中可以看到，它直接将节点链接再last节点之后，并处理了last节点可能为空的情况。如果为空，则说明此LinkedList对象中没有元素，即first也应该是指向这个新节点newNode;

既然上面有linkLast，LinkedList中也有linkFirst(E e),源码如下：

/**
 * Links e as first element.
 */
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++;
    }

此函数实现的原理和linkLast一致且比较简单，不再分析。

addFirst/addLast 方法

LinkedList还提供了addFirst和addLast方法。如下：

public void addFirst(E e) {
        linkFirst(e);
    }

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

从源码可以看出，addFirst(E e)函数是借助于linkFirst来实现的，而addLast(E e)是借助于linkLast来实现的。

上面介绍了为LinkedList对象增加元素，除了增加元素所涉及的方法比较常用之外，从LinkedList中获取元素也相当常用。下面来进行介绍。

add(int index, E element)

上面介绍的添加元素基本上是在LinkedList的fast或last来进行添加，而add(int index, E element)这个函数就是在指定的位置添加元素。这个和add(int index,Collection

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

if (index == size)
            linkLast(element);
else
            linkBefore(element, node(index));
    }

从源码中可以看出，当索引index==size时，则直接调用前面介绍过的linkLast来进行，其它的情况调用linkBefore来实现，下面我们就来看下这个函数的代码。

/**
 * Inserts element e before non-null Node succ.
 */
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++;
    }

详细看了前面的分析，分析这个函数的代码应该没有什么问题了。

get:获取LinkedList的方法

从LinkedList对象中获取元素的方法有3种，分别为getFirst()和getLast()以及get(int index),下面将分别给予介绍。

getFirst()/getLast()

源码如下：

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

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

源码比较简单，直接返回first属性或last属性所指向的节点的值即可。

get(int index)

源码如下：

public E get(int index) {
        checkElementIndex(index);//位置有效性检查
return node(index).item;//直接调用node(int index)找到索引为index的节点。
    }

set:改变LinkedList某个位置的值

上面介绍了get(int index)的代码之后，set与之类似。从源码中可以看出，也是借助于node(int index)来找到LinkedList对象在索引index的节点，然后改变节点的值即可。

public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
return oldVal;
    }

remove:移除LinkedList中的元素

在LinkedList类中提供了两种remove方法。分别为removeFirst()和removeLast().

removeFirst()

源码如下：

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

源码中直接借助于unlinkFirst(Node f)来实现，unlinkFrist函数的代码如下：

unlinkFrists是在Node f一定非空的前提下进行的，没有进行有效性检查。这是因为removeFirst已经可以Node f 一定非空。所以这是可以的。

下面实现的代码和我们在实际编程中，对链表的操作去掉某个节点类似，就是一个前后指针的指向要发生变化。

/**
 * Unlinks non-null first node 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
        first = next;
/*
 下面对next是否为空进行分支处理;
 如果为空，说明链表为空，即应该使得last=null;
 如果不为空，则将next的pre指向null。
 */
if (next == null) 
            last = null;
else
            next.prev = null;
        size--;
        modCount++;
return element;
    }

removeLast()

源码如下：

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

/**
 * Unlinks non-null last node 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;
    }

实现与上面介绍的removeFist类似，也比较简单，不再介绍。

remove(int index)

public E remove(int index) {
        checkElementIndex(index);//有效性检查，保证unlink(node(index))一定是一个有效的节点
return unlink(node(index));
    }

上面这个函数首先通过有效性检查，保证unlink(node(index))一定是一个有效的节点，然后调用unlink来进行处理。unlink函数的代码如下，比较简单，不再分析。

/**
 * Unlinks non-null node 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;
//对此节点的pre是否为null进行讨论，分别进行处理。
if (prev == null) {
            first = next;
        } else {
            prev.next = next;
            x.prev = null;
        }
//对此节点的next是否为null进行讨论，分别进行处理。
if (next == null) {
            last = prev;
        } else {
            next.prev = prev;
            x.next = null;
        }

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

我们常用的add、get函数基本就介绍完了，其它的一些函数也不太难，就不再分析了。

小结

关于LinkedList类的代码实现，首先我们要知道的值LinkedList就是一个双向链表。有前后两个指针来遍历整个双向链表。关于add、set、get函数的内部实现和我们在学习算法的时候写关于删除链表节点以及添加链表节点的思想类似，因此看这个的源码会感觉思路相当的清晰、简单。

秒客网

《JAVA源码分析》：LinkedList

LinkedList源码分析

Node类

属性

构造函数

1、无参构造函数

2、有参构造函数

addAll(Collection

add

add(E e)

addFirst/addLast 方法

add(int index, E element)

get:获取LinkedList的方法

getFirst()/getLast()

get(int index)

set:改变LinkedList某个位置的值

remove:移除LinkedList中的元素

removeFirst()

removeLast()

remove(int index)

小结

相关文章