JAVA集合之LinkedList源码解析
上一篇讲完ArrayList
之后,我们继续进入List
的下一个目标:LinkedList
(我们不讲Vector了,因为它跟ArrayList只有线程安全和其他一些细微的差别,建议大家自行阅读源码)
LinkedList
特性:
- 排序有序,可重复
- 底层使用双向循环列表结构
- 读取速度慢,增删速度快
- 线程不安全
源码解析
继承关系
简介
{@code List}和{@code Deque}接口的双链列表实现。实现所有可选的列表操作,并允许所有元素
(包括{@code null})。
所有操作均按双向链接列表的预期执行。
索引到列表中的操作将从列表的开头或结尾开始遍历列表,以更接近指定索引的位置为准。
请注意,此实现未同步。如果多个线程同时访问链表,并且至少一个线程在结构上修改了链表,
则它必须在外部进行同步。
(结构修改是添加或删除一个或多个元素的任何操作;仅设置元素的值不是结构修改。)
通常通过在自然封装列表的某个对象上进行同步来完成此操作。如果不存在这样的对象,
则应使用{@link CollectionssynchronizedList Collections.synchronizedList}方法“包装”列表。
最好在创建时完成此操作,以防止意外的不同步访问列表:
列表= = Collections.synchronizedList(new LinkedList(...));
此类的{@返回的迭代器代码迭代器}和{@code listIterator}方法是快速失败的:
如果在创建迭代器之后的任何时间对列表进行结构修改,则可以通过迭代器自己的{@code remove}进行任何修改,
或者{@code add}方法,迭代器将抛出{@link ConcurrentModificationException}。
因此,面对并发修改,迭代器会快速干净地失败,而不会在未来的不确定时间冒着任意,不确定的行为的风险。
请注意,不能保证迭代器的快速失败行为,因为通常来说,在存在不同步的并发修改的情况下,
不可能做出任何严格的保证。快速失败的迭代器会尽最大努力抛出{@code ConcurrentModificationException}。
因此,编写依赖于此异常的程序以确保其正确性是错误的:迭代器的快速失败行为应仅用于检测错误。
简介明确指出LinkedList
底层是一个双向链表,允许null值插入,未实现线程同步。我们来看看LinkedList
到底怎么实现的
内部类
链表由一系列节点(链表中每一个元素称为节点)组成,节点可以在运行时动态生成。每个节点包括两个部分:一个是存储数据元素的数据域,另一个是存储下一个节点地址的指针域。 在C语言中,由于有指针的存在,我们可以很方便的实现一个链表,在JAVA中,我们使用对象的方式来充当指针,指向下一个节点的内存地址。
在LinkedList
类的内部,Node
类充当链表中的每一个节点,内部参数包括负责储存数据的item,指向上一节点的prev,和指向下一节点的next。在每一个Node初始化的时候都要传入前后指针和数据。
添加方法
在链表首部添加元素
private void linkFirst(E e) {
将内部保存的首节点点赋值给f
final Node<E> f = first;
//创建新节点,新节点的next节点是当前的首节点
final Node<E> newNode = new Node<>(null, e, f);
//把新节点作为新的首节点
first = newNode;
判断是否是第一个添加的元素
如果是将新节点赋值给last 即是first也是last
如果不是把原首节点的prev设置为新节点 不需要管last了
if (f == null)
last = newNode;
else
f.prev = newNode;
更新链表节点个数
size++;
修改次数加1
modCount++;
}
在链表尾部添加元素
void linkLast(E e) {
将内部保存的尾节点赋值给l
final Node<E> l = last;
创建新节点,新节点的prev节点是当前的尾节点
final Node<E> newNode = new Node<>(l, e, null);
把新节点作为新的尾节点
last = newNode;
判断是否是第一个添加的元素
如果是将新节点赋值给first 即是first也是last
如果不是把原尾节点的next设置为新节点
if (l == null)
first = newNode;
else
l.next = newNode;
更新链表节点个数
size++;
将集合修改次数加1
modCount++;
}
添加默认在尾部进行
public boolean add(E e) {
linkLast(e);
return true;
}
在指定下标添加元素
//该方法和上面add方法的区别是,该方法可以指定位置插入元素
public void add(int index, E element) {
//判断是否越界
checkPositionIndex(index);
//如果index等于链表节点个数,就将元素添加到俩表尾部,否则调用linkBefore方法
if (index == size)
linkLast(element);
else
linkBefore(element, node(index));
}
node(index)详解
//获取指定位置的节点
Node<E> node(int index) {
//如果index小于size的一半,就从首节点开始遍历,一直获取x的下一个节点
//如果index大于或等于size的一半,就从尾节点开始遍历,一直获取x的上一个节点
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;
}
}
linkBefore(E e, Node succ)详解
//将元素插入到指定节点前
void linkBefore(E e, Node<E> succ) {
// assert succ != null;
//拿到succ的上一节点
final Node<E> pred = succ.prev;
//创建新节点
final Node<E> newNode = new Node<>(pred, e, succ);
//将新节点作为succ的上一节点
succ.prev = newNode;
//判断succ是否是首节点
//如果是将新节点作为新的首节点
//如果不是将新节点作为pred的下一节点
if (pred == null)
first = newNode;
else
pred.next = newNode;
//更新链表节点个数
size++;
//将集合修改次数加1
modCount++;
}
指定下标添加,先进行越界判断。之后判断下标是否为尾部,如果是尾部则调用addlast
方法。如果不是尾部,则先取出原链表当前下标的值,调用linkbefore
方法。创建新节点指向当前下标的头和尾。再把下个节点的prev
指向当前节点。之后判断原节点的前一节点是否为空,为空则表示当前节点为首节点,不为空则把原节点的前一节点的next
指向当前节点。完成双向链表。
addAll(int index, Collection<? extends E> c)详解
//将集合内的元素依次插入index位置后
public boolean addAll(int index, Collection<? extends E> c) {
//判断是否越界
checkPositionIndex(index);
//将集合转换为数组
Object[] a = c.toArray();
int numNew = a.length;
//判断数组长度是否为0,为0直接返回false
if (numNew == 0)
return false;
//pred上一个节点,succ当前节点
Node<E> pred, succ;
//判断index位置是否等于链表元素个数
//如果等于succ赋值为null,pred赋值为当前链表尾节点last
//如果不等于succ赋值为index位置的节点,pred赋值为succ的上一个节点
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);
//如果上一个节点为null,把新节点作为新的首节点,否则pred的下一个节点为新节点
if (pred == null)
first = newNode;
else
pred.next = newNode;
//把新节点赋值给上一个节点
pred = newNode;
}
//如果index位置的节点为null,把pred作业尾节点
//如果不为null,pred的下一节点为index位置的节点,succ的上一节点为pred
if (succ == null) {
last = pred;
} else {
pred.next = succ;
succ.prev = pred;
}
//更新链表节点个数
size += numNew;
//将集合修改次数加1
modCount++;
//因为是无界的,所以添加元素总是会成功
return true;
}
到上面这么多种方式添加元素,其实本质只是三种方式,在链表的首部、尾部、中间位置添加元素。如下图所示:
在链表首尾添加元素很高效,在中间添加元素比较低效,首先要找到插入位置的节点,在修改前后节点的指针。
删除方法
remove(Objcect o)详解
public boolean remove(Object o) {
//因为LinkedList允许存在null,所以需要进行null判断
if (o == null) {
//从首节点开始遍历
for (Node<E> x = first; x != null; x = x.next) {
if (x.item == null) {
//调用unlink方法删除指定节点
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;
}
unlink(node x)移除指定节点详解
//删除指定节点
E unlink(Node<E> x) {
//获取x节点的元素,以及它上一个节点,和下一个节点
final E element = x.item;
final Node<E> next = x.next;
final Node<E> prev = x.prev;
//如果x的上一个节点为null,说明是首节点,将x的下一个节点设置为新的首节点
//否则将x的上一节点设置为next,将x的上一节点设为null
if (prev == null) {
first = next;
} else {
prev.next = next;
x.prev = null;
}
//如果x的下一节点为null,说明是尾节点,将x的上一节点设置新的尾节点
//否则将x的上一节点设置x的上一节点,将x的下一节点设为null
if (next == null) {
last = prev;
} else {
next.prev = prev;
x.next = null;
}
//将x节点的元素值设为null,等待垃圾收集器收集
x.item = null;
//链表节点个数减1
size--;
//将集合修改次数加1
modCount++;
//返回删除节点的元素值
return element;
}
unlinkFirst(node f)移除首节点详解
//删除首节点
private E unlinkFirst(Node<E> f) {
//首节点的元素值
final E element = f.item;
//首节点的下一节点
final Node<E> next = f.next;
//将首节点的元素值和下一节点设为null,等待垃圾收集器收集
f.item = null;
f.next = null; // help GC
//将next设置为新的首节点
first = next;
//如果next为null,说明说明链表中只有一个节点,把last也设为null
//否则把next的上一节点设为null
if (next == null)
last = null;
else
next.prev = null;
//链表节点个数减1
size--;
//将集合修改次数加1
modCount++;
//返回删除节点的元素值
return element;
}
unlinkLast(node l)移除尾节点详解
private E unlinkLast(Node<E> l) {
//尾节点的元素值
final E element = l.item;
//尾节点的上一节点
final Node<E> prev = l.prev;
//将尾节点的元素值和上一节点设为null,等待垃圾收集器收集
l.item = null;
l.prev = null; // help GC
//将prev设置新的尾节点
last = prev;
//如果prev为null,说明说明链表中只有一个节点,把first也设为null
//否则把prev的下一节点设为null
if (prev == null)
first = null;
else
prev.next = null;
//链表节点个数减1
size--;
//将集合修改次数加1
modCount++;
//返回删除节点的元素值
return element;
}
删除和添加一样,其实本质只有三种方式,即删除首部、尾部、中间节点。如下图所示:
关于队列的操作
LinkedList
可以作为FIFO(First In First Out)的队列,也就是先进先出的队列使用,以下是关于队列的操作。
//获取队列的第一个元素,如果为null会返回null
public E peek() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
//获取队列的第一个元素,如果为null会抛出异常
public E element() {
return getFirst();
}
//获取队列的第一个元素,如果为null会返回null
public E poll() {
final Node<E> f = first;
return (f == null) ? null : unlinkFirst(f);
}
//获取队列的第一个元素,如果为null会抛出异常
public E remove() {
return removeFirst();
}
//将元素添加到队列尾部
public boolean offer(E e) {
return add(e);
}
关于双端队列的操作
双端列队可以作为栈使用,栈的特性是LIFO(Last In First Out),也就是后进先出。所以作为栈使用也很简单,添加和删除元素都只操作队列的首节点即可。
//将元素添加到首部
public boolean offerFirst(E e) {
addFirst(e);
return true;
}
//将元素添加到尾部
public boolean offerLast(E e) {
addLast(e);
return true;
}
//获取首部的元素值
public E peekFirst() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
//获取尾部的元素值
public E peekLast() {
final Node<E> l = last;
return (l == null) ? null : l.item;
}
//删除首部,如果为null会返回null
public E pollFirst() {
final Node<E> f = first;
return (f == null) ? null : unlinkFirst(f);
}
//删除尾部,如果为null会返回null
public E pollLast() {
final Node<E> l = last;
return (l == null) ? null : unlinkLast(l);
}
//将元素添加到首部
public void push(E e) {
addFirst(e);
}
//删除首部,如果为null会抛出异常
public E pop() {
return removeFirst();
}
//删除链表中元素值等于o的第一个节点,其实和remove方法是一样的,因为内部还是调用的remove方法
public boolean removeFirstOccurrence(Object o) {
return remove(o);
}
//删除链表中元素值等于o的最后一个节点
public boolean removeLastOccurrence(Object o) {
//因为LinkedList允许存在null,所以需要进行null判断
if (o == null) {
//和remove方法的区别它是从尾节点往前遍历
for (Node<E> x = last; x != null; x = x.prev) {
if (x.item == null) {
//调用unlink方法删除指定节点
unlink(x);
return true;
}
}
} else {
for (Node<E> x = last; x != null; x = x.prev) {
if (o.equals(x.item)) {
unlink(x);
return true;
}
}
}
return false;
}
其他方法
//判断元素是否存在于链表中
public boolean contains(Object o) {
return indexOf(o) != -1;
}
//从前往后查找返回节点元素值等于o的位置,不存在返回-1
public int indexOf(Object o) {
int index = 0;
if (o == null) {
for (Node<E> x = first; x != null; x = x.next) {
if (x.item == null)
return index;
index++;
}
} else {
for (Node<E> x = first; x != null; x = x.next) {
if (o.equals(x.item))
return index;
index++;
}
}
return -1;
}
//该方法和上面indexOf方法相反,它是从后往前查找返回节点元素值等于o的位置,不存在返回-1
public int lastIndexOf(Object o) {
int index = size;
if (o == null) {
for (Node<E> x = last; x != null; x = x.prev) {
index--;
if (x.item == null)
return index;
}
} else {
for (Node<E> x = last; x != null; x = x.prev) {
index--;
if (o.equals(x.item))
return index;
}
}
return -1;
}
//克隆函数,返回LinkedList的克隆对象
public Object clone() {
LinkedList<E> clone = superClone();
// 将新建LinkedList置于最初状态
clone.first = clone.last = null;
clone.size = 0;
clone.modCount = 0;
// 将链表中所有节点的数据都添加到克隆对象中
for (Node<E> x = first; x != null; x = x.next)
clone.add(x.item);
return clone;
}
//返回LinkedList节点单元素值的Object数组
public Object[] toArray() {
Object[] result = new Object[size];
int i = 0;
//将链表中所有节点的元素值添加到object数组中
for (Node<E> x = first; x != null; x = x.next)
result[i++] = x.item;
return result;
}
// 返回LinkedList的模板数组。所谓模板数组,即可以将T设为任意的数据类型
public <T> T[] toArray(T[] a) {
//如果a的长度小于LinkedList节点个数,说明a不能容纳LinkedList的所有节点元素值
//则新建一个数组,数组大小为LinkedList节点个数,并赋值给a
if (a.length < size)
a = (T[])java.lang.reflect.Array.newInstance(
a.getClass().getComponentType(), size);
int i = 0;
Object[] result = a;
// 将链表中所有节点的元素值都添加到数组a中
for (Node<E> x = first; x != null; x = x.next)
result[i++] = x.item;
if (a.length > size)
a[size] = null;
return a;
}
//将LinkedList中的数据写入到输入流中,先写容量,再写数据
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// Write out any hidden serialization magic
s.defaultWriteObject();
// Write out size
s.writeInt(size);
// Write out all elements in the proper order.
for (Node<E> x = first; x != null; x = x.next)
s.writeObject(x.item);
}
//从输入流中读取数据,一样是先读容量,再读数据
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in any hidden serialization magic
s.defaultReadObject();
// Read in size
int size = s.readInt();
//从输入流中将元素值逐个添加到链表中
// Read in all elements in the proper order.
for (int i = 0; i < size; i++)
linkLast((E)s.readObject());
}
总结
LinkedList
自己实现了序列化和反序列化,因为它实现了writeObject
和readObject
方法。LinkedList
是一个以双向链表实现的List。LinkedList
还是一个双端队列,具有队列、双端队列、栈的特性。LinkedList
在首部和尾部添加、删除元素效率高效,在中间添加、删除元素效率较低。LinkedList
虽然实现了随机访问,但是效率低效,不建议使用。LinkedList
是线程不安全的。