[Java]-LinkedList 源码分析

前言

源码中对 LinkedList 这个类给出了详细概述,大概意思为

是 List 接口跟 Deque 接口的双向链表实现,实现了所有可选的 list 操作,而且允许所有的类型存储,包括null
所有操作的执行都是在双向链表的结构上。通过索引进入 list 的操作会通过从链表头或者链表尾往另一端遍历来找到指定索引的位置然后进行操作,至于从头还是尾开始遍历,就要看指定的索引位置离头更近还是离尾更近
LinkedList 这个实现类并不是同步的,如果有多线程并发地访问了一个 LinkedList,且至少有一个线程修改了 list 的结构,那它就必须在外部进行同步 (添加或删除元素才属于对 list 结构的修改,不包括对某个元素的值进行修改)。这通常是通过在能自然封装 list 的某个对象上进行同步来实现的
如果没有这样的对象,那么 list 应该使用 Collections.synchronizedList 方法进行包装:
List list = Collections.synchronizedList(new LinkedList(…));
该类的迭代器 iterator 及 listIterator 是支持 fast-fail 机制的

在下面的具体方法分析中,可以看到有的方法实际上是在调用类中其它的方法,如 offer 方法实际上是在调用 add 方法,offerFirst 方法实际上是在调用 addFirst 方法,这是由于 LinkedList 既实现了 List<E> 接口,也实现了 Deque<E>,所以有一部分方法是重写 List 接口中的,一部分是重写 Deque 中的,而这两部分方法中,又有一些方法是相同作用的,所以就直接调用了

链表节点 Node

链表的每个节点的类型采用的是内部类 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;
    }
}

主要成员变量

transient int size = 0;
/**
 * Pointer to first node.
 * Invariant: (first == null && last == null) ||
 *            (first.prev == null && first.item != null)
 */
transient Node<E> first;
/**
 * Pointer to last node.
 * Invariant: (first == null && last == null) ||
 *            (last.next == null && last.item != null)
 */
transient Node<E> last;

size 表示当前 LinkedList 中存储的元素个数

first 以及 last 分别指向双向链表的头节点跟尾结点,而且存在这样的恒成立关系:要么 first 跟 last 都为 null,要么 first 节点有存值且前驱节点为 null,以及 last 节点有存值且其后续节点为 null,分别对应 LinkedList 为空表以及有存元素两种情况

构造函数

构造函数较为简单,即一个无参无其他行为的构造函数以及一个根据 Collection 集合来创建 LinkedList 的构造函数

public LinkedList() {
}

public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

私有的操作

LinkedList 设置了几个私有的修改链表结构的方法:linkFirst(),linkLast(),linkBefore(),unlinkFirst(),unlinkLast(),unlink()

其它对用户提供的操作方法都是直接或间接地调用这些操作,在这些操作中,要注意的是,由于是双向链表,每对一个元素进行增或删操作时,要注意 其与前驱节点以及后继节点的联系 (引用关系),特别是 操作前链表是不是空表,操作后链表会不会是空表

//在链表头新增一个元素
private void linkFirst(E e) {
    final Node<E> f = first;
    //新增的节点就会成为新的头节点
    final Node<E> newNode = new Node<>(null, e, f);
    first = newNode;
    //f为null说明原来是个空表,现在有了第一个节点,last也要指向它
    if (f == null)
        last = newNode;
    else
        f.prev = newNode;
    size++;
    modCount++;
}
//在链表尾新增一个元素
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++;
}
//在链表中指定节点的前面插入一个新元素,该节点必须存值链表中
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++;
}
//删除链表头节点,所传参数必须为链表的头节点
private E unlinkFirst(Node<E> f) {
    // assert f == first && f != null;
    final E element = f.item;
    final Node<E> next = f.next;
    //将相关的引用置为null才可以让GC进行内存回收
    f.item = null;
    f.next = null; // help GC
    first = next;
    if (next == null)
        last = null;
    else
        next.prev = null;
    size--;
    modCount++;
    return element;
}
//删除链表尾结点
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;
}
//删除链表中指定的节点,且指定的节点必须不为null
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;
}

添加元素

addFirst

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

在链表头部添加元素,直接调用 linkFirst 方法完成

addLast

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

在链表尾部添加元素,直接调用 linkLast 方法完成

add

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

add 方法是在在链表尾部添加元素,就是说它的 作用跟addLast是一样的
除此之外还有一个在指定索引位置添加元素的重载方法:

public void add(int index, E element) {
    checkPositionIndex(index);
    if (index == size)
        linkLast(element);
    else
        linkBefore(element, node(index));
}

要在指定索引对应的地方添加一个元素,首先要判断这个索引所在的位置是不是允许元素存放。由于当前链表中共有 size 个元素,那么索引就是 [0,size - 1],除此之外可以在链表尾添加一个元素,所以索引值等于size也是可以的,接下来进入 checkPositionIndex 方法看它的判断条件是不是这样:

private void checkPositionIndex(int index) {
   if (!isPositionIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

继续查看 isPositionIndex:

private boolean isPositionIndex(int index) {
    returnindex >= 0 && index <= size;
}

可以看到其判断条件与前面认为的一致。判断索引合法就回到 add 方法中,当 index 值等于 size 时,直接调用 linkLast 方法将元素添加到链表尾;否则调用 linkBefore 方法将元素添加到原来 index 对应的节点的前面

以下操作就是 Deque 接口中的操作

offer

public boolean offer(E e) {
   return add(e);
}

offer 方法实际上是在调用 add 方法,即在链表尾添加元素

offerFirst

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

offerFirst 方法实际上是调用 addFirst 方法,即在链表头添加元素

offerLast

public boolean offerLast(E e) {
    addLast(e);
    return true;
}

offerLast 实际上是调用 addLast 方法,即在链表尾添加元素,跟 offer() 效果一样

push

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

push方法实际上是调用 addFirst 方法,即在链表头添加元素

删除元素

removeFirst

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

删除链表中第一个元素,即删除链表中第一个节点

removeLast

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

删除链表中最后一个元素,即删除链表中最后一个节点

以下操作就是面向Deque设置的操作

remove

//从头结点向后遍历,删除第一个所存元素值为o的节点
public boolean remove(Object o) {
	//可能有节点所存元素值就为null
    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) {
        	//经过测试,像这里这样调用equals并不是根据Object类中定义的一样根据地址是否一样来判断
        	//而是根据o跟x.item是什么类型(即该LinkedList的泛型)来使用其类中自己重写的equals方法,如String类
        	//当然,如果泛型就是Object,那还是会按照Object类中定义的一样使用内存地址是否一样来做判断
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

除此之外还有一个删除指定索引位置节点的重载方法:

public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

poll

public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

删除链表头节点,同时返回其所存元素的值

pollFirst

public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

弹出第一个元素,跟poll一模一样

pollLast

public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

弹出最后一个元素

pop

public E pop() {
    return removeFirst();
}

pop 方法实际上是调用 removeFirst 方法,所以在头节点为 null 的时候会抛出异常,这也是跟 poll 方法的区别所在,如果头节点为 null,poll 方法会返回 null 而不会抛出异常

获取元素值

getFirst

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

获取链表中第一个元素的值,即头节点所存元素的值,若不存在头节点会抛出异常

getLast

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

获取链表中最一个元素的值,即尾节点所存元素的值,若不存在尾节点会抛出异常

get

get方法用于返回指定索引位置上链表节点的元素值

public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

查找前要先判断索引对当前链表来说是否合法,合法的条件应该是 0 <= index < size
借助 checkElementIndex 方法

private void checkElementIndex(int index) {
    if (!isElementIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

继续看isElementIndex方法

private boolean isElementIndex(int index) {
    return index >= 0 && index < size;
}

发现判断条件确实是0 <= index < size。如果索引合法,就调用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;
    }
}

在概述的时候说过,“通过索引进入list的操作会通过从链表头或者链表尾往另一端遍历来找到指定索引的位置然后进行操作,至于从头还是尾开始遍历,就要看指定的索引位置离头更近还是离尾更近”,所以根据index是否小于size的二分之一,判断index所对应的节点离头节点更近还是离尾结点更近。如果index小于size的二分之一,说明index所对应的节点离头节点更近,所以从头节点开始往尾结点遍历查找第index个节点
在头尾结点中选取更近的节点开始遍历是为了尽可能地减少查找节点所花费的时间,因为LinkedList是链表结构,只要是查找操作都避免不了要进行O(n)的遍历链表操作,既然避免不了,那就只能尽可能地减少

peek

public E peek() {
    finalNode<E> f = first;
    return (f == null) ? null : f.item;
}

返回链表头节点所存元素值,若头节点为 null 则返回 null。在 栈 中,我们通常使用 peek 是来获取栈顶元素,也就是说,使用 LinkedList 作为栈时,我们应该默认链表头为 栈顶,链表尾为 栈底;同理,作为队列时,默认链表头为 队头,链表尾为 队尾

总结

LinkedList 既可以在链表头进行增删,也可以在链表尾进行增删,所以可以使用它来作为 队列 或者 栈 进行使用

ArrayList 的增删一定比 LinkedList 慢吗

  1. 如果增删是在末尾进行操作,ArrayList 可能不需要移动和复制数组,这时增删的速度是会比 LinkedList 快的
  2. 如果增删是在列表中间进行,由于 LinkedList 的时间花费主要是在遍历上,而 ArrayList 的时间花费主要是在删除元素后移动和复制数组上 (即调用 native 方法 System.arraycopy)
    LinkedList 的遍历速度是要慢于 ArrayList 的复制速度的,如果数据量是百万级,还是 ArrayList 要快
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值