LinkedList 基本示例及源码解析
目录
一、javadoc 简介
- linkedlist双向链表,实现了list的 双向队列接口,实现了所有list可选择性操作,允许存储任何元素(包括null值)
- 所有的操作都可以表现为双向性的,遍历的时候会从首部到尾部进行遍历,直到找到最近的元素位置
- 注意这个实现不是线程安全的, 如果多个线程并发访问链表,并且至少其中的一个线程修改了链表的结构,那么这个链表必须进行外部加锁。(结构化的操作指的是任何添加或者删除至少一个元素的操作,仅仅对已有元素的值进行修改不是结构化的操作)。
- list list = collections.synchronizedlist(new linkedlist(…)),可以用这种链表做同步访问,但是最好在创建的时间就这样做,避免意外的非同步对链表的访问
- 迭代器返回的iterators 和 listiterator方法会造成fail-fast机制:如果链表在生成迭代器之后被结构化的修改了,除了使用iterator独有的remove方法外,都会抛出并发修改的异常。因此,在面对并发修改的时候,这个迭代器能够快速失败,从而避免非确定性的问题
二、linkedlist 继承接口和实现类介绍
java.util.linkedlist 继承了 abstractsequentiallist 并实现了list , deque , cloneable 接口,以及serializable 接口
public class linkedlist<e> extends abstractsequentiallist<e> implements list<e>, deque<e>, cloneable, java.io.serializable {}
类之间的继承体系如下:
下面就对继承树中的部分节点进行大致介绍:
abstractsequentiallist 介绍:
这个接口是list一系列子类接口的核心接口,以求最大限度的减少实现此接口的工作量,由顺序访问数据存储(例如链接链表)支持。对于随机访问的数据(像是数组),abstractlist 应该优先被使用这个接口可以说是与abstractlist类相反的,它实现了随机访问方法,提供了get(int index),set(int index,e element), add(int index,e element) and remove(int index)方法对于程序员来说:
要实现一个列表,程序员只需要扩展这个类并且提供listiterator 和 size方法即可。
对于不可修改的列表来说, 程序员需要实现列表迭代器的 hasnext(), next(), hasprevious(),
previous 和 index 方法
abstractlist 介绍:
这个接口也是list继承类层次的核心接口,以求最大限度的减少实现此接口的工作量,由顺序访问
数据存储(例如链接链表)支持。对于顺序访问的数据(像是链表),abstractsequentiallist 应该优先被使用,
如果需要实现不可修改的list,程序员需要扩展这个类,list需要实现get(int) 方法和list.size()方法
如果需要实现可修改的list,程序员必须额外重写set(int,object) set(int,e)方法(否则会抛出
unsupportedoperationexception的异常),如果list是可变大小的,程序员必须额外重写add(int,object) , add(int, e) and remove(int) 方法
abstractcollection 介绍:
这个接口是collection接口的一个核心实现,尽量减少实现此接口所需的工作量
为了实现不可修改的collection,程序员应该继承这个类并提供呢iterator和size 方法
为了实现可修改的collection,程序团需要额外重写类的add方法,iterator方法返回的iterator迭代器也必须实现remove方法
三、linkedlist 基本方法介绍
上面看完了linkedlist 的继承体系之后,来看看linkedlist的基本方法说明
添加 add(): ----> 1. add(e e) : 直接在'末尾'处添加元素 ----> 2. add(int index,e element) : 在'指定索引处添'加元素 ----> 3. addall(collections<? extends e> c) : 在'末尾'处添加一个collection集合 ----> 4. addall(int index,collections<? extends e> c):在'指定位置'添加一个collection集合 ----> 5. addfirst(e e): 在'头部'添加指定元素 ----> 6. addlast(e e): 在'尾部'添加指定元素 offer(): ----> 1. offer(e e): 在链表'末尾'添加元素 ----> 2. offerfirst(e e): 在'链表头'添加指定元素 ----> 3. offerlast(e e): 在'链表尾'添加指定元素 push(e e): 在'头部'压入元素 移除 poll(): ----> 1. poll(): 访问并移除'首部'元素 ----> 2. pollfirst(): 访问并移除'首部'元素 ----> 3. polllast(): 访问并移除'尾部'元素 pop(): 从列表代表的堆栈中弹出元素,从'头部'弹出 remove(): ----> 1. remove(): 移除并返回'首部'元素 ----> 2. remove(int index) : 移除'指定索引'处的元素 ----> 3. remove(object o): 移除指定元素 ----> 4. removefirst(): 移除并返回'第一个'元素 ----> 5. removefirstoccurrence(object o): 从头到尾遍历,移除'第一次'出现的元素 ----> 6. removelast(): 移除并返回'最后一个'元素 ----> 7. removelastoccurrence(object o): 从头到尾遍历,移除'最后一次'出现的元素 clear(): 清空所有元素 访问 peek(): ----> 1. peek(): 只访问,不移除'首部'元素 ----> 2. peekfirst(): 只访问,不移除'首部'元素,如果链表不包含任何元素,则返回null ----> 3. peeklast(): 只访问,不移除'尾部'元素,如果链表不包含任何元素,返回null element(): 只访问,不移除'头部'元素 get(): ----> 1. get(int index): 返回'指定索引'处的元素 ----> 2. getfirst(): 返回'第一个'元素 ----> 3. getlast(): 返回'最后一个'元素 indexof(object o): 检索某个元素'第一次'出现所在的位置 lastindexof(object o): 检索某个元素'最后一次'出现的位置 其他 clone() : 返回一个链表的拷贝,返回值为object 类型 contains(object o): 判断链表是否包含某个元素 descendingiterator(): 返回一个迭代器,里面的元素是倒叙返回的 listiterator(int index) : 在指定索引处创建一个'双向遍历迭代器' set(int index, e element): 替换某个位置处的元素 size() : 返回链表的长度 spliterator(): 创建一个后期绑定并快速失败的元素 toarray(): 将链表转变为数组返回
四、linkedlist 基本方法使用
学以致用,熟悉了上面基本方法之后,来简单做一个demo测试一下上面的方法:
/** * 此方法描述 * linedlist 集合的基本使用 */ public class linkedlisttest { public static void main(string[] args) { linkedlist<string> list = new linkedlist<>(); list.add("111"); list.add("222"); list.add("333"); list.add(1,"123"); // 分别在头部和尾部添加元素 list.addfirst("top"); list.addlast("bottom"); system.out.println(list); // 数组克隆 object listclone = list.clone(); system.out.println(listclone); // 创建一个首尾互换的迭代器 iterator<string> it = list.descendingiterator(); while (it.hasnext()){ system.out.print(it.next() + " "); } system.out.println(); list.clear(); system.out.println("list.contains('111') ? " + list.contains("111")); collection<string> collec = arrays.aslist("123","213","321"); list.addall(collec); system.out.println(list); system.out.println("list.element = " + list.element()); system.out.println("list.get(2) = " + list.get(2)); system.out.println("list.getfirst() = " + list.getfirst()); system.out.println("list.getlast() = " + list.getlast()); // 检索指定元素出现的位置 system.out.println("list.indexof(213) = " + list.indexof("213")); list.add("123"); system.out.println("list.lastindexof(123) = " + list.lastindexof("123")); // 在首部和尾部添加元素 list.offerfirst("first"); list.offerlast("999"); system.out.println("list = " + list); list.offer("last"); // 只访问,不移除指定元素 system.out.println("list.peek() = " + list.peek()); system.out.println("list.peekfirst() = " + list.peekfirst()); system.out.println("list.peeklast() = " + list.peeklast()); // 访问并移除元素 system.out.println("list.poll() = " + list.poll()); system.out.println("list.pollfirst() = " + list.pollfirst()); system.out.println("list.polllast() = " + list.polllast()); system.out.println("list = " + list); // 从首部弹出元素 list.pop(); // 压入元素 list.push("123"); system.out.println("list.size() = " + list.size()); system.out.println("list = " + list); // remove操作 system.out.println(list.remove()); system.out.println(list.remove(1)); system.out.println(list.remove("999")); system.out.println(list.removefirst()); system.out.println("list = " + list); list.addall(collec); list.addfirst("123"); list.addlast("123"); system.out.println("list = " + list); list.removefirstoccurrence("123"); list.removelastoccurrence("123"); list.removelast(); system.out.println("list = " + list); list.addfirst("top"); list.addlast("bottom"); list.set(2,"321"); system.out.println("list = " + list); system.out.println("--------------------------"); // 创建一个list的双向链表 listiterator<string> listiterator = list.listiterator(); while(listiterator.hasnext()){ // 移到list的末端 system.out.println(listiterator.next()); } system.out.println("--------------------------"); while (listiterator.hasprevious()){ // 移到list的首端 system.out.println(listiterator.previous()); } } }
console:
-------1------- [top, 111, 123, 222, 333, bottom] -------2-------[top, 111, 123, 222, 333, bottom] bottom 333 222 123 111 top list.contains('111') ? false [123, 213, 321] list.element = 123 list.get(2) = 321 list.getfirst() = 123 list.getlast() = 321 list.indexof(213) = 1 list.lastindexof(123) = 3 -------4------- [first, 123, 213, 321, 123, 999] list.peek() = first list.peekfirst() = first list.peeklast() = last list.poll() = first list.pollfirst() = 123 list.polllast() = last -------5------- [213, 321, 123, 999] list.size() = 4 -------6------- [123, 321, 123, 999] 123 123 true 321 -------7------- [] -------8------- [123, 123, 213, 321, 123] list = [123, 213] -------9------- [top, 123, 321, bottom] -------------------------- top 123 321 bottom -------------------------- bottom 321 123 top
五、linkedlist 内部结构以及基本元素声明
- linkedlist内部结构是一个双向链表,具体示意图如下
每一个链表都是一个node节点,由三个元素组成
private static class node<e> { // node节点的元素 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; } }
first 节点也是头节点, last节点也是尾节点
- linkedlist 中有三个元素,分别是
transient int size = 0; // 链表的容量 transient node<e> first; // 指向第一个节点 transient node<e> last; // 指向最后一个节点
- linkedlist 有两个构造函数,一个是空构造函数,不添加任何元素,一种是创建的时候就接收一个collection集合。
/** * 空构造函数 */ public linkedlist() {} /** * 创建一个包含指定元素的构造函数 */ public linkedlist(collection<? extends e> c) { this(); addall(c); }
六、linkedlist 具体源码分析
前言: 此源码是作者根据上面的代码示例一步一步跟进去的,如果有哪些疑问或者讲的不正确的地方,请与作者联系。
添加
添加的具体流程示意图:
包括方法有:
add(e e)
add(int index, e element)
addall(collection<? extends e> c)
addall(int index, collection<? extends e> c)
addfirst(e e)
addlast(e e)
offer(e e)
offerfirst(e e)
offerlast(e e)
下面对这些方法逐个分析其源码:
add(e e) :
// 添加指定元素至list末尾 public boolean add(e e) { linklast(e); return true; } // 真正添加节点的操作 void linklast(e e) { final node<e> l = last; // 生成一个node节点 final node<e> newnode = new node<>(l, e, null); last = newnode; // 如果l = null,代表的是第一个节点,所以这个节点即是头节点 // 又是尾节点 if (l == null) first = newnode; else // 如果不是的话,那么就让该节点的next 指向新的节点 l.next = newnode; size++; modcount++; }
- 比如第一次添加的是111,此时链表中还没有节点,所以此时的尾节点last 为null, 生成新的节点,所以 此时的尾节点也就是111,所以这个 111 也是头节点,再进行扩容,修改次数对应增加
- 第二次添加的是 222, 此时链表中已经有了一个节点,新添加的节点会添加到尾部,刚刚添加的111 就当作头节点来使用,222被添加到111的节点后面。
add(int index,e e) :
/** *在指定位置插入指定的元素 */ 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; } // linklast 上面已经介绍过 // 查找索引所在的节点 node<e> node(int index) { // assert iselementindex(index); 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; } } // 在非空节点插入元素 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.prev = newnode; if (pred == null) first = newnode; else pred.next = newnode; size++; modcount++; }
- 例如在位置为1处添加值为123 的元素,首先对下标进行越界检查,判断这个位置是否等于链表的长度,如果与链表长度相同,就往最后插入,如果不同的话,就在索引的前面插入。
- 下标为1 处并不等于索引的长度,所以在索引前面插入,首先对查找 1 这个位置的节点是哪个,并获取这个节点的前面一个节点,在判断这个位置的前一个节点是否为null,如果是null,那么这个此处位置的元素就被当作头节点,如果不是的话,头节点的next 节点就指向123
addfirst(e e) :
// 在头节点插入元素 public void addfirst(e e) { linkfirst(e); } private void linkfirst(e e) { // 先找到first 节点 final node<e> f = first; final node<e> newnode = new node<>(null, e, f); first = newnode; if (f == null) // f 为null,也就代表着没有头节点 last = newnode; else f.prev = newnode; size++; modcount++; }
例如要添加top 元素至链表的首部,需要先找到first节点,如果first节点为null,也就说明没有头节点,如果不为null,则头节点的prev节点是新插入的节点。
addlast(e e) :
public void addlast(e e) { linklast(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++; }
方法逻辑与在头节点插入基本相同
addall(collections<? extends e> c) :
/** * 在链表中批量添加数据 */ public boolean addall(collection<? extends e> c) { return addall(size, c); } 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; // 直接在末尾添加,所以index = size 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; } if (succ == null) { last = pred; } else { pred.next = succ; succ.prev = pred; } size += numnew; modcount++; return true; }
collection<string> collec = arrays.aslist("123","213","321"); list.addall(collec);
- 例如要插入一个collection为123,213,321 的集合,没有指定插入元素的位置,默认是向链表的尾部进行链接,首先会进行数组越界检查,然后会把集合转换为数组,在判断数组的大小是否为0,为0返回,不为0,继续下面操作
- 因为是直接向链尾插入,所以index = size,然后遍历每个数组,首先生成对应的节点,在对节点进行链接,因为succ 是null,此时last 节点 = pred,这个时候的pred节点就是遍历数组完成后的最后一个节点
- 然后再扩容数组,增加修改次数
addall(collections<? extends e> c) : 这个方法的源码同上
offer也是对元素进行添加操作,源码和add方法相同
offerfirst(e e)和addfirst(e e) 源码相同
offerlast(e e)和addlast(e e) 源码相同)
push(e e) 和addfirst(e e) 源码相同
取出元素
包括方法有:
- peek()
- peekfirst()
- peeklast()
- element()
- get(int index)
- getfirst()
- getlast()
- indexof(object o)
- lastindexof(object o)
peek()
/** * 只是访问,但是不移除链表的头元素 */ public e peek() { final node<e> f = first; return (f == null) ? null : f.item; }
peek() 源码比较简单,直接找到链表的第一个节点,判断是否为null,如果为null,返回null,否则返回链首的元素
peekfirst() : 源码和peek() 相同
peeklast():
/** * 访问,但是不移除链表中的最后一个元素 * 或者返回null如果链表是空链表 */ public e peeklast() { final node<e> l = last; return (l == null) ? null : l.item; }
源码也比较好理解
element() :
/** * 只是访问,但是不移除链表的第一个元素 */ public e element() { return getfirst(); } public e getfirst() { final node<e> f = first; if (f == null) throw new nosuchelementexception(); return f.item; }
与peek()相同的地方都是访问链表的第一个元素,不同是element元素在链表为null的时候会报空指针异常
****get(int index) :
/* * 返回链表中指定位置的元素 */ public e get(int index) { checkelementindex(index); return node(index).item; } // 返回指定索引下的元素的非空节点 node<e> node(int index) { // assert iselementindex(index); 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; } }
get(int index)源码也是比较好理解,首先对下标进行越界检查,没有越界的话直接找到索引位置对应的node节点,进行返回
getfirst() :源码和element()相同
getlast(): 直接找到最后一个元素进行返回,和getfist几乎相同
indexof(object 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; }
两种情况:
- 如果需要检索的元素是null,对元素链表进行遍历,返回x的元素为空的位置
- 如果需要检索的元素不是null,对元素的链表遍历,直到找到相同的元素,返回元素下标
lastindexof(object 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; }
从indexof(object o)源码反向理解
删除
删除节点的示意图如下:
包括的方法有:
- poll()
- pollfirst()
- polllast()
- pop()
- remove()
- remove(int index)
- remove(object o)
- removefirst()
- removefirstoccurrence(object o)
- removelast()
- removelastoccurrence(object o)
- clear()
poll() :
/* * 访问并移除链表中指定元素 */ public e poll() { final node<e> f = first; return (f == null) ? null : unlinkfirst(f); } // 断开第一个非空节点 private e unlinkfirst(node<e> f) { // assert f == first && f != null; final e element = f.item; final node<e> next = f.next; f.item = null; f.next = null; // help gc first = next; if (next == null) last = null; else next.prev = null; size--; modcount++; return element; }
poll()方法也比较简单直接,首先通过node方法找到第一个链表头,然后把链表的元素和链表头指向的next元素置空,再把next节点的元素变为头节点的元素
pollfirst() : 与poll() 源码相同
polllast(): 与poll() 源码很相似,不再解释
pop()
/* * 弹出链表的指定元素,换句话说,移除并返回链表中第一个元素 */ public e removefirst() { final node<e> f = first; if (f == null) throw new nosuchelementexception(); return unlinkfirst(f); } // unlinkfirst 源码上面