张治峰的博客

LinkedList源码解析

2019-12-03

特性

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

AbstractSequentialList

继承于AbstractSequentialList,本质上面与继承AbstractList没有什么区别,AbstractSequentialList完善了AbstractList中没有实现的方法。

Serializable

可序列化。成员变量 Node 使用 transient 修饰,通过重写read/writeObject 方法实现序列化。

Cloneable

重写clone()方法,通过创建新的LinkedList对象,遍历拷贝数据进行对象拷贝。

Deque

实现了Collection大家庭中的队列接口,说明他拥有作为双端队列的功能。

LinkedList与ArrayList最大的区别就是LinkedList中实现了Collection中的QueueDeque接口拥有作为双端队列的功能!

基本属性

/**
* 当前元素个数
*/
transient int size = 0;
/**
* 第一个结点
*/
transient Node<E> first;
/**
* 最后一个结点
*/
transient Node<E> last;
/**
* 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;
}
}

LinkedList 在1.6 版本以及之前,只通过一个 header 头指针保存队列头和尾。这种操作可以说很有深度,但是从代码阅读性来说,却加深了阅读代码的难度。因此在后续的JDK 更新中,将头节点和尾节点 区分开了。节点类也更名为 Node。

为什么Node这个类是静态的?答案是:这跟内存泄露有关,Node类是在LinkedList类中的,也就是一个内部类,若不使用static修饰,那么Node就是一个普通的内部类,在java中,一个普通内部类在实例化之后,默认会持有外部类的引用,这就有可能造成内存泄露(内部类与外部类生命周期不一致时)。但使用static修饰过的内部类(称为静态内部类),就不会有这种问题

非静态内部类会自动生成一个构造器依赖于外部类:也是内部类可以访问外部类的实例变量的原因,静态内部类不会生成,访问不了外部类的实例变量,只能访问类变量。通过字节码可以得到验证!

构造器

public LinkedList() {
}
public LinkedList(Collection<? extends E> c) {
this();
//操作次数只会记录一次设置前驱后继
addAll(c);
}

添加元素

public boolean add(E e) {
//默认尾部添加
linkLast(e);
return true;
}

/**
* 目标节点创建后寻找前驱节点,前驱节点存在就修改前驱节点的后继,指向目标节点
* @param e
*/
void linkLast(E e) {
//获取这个list对象内部的Node类型成员last,即末位节点,以该节点作为新插入元素的前驱节点
final Node<E> l = last;
//创建新节点
final Node<E> newNode = new Node<>(l, e, null);
//把新节点作为该list对象的最后一个节点
last = newNode;
//处理原先的末位节点,如果这个list本来就是一个空的链表
if (l == null)
//把新节点作为首节点
first = newNode;
else
//如果链表内部已经有元素,把原来的末位节点的后继指向新节点,完成链表修改
l.next = newNode;
//修改当前list的size
size++;
//并记录该list对象被执行修改的次数
modCount++;
}
public void add(int index, E element) {
//检查下标的合法性
checkPositionIndex(index);
//插入位置是末位,那还是上面末位添加的逻辑
if (index == size)
linkLast(element);
else
linkBefore(element, node(index));
}
private void checkPositionIndex(int index) {
if (!isPositionIndex(index))
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
private boolean isPositionIndex(int index) {
return index >= 0 && index <= size;
}
Node<E> node(int index) {
//二分查找 index离哪端更近 就从哪端开始找
if (index < (size >> 1)) {
Node<E> x = first;
for (int i = 0; i < index; i++)
//找到index位置的元素
x = x.next;
return x;
} else {
Node<E> x = last;
for (int i = size - 1; i > index; i--)
x = x.prev;
return x;
}
}

/**
* 指位添加方法核心逻辑 操作新节点
* 紧接修改原有节点的前驱属性,最后再修改前驱节点的后继属性
* @param e
* @param succ
*/
void linkBefore(E e, Node<E> succ) {
//原位置节点的前驱pred
final Node<E> pred = succ.prev;
//创建新节点,设置新节点其前驱为原位置节点的前驱pred,其后继为原位置节点succ
final Node<E> newNode = new Node<>(pred, e, succ);
//将新节点设置到原位置节点的前驱
succ.prev = newNode;
//前驱如果为空,空链表,则新节点设置为first
if (pred == null)
first = newNode;
else
//将新节点设置到前驱节点的后继
pred.next = newNode;
//修改当前list的size
size++;
//记录该list对象被执行修改的次数。
modCount++;
}
public boolean addAll(int index, Collection<? extends E> c) {
checkPositionIndex(index);
//将集合转化为数组
Object[] a = c.toArray();
int numNew = a.length;
if (numNew == 0)
return false;
Node<E> pred, succ;
//获取插入节点的前节点(prev)和尾节点(next)
if (index == size) {
succ = null;
pred = last;
} else {
succ = node(index);
pred = succ.prev;
}
//将集合中的数据编织成链表
for (Object o : a) {
@SuppressWarnings("unchecked") E e = (E) o;
Node<E> newNode = new Node<>(pred, e, null);
if (pred == null)
first = newNode;
else
pred.next = newNode;
pred = newNode;
}
//将 Collection 的链表插入 LinkedList 中。
if (succ == null) {
last = pred;
} else {
pred.next = succ;
succ.prev = pred;
}
size += numNew;
modCount++;
return true;
}

删除元素

AbstractSequentialList->remove

public E remove(int index) {
checkElementIndex(index);
//node(index)找到index位置的元素
return unlink(node(index));
}

/**
* remove(Object o)这个删除元素的方法的形参o是数据本身
* 而不是LinkedList集合中的元素(节点)
* 所以需要先通过节点遍历的方式,找到o数据对应的元素
* 然后再调用unlink(Node x)方法将其删除
* @param o
* @return
*/
public boolean remove(Object o) {
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) {
if (o.equals(x.item)) {
unlink(x);
return true;
}
}
}
return false;
}
E unlink(Node<E> x) {
//x的数据域element
final E element = x.item;
//x的下一个结点
final Node<E> next = x.next;
//x的上一个结点
final Node<E> prev = x.prev;
//如果x的上一个结点是空结点的话,那么说明x是头结点
if (prev == null) {
first = next;
} else {
//将x的前后节点相连双向链表
prev.next = next;
//x的属性置空
x.prev = null;
}
//如果x的下一个结点是空结点的话,那么说明x是尾结点
if (next == null) {
last = prev;
} else {
//将x的前后节点相连 双向链表
next.prev = prev;
x.next = null;
}
//指向null 方便GC回收
x.item = null;
size--;
modCount++;
return element;
}

Deque->remove

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

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

private E unlinkFirst(Node<E> f) {
final E element = f.item;
//获取到头结点的下一个结点
final Node<E> next = f.next;
//GC
f.item = null;
f.next = null;
//头指针指向的是头结点的下一个结点
first = next;
if (next == null)
last = null;
else
next.prev = null;
size--;
modCount++;
return element;
}

双端链表(队列Queue)

java中队列的实现就是LinkedList: 我们之所以说LinkedList 为双端链表,是因为他实现了Deque 接口;我们知道,队列是先进先出的,添加元素只能从队尾添加,删除元素只能从队头删除,Queue中的方法就体现了这种特性。 支持队列的一些操作,我们来看一下有哪些方法实现:

  • pop() 是栈结构的实现类的方法,返回的是栈顶元素,并且将栈顶元素删除
  • poll() 是队列的数据结构,获取对头元素并且删除队头元素
  • push() 是栈结构的实现类的方法,把元素压入到栈中
  • peek() 获取队头元素 ,但是不删除队列的头元素
  • offer() 添加队尾元素

队列增加

offer()添加队尾元素

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

队列删除

poll()是队列的数据结构,获取对头元素并且删除队头元素

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

队列查询

peek()获取队头元素 ,但是不删除队列的头元素

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

栈的增

push()是栈结构的实现类的方法,把元素压入到栈中
push() 方法的底层实现,其实就是调用了 addFirst(Object o)

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

栈的删

pop()是栈结构的实现类的方法,返回的是栈顶元素,并且将栈顶元素删除

public E pop() {
return removeFirst();
}
public E removeFirst() {
final Node f = first;
if (f == null)
throw new NoSuchElementException();
return unlinkFirst(f);
}
使用支付宝打赏
使用微信打赏

若你觉得我的文章对你有帮助,欢迎点击上方按钮对我打赏

扫描二维码,分享此文章