• LinkedList源码分析


    一、概述

    LinkedList是 Java 集合框架中一个重要的实现,其底层采用的双向链表结构。和 ArrayList 一样,LinkedList 也支持空值和重复值。由于 LinkedList 基于链表实现,存储元素过程中,无需像 ArrayList 那样进行扩容。

    但有得必有失,一方面,LinkedList 存储元素的节点需要额外的空间存储前驱和后继的引用。另一方面,LinkedList 在链表头部和尾部插入效率比较高,但在指定位置进行插入时,效率一般。原因是,在指定位置插入需要定位到该位置处的节点,此操作的时间复杂度为O(N)

    最后,LinkedList 是非线程安全集合类,并发环境下,多个线程同时操作 LinkedList,会引发不可预知的错误。

    二、继承体系

    LinkedList 的继承体系较为复杂,继承自 AbstractSequentialList,同时又实现了 List 和 Deque 接口 

    LinkedList 继承自 AbstractSequentialList,AbstractSequentialList 又是什么呢?从实现上,AbstractSequentialList 提供了一套基于顺序访问的接口。通过继承此类,子类仅需实现部分代码即可拥有完整的一套访问某种序列表(比如链表)的接口。深入源码,AbstractSequentialList 提供的方法基本上都是通过 ListIterator 实现的,比如: 

    1. public abstract class AbstractSequentialList extends AbstractList {
    2. public E get(int index) {
    3. try {
    4. return listIterator(index).next();
    5. } catch (NoSuchElementException exc) {
    6. throw new IndexOutOfBoundsException("Index: "+index);
    7. }
    8. }
    9. public void add(int index, E element) {
    10. try {
    11. listIterator(index).add(element);
    12. } catch (NoSuchElementException exc) {
    13. throw new IndexOutOfBoundsException("Index: "+index);
    14. }
    15. }
    16. //留给子类实现
    17. public abstract ListIterator listIterator(int index);
    18. }

    所以只要继承类实现了 listIterator 方法,它不需要再额外实现什么即可使用。对于随机访问集合类一般建议继承 AbstractList 而不是 AbstractSequentialList。LinkedList 和其父类一样,也是基于顺序访问。所以 LinkedList 继承了 AbstractSequentialList,但 LinkedList 并没有直接使用父类的方法,而是重新实现了一套的方法。

    另外,LinkedList 还实现了 Deque (double ended queue),Deque 又继承自 Queue 接口。这样 LinkedList 就具备了队列的功能。比如,我们可以这样使用:

    Queue queue = new LinkedList<>();

    除此之外,我们基于 LinkedList 还可以实现一些其他的数据结构,比如栈,以此来替换 Java 集合框架中的 Stack 类。

    三、源码分析

    1、成员属性

    1. // 元素个数
    2. transient int size = 0;
    3. // 链表头节点
    4. transient Node first;
    5. // 链表尾节点
    6. transient Node last;

    2、Node节点 

    1. private static class Node {
    2. //数据域,实际存放的元素,节点的值
    3. E item;
    4. //后继,储存下一个节点的引用
    5. Node next;
    6. //前驱,储存上一个节点的引用
    7. Node prev;
    8. //构造函数
    9. Node(Node prev, E element, Node next) {
    10. this.item = element;
    11. this.next = next;
    12. this.prev = prev;
    13. }
    14. }

    3、构造器

    构造一个空列表,里面没有任何实现,只是进行了初始化操作。

    1. public LinkedList() {
    2. }

    构造一个包含指定 collection 中的元素的列表,这些元素按其 collection 的迭代器返回的顺序排列。 

    1. public LinkedList(Collection c) {
    2. this();
    3. addAll(c);
    4. }

    4、增加元素

    1)增加头节点

    1. public void addFirst(E e) {
    2. //内部调用linkFirst方法
    3. linkFirst(e);
    4. }
    5. private void linkFirst(E e) {
    6. //创建一个节点引用l,指向原头节点
    7. final Node f = first;
    8. //创建新节点,前驱为null,后继为当前头节点
    9. final Node newNode = new Node<>(null, e, f);
    10. //新的要插入的节点作为新的头节点
    11. first = newNode;
    12. //判断原头节点是否为null,即原集合有没有节点数据
    13. if (f == null)
    14. //判断原头节点是否为null,即原集合有没有节点数据
    15. last = newNode;
    16. else
    17. //如果原头节点不为null,即原集合有节点数据,那么将原来头节点的prev引用指向新的头节点
    18. f.prev = newNode;
    19. //节点数自增1
    20. size++;
    21. //结构改变的次数自增1
    22. modCount++;
    23. }

    其他添加到尾部的方法,原理都是一样的:

    1. public boolean offerFirst(E e) {
    2. addFirst(e);
    3. return true;
    4. }
    5. public void push(E e) {
    6. addFirst(e);
    7. }

    2)增加尾节点

    1. public boolean add(E e) {
    2. //内部调用linkLast方法
    3. linkLast(e);
    4. return true;
    5. }
    6. //将元素链接到链表尾部
    7. void linkLast(E e) {
    8. //创建一个节点引用l,指向原尾节点
    9. final Node l = last;
    10. //创建新节点,前驱为当前尾节点,后继为null
    11. final Node newNode = new Node<>(l, e, null);
    12. //新的要插入的节点作为新的尾节点
    13. last = newNode;
    14. //判断原尾节点是否为null,即原集合有没有节点数据
    15. if (l == null)
    16. //如果原尾节点为null,即原集合没有节点数据,那么将新节点同时也作为首节点
    17. first = newNode;
    18. else
    19. //如果原尾节点不为null,即原集合有节点数据,那么将原来尾节点的next引用指向新的尾节点
    20. l.next = newNode;
    21. //节点数自增1
    22. size++;
    23. //结构改变的次数自增1
    24. modCount++;
    25. }

    其他添加到尾部的方法,原理都是一样的:

    1. public void addLast(E e) {
    2. linkLast(e);
    3. }
    4. public boolean offer(E e) {
    5. return add(e);
    6. }
    7. public boolean offerLast(E e) {
    8. addLast(e);
    9. return true;
    10. }

    3)指定位置添加

    1. //在index前插入节点
    2. public void add(int index, E element) {
    3. //检查索引是否处于[0-size]之间
    4. checkPositionIndex(index);
    5. //判断索引index是否等于size
    6. if (index == size)
    7. //如果索引index等于size,那实际上就是添加在链表尾部
    8. linkLast(element);
    9. else
    10. //如果不等,调用linkBefore方法
    11. linkBefore(element, node(index));
    12. }
    13. //检查索引的方法
    14. private void checkPositionIndex(int index) {
    15. if (!isPositionIndex(index))
    16. throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    17. }
    18. //索引是否大于等于0,且小于等于size
    19. private boolean isPositionIndex(int index) {
    20. return index >= 0 && index <= size;
    21. }
    1. //在 指定节点 前插入一个元素,这里 指定节点对象不为 null
    2. void linkBefore(E e, Node succ) {
    3. // 获取指定节点 succ 前面的一个节点
    4. final Node pred = succ.prev;
    5. // 创建新节点,头部指向 succ 前面的节点,尾部指向 succ 节点,
    6. final Node newNode = new Node<>(pred, e, succ);
    7. //让 succ 节点头部指向 新建的节点
    8. succ.prev = newNode;
    9. //如果 succ 前面的节点为空,说明 succ 就是第一个节点,新建的节点就变成第一个节点了
    10. if (pred == null)
    11. first = newNode;
    12. else
    13. //如果前面有节点,让前面的节点的下一个节点指向新节的点
    14. pred.next = newNode;
    15. //节点数自增1
    16. size++;
    17. //结构改变的次数自增1
    18. modCount++;
    19. }
    20. //获取对应索引处的Node节点
    21. Node node(int index) {
    22. //判断索引是否小于节点数量的一半,size >> 1是位运算,就是size/2的意思
    23. if (index < (size >> 1)) {
    24. //从链表头开始查找对应索引处的节点
    25. Node x = first;
    26. for (int i = 0; i < index; i++)
    27. x = x.next;
    28. return x;
    29. } else {
    30. //从链表头开始查找对应索引处的节点
    31. Node x = last;
    32. for (int i = size - 1; i > index; i--)
    33. x = x.prev;
    34. return x;
    35. }
    36. }

    从node节点查找的实现可以看出来,这里的索引的查找,是从头或者尾开始循环遍历查找,时间复杂度为O(n),因此效率相对于ArrayLsit的O(1)的查找时间复杂度来说,效率比较低。 

    4)批量增加

    1. //在index前批量插入节点
    2. public boolean addAll(int index, Collection c) {
    3. //检查索引是否处于[0-size]之间
    4. checkPositionIndex(index);
    5. //将集合转换为数组
    6. Object[] a = c.toArray();
    7. int numNew = a.length;
    8. if (numNew == 0)
    9. return false;
    10. // 记录 index 处节点及其前驱
    11. // 相当于原链表在 pred 处断开了
    12. Node pred, succ;
    13. //如果索引index等于size,那实际上就是添加在链表尾部
    14. if (index == size) {
    15. succ = null;
    16. pred = last;
    17. } else {
    18. succ = node(index);
    19. pred = succ.prev;
    20. }
    21. // 在该节点前驱 pred 后链式增加集合里的元素
    22. for (Object o : a) {
    23. @SuppressWarnings("unchecked") E e = (E) o;
    24. Node newNode = new Node<>(pred, e, null);
    25. if (pred == null)
    26. first = newNode;
    27. else
    28. pred.next = newNode;
    29. pred = newNode;
    30. }
    31. // 把两条链表合在一起
    32. // succ 为空,设置 last 即可
    33. if (succ == null) {
    34. //尾节点为pred
    35. last = pred;
    36. } else {
    37. // succ 不为空,进行两条链表的链接
    38. pred.next = succ;
    39. succ.prev = pred;
    40. }
    41. //节点数增加numNew
    42. size += numNew;
    43. //结构改变的次数自增1
    44. modCount++;
    45. return true;
    46. }

    5、删除元素

    1)删除头节点

    1. //获取并移除此列表的头(第一个元素)。如果列表为null,则抛出NoSuchElementException异常。
    2. public E remove() {
    3. return removeFirst();
    4. }
    5. //获取并移除此列表的头(第一个元素)。如果列表为null,则抛出NoSuchElementException异常。
    6. public E removeFirst() {
    7. final Node f = first;
    8. if (f == null)
    9. throw new NoSuchElementException();
    10. return unlinkFirst(f);
    11. }
    12. //获取并移除此列表的头(第一个元素)。
    13. private E unlinkFirst(Node f) {
    14. //获取该节点(头节点)的值
    15. final E element = f.item;
    16. //获取头结点的下一个节点
    17. final Node next = f.next;
    18. // 相应数据item设为 null, next指向null, 从而之后GC清理
    19. f.item = null;
    20. f.next = null;
    21. //使头节点引用指向下一个节点
    22. first = next;
    23. //如果下一个节点为null,即只有一个元素,此时集合为空
    24. if (next == null)
    25. //那么尾节点的引用也置null
    26. last = null;
    27. else
    28. //下一个节点不为null,将下一个节点作为头节点,并将下一个节点的prev引用置null
    29. next.prev = null;
    30. //节点数自减1
    31. size--;
    32. //结构改变的次数自增1
    33. modCount++;
    34. return element;
    35. }

    其他移除头结点的方法,原理都是一样的: 

    1. public E pollFirst() {
    2. final Node f = first;
    3. return (f == null) ? null : unlinkFirst(f);
    4. }
    5. public E pop() {
    6. return removeFirst();
    7. }

    2)删除尾节点

    1. //获取并移除此列表的尾(最后一个元素)。如果列表为null,则抛出NoSuchElementException异常。
    2. public E removeLast() {
    3. final Node l = last;
    4. if (l == null)
    5. throw new NoSuchElementException();
    6. return unlinkLast(l);
    7. }
    8. //获取并移除此列表的尾(最后一个元素)。
    9. private E unlinkLast(Node l) {
    10. //获取该节点(尾节点)的值
    11. final E element = l.item;
    12. //获取尾节点的上一个节点
    13. final Node prev = l.prev;
    14. // 相应数据item设为 null, prev指向null, 从而之后GC清理
    15. l.item = null;
    16. l.prev = null;
    17. last = prev;
    18. //如果上一个节点为null,即只有一个元素,此时集合为空
    19. if (prev == null)
    20. //那么头节点的引用也置null
    21. first = null;
    22. else
    23. //上一个节点不为null,将上一个节点作为尾节点,并将上一个节点的next引用置null
    24. prev.next = null;
    25. //节点数自减1
    26. size--;
    27. //结构改变的次数自增1
    28. modCount++;
    29. return element;
    30. }

    其他移除头结点的方法,原理都是一样的:  

    1. public E pollLast() {
    2. final Node l = last;
    3. return (l == null) ? null : unlinkLast(l);
    4. }

    3)指定位置移除

    1. public E remove(int index) {
    2. //索引检查
    3. checkElementIndex(index);
    4. //注意这里和指定位置添加元素时检查的索引范围不一样,删除是[0,size),添加是[0,size]
    5. return unlink(node(index));
    6. }
    7. //取消链接非空节点 x
    8. E unlink(Node x) {
    9. // 获取该节点的值
    10. final E element = x.item;
    11. //创建节点引用next,指向该节点的下一个节点
    12. final Node next = x.next;
    13. //创建节点引用prev,指向该节点的上一个节点
    14. final Node prev = x.prev;
    15. //判断该节点是否存在上一个节点
    16. if (prev == null) {
    17. //不存在上一个节点,则该节点为首节点,则让首节点引用指向该节点的下一个节点
    18. first = next;
    19. } else {
    20. //存在上一个节点,则上一个节点的下一个节点引用指向该节点的下一个节点
    21. prev.next = next;
    22. //该节点的上一个节点的引用指向null
    23. x.prev = null;
    24. }
    25. //判断该节点是否存在下一个节点
    26. if (next == null) {
    27. //不存在下一个节点,则该节点为尾节点.则让尾节点引用指向该节点的上一个节点
    28. last = prev;
    29. } else {
    30. //存在下一个节点,则下一个节点的上一个节点引用指向该节点的上一个节点
    31. next.prev = prev;
    32. //该节点的下一个节点的引用指向null
    33. x.next = null;
    34. }
    35. //该节点的值置空.此时没有任何引用指向该node节点对象,该对象将会被垃圾回器回收
    36. x.item = null;
    37. //节点数自减1
    38. size--;
    39. //结构改变的次数自增1
    40. modCount++;
    41. return element;
    42. }

    4)删除指定数据

    1. public boolean remove(Object o) {
    2. if (o == null) {
    3. for (Node x = first; x != null; x = x.next) {
    4. if (x.item == null) {
    5. unlink(x);
    6. return true;
    7. }
    8. }
    9. } else {
    10. for (Node x = first; x != null; x = x.next) {
    11. if (o.equals(x.item)) {
    12. unlink(x);
    13. return true;
    14. }
    15. }
    16. }
    17. return false;
    18. }

    6、获取

    1)获取头节点的方法

    1. //返回此列表的第一个元素。如果此列表为空,则抛出NoSuchElementException异常。
    2. public E getFirst() {
    3. final Node f = first;
    4. if (f == null)
    5. throw new NoSuchElementException();
    6. return f.item;
    7. }
    8. //获取但不移除此列表的头(第一个元素)。如果此列表为空,则返回null。
    9. public E peek() {
    10. final Node f = first;
    11. return (f == null) ? null : f.item;
    12. }
    13. //获取但不移除此列表的头(第一个元素)。如果此列表为空,则抛出NoSuchElementException异常。
    14. public E element() {
    15. return getFirst();
    16. }
    17. //获取但不移除此列表的第一个元素;如果此列表为空,则返回null。
    18. public E peekFirst() {
    19. final Node f = first;
    20. return (f == null) ? null : f.item;
    21. }

    2)获取尾节点的方法

    1. //返回此列表的最后一个元素。如果此列表为空,则抛出NoSuchElementException异常。
    2. public E getLast() {
    3. final Node l = last;
    4. if (l == null)
    5. throw new NoSuchElementException();
    6. return l.item;
    7. }
    8. //获取但不移除此列表的最后一个元素;如果此列表为空,则返回 null。
    9. public E peekLast() {
    10. final Node l = last;
    11. return (l == null) ? null : l.item;
    12. }

    3)指定位置获取 

    1. public E get(int index) {
    2. //索引检查
    3. checkElementIndex(index);
    4. return node(index).item;
    5. }

    7、contains和indexOf

    1. //如果此列表包含指定元素,则返回 true。
    2. public boolean contains(Object o) {
    3. return indexOf(o) != -1;
    4. }
    5. //返回此列表中首次出现的指定元素的索引,如果此列表中不包含该元素,则返回 -1。
    6. public int indexOf(Object o) {
    7. int index = 0;
    8. // o 为 null,直接比引用
    9. if (o == null) {
    10. for (Node x = first; x != null; x = x.next) {
    11. if (x.item == null)
    12. return index;
    13. index++;
    14. }
    15. // 否则,调用 equals
    16. } else {
    17. for (Node x = first; x != null; x = x.next) {
    18. if (o.equals(x.item))
    19. return index;
    20. index++;
    21. }
    22. }
    23. return -1;
    24. }
    25. //从后往前找
    26. public int lastIndexOf(Object o) {
    27. int index = size;
    28. if (o == null) {
    29. for (Node x = last; x != null; x = x.prev) {
    30. index--;
    31. if (x.item == null)
    32. return index;
    33. }
    34. } else {
    35. for (Node x = last; x != null; x = x.prev) {
    36. index--;
    37. if (o.equals(x.item))
    38. return index;
    39. }
    40. }
    41. return -1;
    42. }

    8、克隆方法

    和大多数集合类一样,LinkedList的克隆方法并不会对数据进行克隆,算是浅克隆。

    1. public Object clone() {
    2. LinkedList clone = superClone();
    3. //清空克隆对象的内部变量引用值
    4. clone.first = clone.last = null;
    5. clone.size = 0;
    6. clone.modCount = 0;
    7. /*
    8. 重新赋值
    9. 深克隆Node,这时新旧对象的Node是不一样了,但是对应索引的Node中的Item却还是浅克隆,
    10. 指向了同一个对象,改变对象的值会对两个链表都产生影响!
    11. 但是如果储存的是直接量则不会影响!
    12. */
    13. for (Node x = first; x != null; x = x.next)
    14. clone.add(x.item);
    15. return clone;
    16. }
    17. private LinkedList superClone() {
    18. try {
    19. //Object的clone方法
    20. return (LinkedList) super.clone();
    21. } catch (CloneNotSupportedException e) {
    22. throw new InternalError(e);
    23. }
    24. }

    9、clear方法

    1. public void clear() {
    2. //手动清理全部链表节点之间的引用关系,帮助GC
    3. for (Node x = first; x != null; ) {
    4. Node next = x.next;
    5. x.item = null;
    6. x.next = null;
    7. x.prev = null;
    8. x = next;
    9. }
    10. //最后将外部的头\尾节点引用置空
    11. first = last = null;
    12. //size置0
    13. size = 0;
    14. //结构改变的次数自增1
    15. modCount++;
    16. }

    10、迭代器

    1)迭代器的结构

    1. private class ListItr implements ListIterator {
    2. // 最后被返回的节点的
    3. private Node lastReturned;
    4. // 下一个被返回的节点
    5. private Node next;
    6. // 下一个被返回的节点的索引
    7. private int nextIndex;
    8. // 用于检测并发修改异常
    9. private int expectedModCount = modCount;
    10. ListItr(int index) {
    11. //根据index设置下一个要被返回的节点
    12. next = (index == size) ? null : node(index);
    13. //根据index设置下一个要被返回的节点的索引
    14. nextIndex = index;
    15. }
    16. }

    2)checkForComodification函数

    判断是否存在并发修改异常

    1. final void checkForComodification() {
    2. if (modCount != expectedModCount)
    3. throw new ConcurrentModificationException();
    4. }

     3)next 函数

    用于正序遍历

    1. public E next() {
    2. //检测并发修改异常
    3. checkForComodification();
    4. //检测是否还存在可以获取的节点
    5. if (!hasNext())
    6. throw new NoSuchElementException();
    7. //设置 next,nextIndex 和 lastReturned 的值
    8. lastReturned = next;
    9. next = next.next;
    10. nextIndex++;
    11. return lastReturned.item;
    12. }
    13. //是否具有下一个节点
    14. public boolean hasNext() {
    15. return nextIndex < size;
    16. }

    4)previous函数

     用于倒序遍历

    1. public E previous() {
    2. checkForComodification();
    3. if (!hasPrevious())
    4. throw new NoSuchElementException();
    5. //注意这里,next和lastReturned设置的是一个值
    6. //在remove方法里会有应用
    7. lastReturned = next = (next == null) ? last : next.prev;
    8. nextIndex--;
    9. return lastReturned.item;
    10. }
    11. public boolean hasPrevious() {
    12. return nextIndex > 0;
    13. }

    4)调用原 LinkedList 的增删函数

    1. public void add(E e) {
    2. //检测并发修改异常
    3. checkForComodification();
    4. lastReturned = null;
    5. if (next == null)
    6. //尾部添加
    7. linkLast(e);
    8. else
    9. //next前面添加
    10. linkBefore(e, next);
    11. nextIndex++;
    12. expectedModCount++;
    13. }

    注意源码中倒序遍历与正序遍历的区别 

    1. public void remove() {
    2. //检测并发修改异常
    3. checkForComodification();
    4. //检测最后被返回的节点是否为null,当创建了迭代器对象直接使用该方法时,lastReturned就指向null
    5. //因此不能先于next()方法使用,也不能连续使用remove()方法
    6. if (lastReturned == null)
    7. throw new IllegalStateException();
    8. //获取最后被返回的节点的下一个节点
    9. Node lastNext = lastReturned.next;
    10. //移除lastReturned节点和链表之间的引用关系,后续的节点链接到原节点的位置
    11. unlink(lastReturned);
    12. //这里说明一下,如果是倒序遍历,那么就会返回true,正序遍历就会返回false,
    13. if (next == lastReturned)
    14. next = lastNext;
    15. else
    16. nextIndex--;
    17. lastReturned = null;
    18. //调用原 LinkedList 的增删函数,会导致modCount++,所以这里要更新对应的expectedModCount
    19. expectedModCount++;
    20. }

    5)forEachRemaining函数

    对 next 以及之后的节点的 item 属性调用action.accept(next.item);进行操作

    1. public void forEachRemaining(Consumersuper E> action) {
    2. //判断action是否为null
    3. Objects.requireNonNull(action);
    4. while (modCount == expectedModCount && nextIndex < size) {
    5. action.accept(next.item);
    6. lastReturned = next;
    7. next = next.next;
    8. nextIndex++;
    9. }
    10. //检测并发修改异常
    11. checkForComodification();
    12. }
    13. public static T requireNonNull(T obj) {
    14. if (obj == null)
    15. throw new NullPointerException();
    16. return obj;
    17. }

    四、总结

    总体来看 LinkedList 的源码并不复杂,基本都是双向链表的基本操作,大家感兴趣的可以看一下。

    参考文章:LinkedList源码深度解析以及迭代器机制【一万字】_刘Java的博客-CSDN博客_linkedlist迭代器

    LinkedList 源码解析 - 掘金 (juejin.cn)

    LinkedList(JDK1.8)源码解析_ThinkWon的博客-CSDN博客​​​​​​​

  • 相关阅读:
    Flask——接口路由技术
    redis运维(十)列表
    springboot基础(79):通过pdf模板生成文件
    Spring如何使用环境变量控制配置文件加载呢?
    Java泛型方法与普通成员方法以及案例说明(五)
    vue keepAlive的使用
    《DevOps实践指南》- 读书笔记(二)
    Linux文件系统 struct dentry 结构体解析
    leetcode日记(32)字符串相乘
    数据结构:栈
  • 原文地址:https://blog.csdn.net/qq_51409098/article/details/127536826