【Java集合源码】LinkedList
【Java集合源码】LinkedList
- LinkedList 简介
- LinkedList 内部结构
- LinkedList 注释解析
- LinkedList 构造函数
- LinkedList 添加方法
- LinkedList 检索方法
- LinkedList 删除方法
- LinkedList 迭代器
本文参考 JDK 版本为1.8
参考文章：https://github.com/Snailclimb/JavaGuide/blob/master/Java相关/LinkedList.md
LinkedList 简介
- LinkedList是一种可以在任何位置进行高效地插入和移除操作的有序序列，它是基于双端链表实现的。
- LinkedList 实现 Deque 接口，即能将LinkedList当作双端队列使用。
- LinkedList是线程不安全的。如果想使LinkedList变成线程安全的，可以调用静态类Collections类中的synchronizedList方法：
List list=Collections.synchronizedList(new LinkedList());
LinkedList 内部结构
图中，LinkedList中的一个内部私有类就很好理解了：
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 注释解析
在解读源码前，也不要忽略它的一堆注释，这些注释可以帮助更好的理解LinkedList。总结概括以下几点：
- LinkedList的底层实现是由一个双向链表实现的，可以从两端作为头节点遍历链表。
- LinkedList在查找元素时，会根据索引更加接近列表头或者尾来选择列表的头或者尾进行遍历，以提升查找效率。
- LinkedList在实现上是不同步的，即线程不安全，当有多个线程同时操作LinkedList时，有可能会导致数据错误，所以如果需要多线程共享LinkedList时，最好使用synchronizedList来初始化：List list = Collections.synchronizedList(new LinkedList(…));
- 当使用LinkedList迭代器时，有可能会迭代失败并提示java.util.ConcurrentModificationException。如果我们在初始化了LinkedList的迭代器之后，使用Iterator自身以外的remove或者add方法进行增删数据，使LinkedList的结构发生改变，再通过Iterator进行遍历，就会产生这个问题。所以我们使用Iterator遍历时，最好在LinkedList的结构不再发生改变后，再初始化Iterator。
LinkedList 构造函数
//空构造函数
public LinkedList() {
}
//用已有的集合创建链表的构造方法
public LinkedList(Collection<? extends E> c) {
this();
addAll(c);
}
LinkedList 添加方法
- add(E e) ：将元素添加到链表尾部
public boolean add(E e) {
linkLast(e); //这里是调用linkLast方法
return true;
}
/**
* 链接使e作为最后一个元素。
*/
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++;
}
- add(int index,E e)：在指定位置添加元素
public void add(int index, E element) {
checkPositionIndex(index); //检查索引是否处于[0-size]之间
if (index == size)
linkLast(element); //添加在链表尾部
else
linkBefore(element, node(index)); //添加在链表中间
}
linkBefore方法需要给定两个参数，一个插入节点的值，一个指定的node，所以调用了Node(index)去找到index对应的node
- addAll(Collection c )：将集合插入到链表尾部
public boolean addAll(Collection<? extends E> c) {
return addAll(size, c);
}
- addAll(int index, Collection c)： 将集合从指定位置开始插入
public boolean addAll(int index, Collection<? extends E> c) {
//1.检查index范围是否在size之内
checkPositionIndex(index);
//2.toArray()方法把集合的数据存到对象数组中
Object[] a = c.toArray();
int numNew = a.length;
if (numNew == 0)
return false;
//3.得到插入位置的前驱节点和后继节点
Node<E> pred, succ;
if (index == size) {
//如果插入位置为尾部，前驱节点为last，后继节点为null
succ = null;
pred = last;
} else {
//否则，调用node()方法得到后继节点，再得到前驱节点
succ = node(index);
pred = succ.prev;
}
//4.遍历数据将数据插入
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;
}
if (succ == null) {
//如果插入位置在尾部，重置last节点
last = pred;
} else {
//否则，将插入的链表与先前链表连接起来
pred.next = succ;
succ.prev = pred;
}
size += numNew;
modCount++;
return true;
}
- addFirst(E e)： 将元素添加到链表头部
public void addFirst(E e) {
linkFirst(e);
}
//链接e作为第一个元素
private void linkFirst(E e) {
final Node<E> f = first;
final Node<E> newNode = new Node<>(null, e, f);//新建节点，以头节点为后继节点
first = newNode;
if (f == null)
//如果链表为空，last节点也指向该节点
last = newNode;
else
//否则，将头节点的前驱指针指向新节点，也就是指向前一个元素
f.prev = newNode;
size++;
modCount++;
}
- addLast(E e)： 将元素添加到链表尾部（与 add(E e) 方法一样）
public void addLast(E e) {
linkLast(e);
}
- offer(E e)：将数据添加到链表尾部 （其内部调用了add(E e)方法）
public boolean offer(E e) {
return add(e);
}
- offerFirst(E e)：将数据插入链表头部（与addFirst的区别在于该方法可以返回特定的返回值，而addFirst的返回值为void。）
public boolean offerFirst(E e) {
addFirst(e);
return true;
}
- offerLast(E e)：将数据插入链表尾部
public boolean offerLast(E e) {
addLast(e);
return true;
}
LinkedList 检索方法
- get(int index)：：根据指定索引返回数据
public E get(int index) {
//检查index范围是否在size之内
checkElementIndex(index);
//调用Node(index)去找到index对应的node然后返回它的值
return node(index).item;
}
- indexOf(Object o)： 根据对象返回索引位置（从头遍历）
public int indexOf(Object o) {
int index = 0;
//对象是否为null
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;
}
- lastIndexOf(Object o)：根据对象返回索引位置（从尾遍历）
public int lastIndexOf(Object o) {
int index = size;
//对象是否为null
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;
}
- contains(Object o)：检查对象o是否存在于链表中
public boolean contains(Object o) {
return indexOf(o) != -1;
}
- 获取头节点（index=0）数据方法
public E getFirst() {
final Node<E> f = first;
if (f == null)
throw new NoSuchElementException();
return f.item;
}
public E element() {
return getFirst();
}
public E peek() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
public E peekFirst() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
区别： getFirst(),element(),peek(),peekFirst() 这四个获取头结点方法的区别在于对链表为空时的处理。getFirst() 和element() 方法将会在链表为空时，抛出NoSuchElementException异常；peek()和peekFirst()方法将会在链表为空时返回null
- 获取尾节点（index=-1）数据方法
public E getLast() {
final Node<E> l = last;
if (l == null)
throw new NoSuchElementException();
return l.item;
}
public E peekLast() {
final Node<E> l = last;
return (l == null) ? null : l.item;
}
区别：getLast() 方法在链表为空时，会抛出NoSuchElementException异常，而peekLast() 是会返回 null。
LinkedList 删除方法
- remove(Object 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) {
if (o.equals(x.item)) {
//从链表中移除找到的元素
unlink(x);
return true;
}
}
}
return false;
}
- remove(int index)：删除指定位置的元素
public E remove(int index) {
//检查index范围
checkElementIndex(index);
//将节点删除
return unlink(node(index));
}
remove(Object o)方法和remove(int index)方法都调用了unlink(Node x)方法
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;
}
- 删除头节点元素方法：remove() 、removeFirst()、pop()
public E pop() {
return removeFirst();
}
public E remove() {
return removeFirst();
}
public E removeFirst() {
final Node<E> f = first;
if (f == null)
throw new NoSuchElementException();
return unlinkFirst(f);
}
- 删除尾节点元素方法：removeLast()、pollLast()
public E removeLast() {
final Node<E> l = last;
if (l == null)
throw new NoSuchElementException();
return unlinkLast(l);
}
public E pollLast() {
final Node<E> l = last;
return (l == null) ? null : unlinkLast(l);
}
区别： removeLast()在链表为空时将抛出NoSuchElementException，而pollLast()方法返回null。
LinkedList 迭代器
public ListIterator<E> listIterator(int index) {
checkPositionIndex(index);
return new ListItr(index);
}
ListIterator返回了一个ListItr对象，这个是LinkedList的一个内部类，实现了ListIterator接口，提供了next()、hasPrevious()、remove()、set(E e)、add(E e)等方法。
private class ListItr implements ListIterator<E> {
private Node<E> lastReturned;
private Node<E> next;
private int nextIndex;
private int expectedModCount = modCount;//保存当前modCount，确保fail-fast机制
ListItr(int index) {
// assert isPositionIndex(index);
next = (index == size) ? null : node(index);//得到当前索引指向的节点
nextIndex = index;
}
public boolean hasNext() {
return nextIndex < size;
}
//获取下一个节点
public E next() {
checkForComodification();
if (!hasNext())
throw new NoSuchElementException();
lastReturned = next;
next = next.next;
nextIndex++;
return lastReturned.item;
}
public boolean hasPrevious() {
return nextIndex > 0;
}
//获取前一个节点，将next节点向前移
public E previous() {
checkForComodification();
if (!hasPrevious())
throw new NoSuchElementException();
lastReturned = next = (next == null) ? last : next.prev;
nextIndex--;
return lastReturned.item;
}
public int nextIndex() {
return nextIndex;
}
public int previousIndex() {
return nextIndex - 1;
}
public void remove() {
checkForComodification();
if (lastReturned == null)
throw new IllegalStateException();
Node<E> lastNext = lastReturned.next;
unlink(lastReturned);
if (next == lastReturned)
next = lastNext;
else
nextIndex--;
lastReturned = null;
expectedModCount++;
}
public void set(E e) {
if (lastReturned == null)
throw new IllegalStateException();
checkForComodification();
lastReturned.item = e;
}
public void add(E e) {
checkForComodification();
lastReturned = null;
if (next == null)
linkLast(e);
else
linkBefore(e, next);
nextIndex++;
expectedModCount++;
}
public void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
while (modCount == expectedModCount && nextIndex < size) {
action.accept(next.item);
lastReturned = next;
next = next.next;
nextIndex++;
}
checkForComodification();
}
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
}
在ListIterator构造器中，得到当前位置的节点就是变量next。next()方法返回当前节点的值并将next变量指向其后继节点；previous()方法返回当前节点的前一个节点的值并将next节点指向其前驱节点。由于Node是一个双端节点，所以这儿用了一个节点就可以实现从前向后迭代和从后向前迭代。另外在ListIterator初始时，exceptedModCount保存了当前的modCount，如果在迭代期间，有操作改变了链表的底层结构，那么再操作迭代器的方法时将会抛出ConcurrentModificationException。
由于LinkedList实现了Queue接口，所以LinkedList不止有队列的接口，还有栈的接口，可以使用LinkedList作为队列和栈的实现。