Go-list
在Go语言的标准库中，提供了一个container包，这个包中提供了三种数据类型，就是heap,list和ring，本节要讲的是list的使用以及源码剖析。
要使用Go提供的list链表，则首先需要导入list包，如下所示：
package main
import(
"container/list"
)
导入包之后，需要了解list中定义了两种数据类型，Element 和 List，定义如下：
Element 和 List的定义
// list包 实现了一个双链表
// Element是链表中的元素。
type Element struct {
//next和previous指针 是双链表的两个指针，
//为了简化实现，在内部将链表 l 实现为一个环，这样&l.root既是最后一个列表元素(l.Back())的下一个元素，又是第一个列表元素(l.Front())的上一个元素。
next, prev *Element
//该元素所属的链表
list *List
//存储在该元素中的值
Value any
}
// List表示一个双链表。
// List的零值是一个可以使用的空列表。
type List struct {
root Element //哨兵链表元素，只能使用 &root, root.prev 和 root.next
len int //当前列表长度不包括哨兵元素
}
在 Element 里面定义了两个Element类型的指针next, prev以及 List类型的指针list, Value用来存储值，List里面定义了一个 Element作为链表的Root，len表示链表的长度。
import 之后，先看一下 list 有哪些方法：
list 的方法
Init()：初始化方法
// Init : 初始化或清空链表 L
func (l *List) Init() *List {
l.root.next = &l.root //初始时，next指针和prev指针都指向根节点
l.root.prev = &l.root
l.len = 0 //初始时，链表长度为0
return l
}
New（）：创建链表
// New(): 返回一个已经初始化的链表
func New() *List { return new(List).Init() }
len（）：返回链表长度
// Len : 返回链表 L 元素的个数
// 时间复杂度是O(1)
func (l *List) Len() int { return l.len }
Front()：返回第一个元素
// Front 返回链表 L 的第一个元素，如果链表为空，则返回 nil
func (l *List) Front() *Element {
if l.len == 0 {
return nil
}
return l.root.next
}
Back()：返回最后一个元素
// Back 返回链表L最后一个元素，如果链表为空，则返回nil
func (l *List) Back() *Element {
if l.len == 0 {
return nil
}
return l.root.prev
}
LazyInit()
// lazyInit lazily initializes a zero List value.
func (l *List) lazyInit() {
if l.root.next == nil {
l.Init()
}
}
insert():插入元素
// insert 在元素at后插入元素e, 增加链表长度，返回元素e inserts e after at, increments l.len, and returns e.
func (l *List) insert(e, at *Element) *Element {
e.prev = at
e.next = at.next
e.prev.next = e
e.next.prev = e
e.list = l
l.len++
return e
}
insterValue()：插入一个值为v 的元素
// insertValue 是 inster 的一个包装，意为在元素at之后插入一个值为v的元素
func (l *List) insertValue(v any, at *Element) *Element {
return l.insert(&Element{Value: v}, at)
}
remove()：删除一个元素（无返回值）
// remove 从链表中删除元素e，减少链表
func (l *List) remove(e *Element) {
e.prev.next = e.next
e.next.prev = e.prev
e.next = nil // 避免内存泄漏
e.prev = nil // avoid memory leaks
e.list = nil
l.len--
}
move()：移动一个元素
// move 将元素e移动到元素at之后
func (l *List) move(e, at *Element) {
if e == at {
return
}
e.prev.next = e.next
e.next.prev = e.prev
e.prev = at
e.next = at.next
e.prev.next = e
e.next.prev = e
}
Remove():移除一个元素（有返回值）
// Remove 如果元素e是链表L中的元素，那么将元素e从链表L移除
//返回元素e的值 e.Value
// 元素不能为空
func (l *List) Remove(e *Element) any {
if e.list == l {
//如果元素e在链表L中，那么当元素e被插入时，链表L必须已经初始化
//或者 链表L为空，(元素e是一个空元素)，此时l.remove将会出错
l.remove(e)
}
return e.Value
}
PushFront():链表头插入元素
// PushFront 在链表L的头插入一个值为V 的元素e,返回元素e
func (l *List) PushFront(v any) *Element {
l.lazyInit()
return l.insertValue(v, &l.root)
}
PushBack():链表尾插入元素
// PushBack 在链表L的尾插入一个值为V 的元素e,返回元素e
func (l *List) PushBack(v any) *Element {
l.lazyInit()
return l.insertValue(v, l.root.prev)
}
InsertBefore():在某元素前插入元素
// InsertBefore 在元素mark前插入一个值为v的新元素e，并返回e
//如果元素mark不是链表L的元素，则不修改链表
// 元素mask必须不为空
func (l *List) InsertBefore(v any, mark *Element) *Element {
if mark.list != l {
return nil
}
// see comment in List.Remove about initialization of l
return l.insertValue(v, mark.prev)
}
InsertAfter()：在某元素后插入元素
// InsertAfter 在元素mark后插入一个值为v的新元素e，并返回e
//如果元素mark不是链表L的元素，则不修改链表
// 元素mask必须不为空
func (l *List) InsertAfter(v any, mark *Element) *Element {
if mark.list != l {
return nil
}
// see comment in List.Remove about initialization of l
return l.insertValue(v, mark)
}
MoveTpFront():将元素移动到链表头
// MoveToFront 将元素e移动到链表L的头。
//如果元素e不是链表L的元素，则不修改列表。
//该元素e不能为nil。
func (l *List) MoveToFront(e *Element) {
if e.list != l || l.root.next == e {
return
}
// see comment in List.Remove about initialization of l
l.move(e, &l.root)
}
MoveToBack():将元素移动到链表尾
// MoveToBack 将元素e移动到链表L的尾。
//如果元素e不是链表L的元素，则不修改列表。
//该元素e不能为nil。
func (l *List) MoveToBack(e *Element) {
if e.list != l || l.root.prev == e {
return
}
// see comment in List.Remove about initialization of l
l.move(e, l.root.prev)
}
MoveBefore():将元素e移动到某元素前
// MoveBefore 将元素e移动到元素mask前面的新位置。
//如果元素e或元素mark不是链表L的元素，或者e == mark，则不修改列表。
//元素e和mask不能为nil。
func (l *List) MoveBefore(e, mark *Element) {
if e.list != l || e == mark || mark.list != l {
return
}
l.move(e, mark.prev)
}
MoveAfter():将元素e移动到某元素后
// MoveAfter 将元素e移动到元素mask后面的新位置。
//如果元素e或元素mark不是链表L的元素，或者e == mark，则不修改列表。
//元素e和mask不能为nil。
func (l *List) MoveAfter(e, mark *Element) {
if e.list != l || e == mark || mark.list != l {
return
}
l.move(e, mark)
}
PushBackList():在链表后插入链表
// PushBackList 在链表L的后面插入另一个链表other的副本。
//链表L和other可以是相同的。它们不能为空。
func (l *List) PushBackList(other *List) {
l.lazyInit()
for i, e := other.Len(), other.Front(); i > 0; i, e = i-1, e.Next() {
l.insertValue(e.Value, l.root.prev)
}
}
PushFrontList():在链表前插入链表
// PushFrontList 在链表L的后面插入另一个链表other的副本。
//链表L和other可以是相同的。它们不能为空。
func (l *List) PushFrontList(other *List) {
l.lazyInit()
for i, e := other.Len(), other.Back(); i > 0; i, e = i-1, e.Prev() {
l.insertValue(e.Value, &l.root)
}
}
简单使用list示例
func main() {
list_test := list.New() // 创建list对象
list_test.PushBack("123") // 往List队列尾部插入数据
list_test.PushBack("456")
list_test.PushBack("789")
fmt.Println(list_test.Len()) // 输出list长度
fmt.Println(list_test.Front()) // 输出list第一个元素
fmt.Println(list_test.Front().Next()) // 输出list第一个元素的下一个元素
fmt.Println(list_test.Front().Next().Next()) // 输出list第三个元素
}
//运行结果
//list_test.Len() 3
//list_test.Front() &{0xc00007e510 0xc00007e4b0 0xc00007e4b0 123}
//list_test.Front().Next() &{0xc00007e540 0xc00007e4e0 0xc00007e4b0 456}
//list_test.Front().Next().Next() &{0xc00007e4b0 0xc00007e510 0xc00007e4b0 789}
//&{0xc00007e510 0xc00007e4b0 0xc00007e4b0 123} &{0xc00007e540 0xc00007e4e0 0xc00007e4b0 456} &{0xc00007e4b0 0xc00007e510 0xc00007e4b0 789}