【Java容器源码】LinkedList 源码分析

﹏ヽ暗。殇╰゛Y 2022-12-05 10:16 360阅读 0赞

先来看 LinkedList 的结构,即继承关系,核心成员变量,主要构造函数:

  1. public class LinkedList<E>
  2. extends AbstractSequentialList<E>
  3. implements List<E>, Deque<E>, Cloneable, java.io.Serializable {
  4. // Node,双向链表
  5. private static class Node<E> {
  6. E item;// 节点值
  7. Node<E> next; // 指向的下一个节点
  8. Node<E> prev; // 指向的前一个节点
  9. // 初始化参数顺序分别是:前一个节点、本身节点值、后一个节点
  10. Node(Node<E> prev, E element, Node<E> next) {
  11. this.item = element;
  12. this.next = next;
  13. this.prev = prev;
  14. }
  15. }
  16. //------------------------成员变量-------------------------------------
  17. transient int size = 0;
  18. // 记录头结点,它的前一个结点=null
  19. transient Node<E> first;
  20. // 记录尾结点,它的后一个结点=null
  21. // 当 first = last = null时表示链表为空
  22. // 当 first = last != null时表示只有一个节点
  23. transient Node<E> last;
  24. //--------------------------构造方法-------------------------------------
  25. public LinkedList() {
  26. }
  27. public LinkedList(Collection<? extends E> c) {
  28. this();
  29. addAll(c);
  30. }
  31. // ........
  32. }

1.尾插

追加节点时,我们可以选择追加到链表头部,还是追加到链表尾部,add 方法默认是从尾部开始追加,addFirst 方法是从头部开始追加,我们分别来看下两种不同的追加方式:

add()

  1. public boolean add(E e) {
  2. linkLast(e);
  3. return true;
  4. }

linkLast()

尾插的核心逻辑如下:

  • newNode.pre = last
  • last.next = newNode (注:考虑last=null情况(链表为空,这时仅更新头结点即可))
  • last = newNode

    void linkLast(E e) {

    1. // 把尾节点数据暂存,为last.next做准备,其实改变一下顺序就可以不要这个l了
    2. final Node<E> l = last;
    3. final Node<E> newNode = new Node<>(l, e, null); // 1
    4. last = newNode; // 2
    5. // 空链表,l=null,l.next报空指针
    6. if (l == null)
    7. first = newNode;
    8. else
    9. l.next = newNode; // 3
    10. // size和版本更改
    11. size++;
    12. modCount++;
    13. }

注:跟 ArrayList 一样,LinkedList 也可以添加 value 为 null 的元素,并且是可以添加多个。

2.头插

要对LinkedList头插时是调用addFirst方法

addFirst()

  1. public void addFirst(E e) {
  2. linkFirst(e);
  3. }

linkFirst()

头插核心逻辑如下:

  • newNode.next = first;
  • first.prev = newNode; (注:考虑first=null(链表为空,只用更新last即可))
  • first = newNode;

    private void linkFirst(E e) {

    1. // 头节点赋值给临时变量
    2. final Node<E> f = first;
    3. final Node<E> newNode = new Node<>(null, e, f); // 1
    4. first = newNode; // 2
    5. // 链表为空,f=null, f.prev报空指针
    6. if (f == null)
    7. last = newNode;
    8. else
    9. f.prev = newNode; // 3
    10. // 更新size和版本号
    11. size++;
    12. modCount++;
    13. }

3.删除指定元素

节点删除的方式和追加类似,我们可以删除指定元素,或者从头部(尾部)删除,删除操作会把节点的值,前后指向节点都置为 null,帮助 GC 进行回收

remove()

删除指定元素;该方法在此处的作用是找到要删除的节点。注意,只有链表有这个节点且成功删除才返回true

  1. public boolean remove(Object o) {
  2. if (o == null) {
  3. for (Node<E> x = first; x != null; x = x.next) {
  4. // null用 == 判断
  5. if (x.item == null) {
  6. unlink(x);
  7. return true;
  8. }
  9. }
  10. } else {
  11. for (Node<E> x = first; x != null; x = x.next) {
  12. // 调用equals判断,若传入的类无equals需要重写
  13. if (o.equals(x.item)) {
  14. unlink(x);
  15. return true;
  16. }
  17. }
  18. }
  19. return false; // 链表无要删除元素,或链表为空
  20. }

注:remove还可以根据索引删除

  1. public E remove(int index) {
  2. checkElementIndex(index); // 链表为空,抛出异常
  3. return unlink(node(index)); // 查到index对应的Node并删除
  4. }

删除的核心逻辑如下:

  • x.prev.next = x.next (注:考虑x.prev=null(x是first,直接更新first))
  • x.next.prev = x.prev.prev (注:考虑x.next=null(x是last,直接更新last))

    E unlink(Node x) {

    1. // assert x != null;
    2. final E element = x.item;
    3. final Node<E> next = x.next;
    4. final Node<E> prev = x.prev;
    5. // 如果prev=null,则当前节点为头结点
    6. if (prev == null) {
    7. // 直接将头结点赋成next
    8. first = next;
    9. } else {
    10. prev.next = next; // 1
    11. x.prev = null; // 帮助 GC 回收该节点
    12. }
    13. // 如果next=null,则当前节点为尾结点
    14. if (next == null) {
    15. last = prev;
    16. } else {
    17. next.prev = prev; // 2
    18. x.next = null; // 帮助 GC 回收该节点
    19. }
    20. x.item = null; // 帮助 GC 回收该节点
    21. // 修改size及版本
    22. size--;
    23. modCount++;
    24. return element;
    25. }

4.删除头节点

remove()

删除头节点,队列为空时抛出异常。这里注意,与删除指定元素时需要传入一个参数,而删除头节点时为空参。

  1. public E remove() {
  2. return removeFirst();
  3. }

removeFirst()

判断当前链表时否为空

  1. public E removeFirst() {
  2. final Node<E> f = first;
  3. if (f == null)
  4. throw new NoSuchElementException();
  5. return unlinkFirst(f);
  6. }

unLinkFirst()

执行删除头节点,具体删除逻辑如下

  • first.next.pre = null;(注:考虑first=null(链表为空), first.next=null(尾结点,即链表仅一个节点))
  • first = first.next;

    private E unlinkFirst(Node f) {

  1. final E element = f.item; // 拿出头节点的值,作为方法的返回值
  2. final Node<E> next = f.next; // 拿出头节点的下一个节点
  3. //帮助 GC 回收头节点
  4. f.item = null;
  5. f.next = null;
  6. first = next; // 1
  7. // next为空表示链表只有一个节点
  8. if (next == null)
  9. last = null;
  10. else
  11. next.prev = null; // 2
  12. //修改链表大小和版本
  13. size--;
  14. modCount++;
  15. return element;
  16. }

从源码中我们可以了解到,链表结构的节点新增、删除都非常简单,仅仅把前后节点的指向修改下就好了,所以 LinkedList 新增和删除速度很快。

5.查询

链表查询某一个节点是比较慢的,需要挨个循环查找才行,我们看看 LinkedList 的源码是如何寻找节点的

get()

根据索引进行查找

  1. public E get(int index) {
  2. checkElementIndex(index);
  3. return node(index).item;
  4. }

node()

  1. Node<E> node(int index) {
  2. // 如果 index 处于队列的前半部分,从头开始找,size >> 1 是 size 除以 2 的意思。
  3. if (index < (size >> 1)) {
  4. // 取头节点
  5. Node<E> x = first;
  6. // 直到 for 循环到 index 的前一个 node 停止
  7. for (int i = 0; i < index; i++)
  8. x = x.next;
  9. return x;
  10. } else {
  11. // 如果 index 处于队列的后半部分,从尾开始找
  12. // 取尾结点
  13. Node<E> x = last;
  14. // 直到 for 循环到 index 的后一个 node 停止
  15. for (int i = size - 1; i > index; i--)
  16. x = x.prev;
  17. return x;
  18. }
  19. }

从源码中我们可以发现,LinkedList 并没有采用从头循环到尾的做法,而是采取了简单二分法,首先看看 index 是在链表的前半部分,还是后半部分。如果是前半部分,就从头开始寻找,反之亦然。通过这种方式,使循环的次数至少降低了一半,提高了查找的性能,这种思想值得我们借鉴

6.迭代器

因为 LinkedList 要实现双向的迭代访问,所以使用 Iterator 接口肯定不行了,因为 Iterator 只支持从头到尾的访问。Java 新增了一个迭代接口,叫做:ListIterator,这个接口提供了向前和向后的迭代方法,如下所示:


















迭代顺序 方法
从尾到头迭代方法 hasPrevious、previous、previousIndex
从头到尾迭代方法 hasNext、next、nextIndex

listIterator()

返回迭代器,可以传入index,表示从指定节点开始迭代,可前可后

  1. public ListIterator<E> listIterator(int index) {
  2. checkPositionIndex(index);
  3. return new ListItr(index);
  4. }
  5. /**
  6. *ListItr,双向迭代器
  7. */
  8. private class ListItr implements ListIterator<E> {
  9. private Node<E> lastReturned;// 上一次执行 next() 或者 previos() 方法时的节点位置
  10. private Node<E> next;// 下一个节点
  11. private int nextIndex;// 下一个节点的位置
  12. // expectedModCount:期望版本号;modCount:目前最新版本号
  13. private int expectedModCount = modCount;
  14. ListItr(int index) {
  15. // assert isPositionIndex(index);
  16. next = (index == size) ? null : node(index);
  17. nextIndex = index;
  18. }
  19. }

从前向后迭代

hasNext()

判断还有没有下一个元素,还是通过index和size控制

  1. public boolean hasNext() {
  2. return nextIndex < size;// 下一个节点的索引小于链表的大小,就有
  3. }

next()

取下一个元素,并后移

  1. public E next() {
  2. // 检查期望版本号有无发生变化
  3. checkForComodification();
  4. if (!hasNext())//再次检查
  5. throw new NoSuchElementException();
  6. // next 是当前节点,在上一次执行 next() 方法时被赋值的。
  7. // 第一次执行时,是在初始化迭代器的时候,next 被赋值的
  8. lastReturned = next;
  9. // next 是下一个节点了,为下次迭代做准备
  10. next = next.next;
  11. nextIndex++;
  12. return lastReturned.item;
  13. }

从后向前迭代

hasPrevious()

如果上次节点索引位置大于 0,就还有节点可以迭代

  1. public boolean hasPrevious() {
  2. return nextIndex > 0;
  3. }

previous()

  1. public E previous() {
  2. checkForComodification();
  3. if (!hasPrevious())
  4. throw new NoSuchElementException();
  5. // next 为空场景:1:说明是第一次迭代,取尾节点(last);2:上一次操作把尾节点删除掉了
  6. // next 不为空场景:说明已经发生过迭代了,直接取前一个节点即可(next.prev)
  7. lastReturned = next = (next == null) ? last : next.prev;
  8. // 索引位置变化
  9. nextIndex--;
  10. return lastReturned.item;
  11. }

删除:remove

迭代时,删除当前元素

  1. public void remove() {
  2. checkForComodification();
  3. // lastReturned 是本次迭代需要删除的值,分以下空和非空两种情况:
  4. // lastReturned 为空,说明调用者没有主动执行过 next() 或者 previos(),直接报错
  5. // lastReturned 不为空,是在上次执行 next() 或者 previos()方法时赋的值
  6. if (lastReturned == null)
  7. throw new IllegalStateException();
  8. Node<E> lastNext = lastReturned.next;
  9. // 删除 lastReturned 结点(刚遍历返回的结点)
  10. unlink(lastReturned);
  11. // next == lastReturned 的场景分析:从尾到头递归顺序,并且是第一次迭代,并且要删除最后一个元素的情况
  12. // 这种情况下,previous()方法里面设置了 lastReturned=next=last,所以 next 和 lastReturned 会相等
  13. if (next == lastReturned)
  14. // 这时候 lastReturned 是尾节点,lastNext 是 null,所以 next 也是 null,
  15. // 这样在 previous() 执行时,发现 next 是 null,就会把尾节点赋值给 next
  16. next = lastNext;
  17. else
  18. nextIndex--;
  19. lastReturned = null;
  20. expectedModCount++;
  21. }

7.Queue的实现

LinkedList 实现了 Queue 接口,在新增、删除、查询等方面增加了很多新的方法,这些方法在平时特别容易混淆,在链表为空的情况下,返回值也不太一样,下面列一个表格,方便大家记录:






























返回异常 返回特殊值 底层实现
新增 add() offer() 底层实现相同,offer直接调用add
删除 remove() poll() 链表为空时,remove 会抛出异常,poll 返回 null
查找 element() peek() 链表为空时,element 会抛出异常,peek 返回 null

PS:Queue 接口注释建议 add 方法操作失败时抛出异常,但 LinkedList 实现的 add 方法一直返回 true。

LinkedList 也实现了 Deque 接口,对新增、删除和查找都提供从头开始,还是从尾开始两种方向的方法,比如 remove 方法,Deque 提供了 removeFirst 和 removeLast 两种方向的使用方式,但当链表为空时的表现都和 remove 方法一样,都会抛出异常。

发表评论

表情:
评论列表 (有 0 条评论,360人围观)

还没有评论,来说两句吧...

相关阅读