go語言坑之list刪除所有元素

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

go提供了一個list包，類似python的list，可以儲存任意類型的資料，並提供了相應的API，如下：

type Element    func (e *Element) Next() *Element    func (e *Element) Prev() *Elementtype List    func New() *List    func (l *List) Back() *Element    func (l *List) Front() *Element    func (l *List) Init() *List    func (l *List) InsertAfter(v interface{}, mark *Element) *Element    func (l *List) InsertBefore(v interface{}, mark *Element) *Element    func (l *List) Len() int    func (l *List) MoveAfter(e, mark *Element)    func (l *List) MoveBefore(e, mark *Element)    func (l *List) MoveToBack(e *Element)    func (l *List) MoveToFront(e *Element)    func (l *List) PushBack(v interface{}) *Element    func (l *List) PushBackList(other *List)    func (l *List) PushFront(v interface{}) *Element    func (l *List) PushFrontList(other *List)    func (l *List) Remove(e *Element) interface{}

藉助list包提供的API，list用起來確實挺方便，但是在使用過程中，如果不注意就會遇到一些難以發現的坑，導致程式結果不是預想的那樣。這裡要說的坑是通過for迴圈遍曆list，並刪除所有元素時會遇到的問題。例如，下面這個樣本程式建立了一個list，並依次將0-3存入，然後通過for迴圈遍曆list刪除所有元素：

package mainimport (    "container/list"    "fmt")func main() {    l := list.New()    l.PushBack(0)    l.PushBack(1)    l.PushBack(2)    l.PushBack(3)    fmt.Println("original list:")    prtList(l)    fmt.Println("deleted list:")    for e := l.Front(); e != nil; e = e.Next() {        l.Remove(e)    }    prtList(l)}func prtList(l *list.List) {    for e := l.Front(); e != nil; e = e.Next() {        fmt.Printf("%v ", e.Value)    }    fmt.Printf("\n")}

運行程式輸出如下：

original list:0 1 2 3 deleted list:1 2 3

從輸出可以知道，list中的元素並沒有被完全刪除，僅刪除了第一個元素0，和最初設想不一樣，按照go的使用習慣，遍曆一個list並刪除所有元素寫法應該如下：

for e := l.Front(); e != nil; e = e.Next() {    l.Remove(e)}

但是根據上面範例程式碼的輸出，這樣刪除list所有元素是無效的，那麼問題出在哪呢？由for迴圈的機制可以知道，既然刪除了第一個元素，沒有刪除第二個元素，肯定是第二次迴圈的條件無效，才導致迴圈退出，即執行完下面語句後：

l.Remove(e)

e應該為nil，所以迴圈退出。在for迴圈中的l.Remove(e)語句前添加列印語句驗證，例如添加如下語句：

fmt.Println("delete a element from list")

運行程式輸出如下：

original list:0 1 2 3 deleted list:delete a element from list1 2 3

可以看到，確實只迴圈了一次，迴圈就結束了。即當執行完語句l.Remove(e)後，e等於e.Next()，因為e.Next()為nil，導致e為nil，迴圈退出。為什麼e.Next()會是nil呢？通過查看go list源碼，如下所示：

// remove removes e from its list, decrements l.len, and returns e.func (l *List) remove(e *Element) *Element {    e.prev.next = e.next    e.next.prev = e.prev    e.next = nil // avoid memory leaks    e.prev = nil // avoid memory leaks    e.list = nil    l.len--    return e}// Remove removes e from l if e is an element of list l.// It returns the element value e.Value.func (l *List) Remove(e *Element) interface{} {    if e.list == l {        // if e.list == l, l must have been initialized when e was inserted        // in l or l == nil (e is a zero Element) and l.remove will crash        l.remove(e)    }    return e.Value}

由源碼中可以看到，當執行l.Remove(e)時，會在內部調用l.remove(e)方法刪除元素e，為了避免記憶體流失，會將e.next和e.prev賦值為nil，這就是問題根源。

修正程式如下：

package mainimport (    "container/list"    "fmt")func main() {    l := list.New()    l.PushBack(0)    l.PushBack(1)    l.PushBack(2)    l.PushBack(3)    fmt.Println("original list:")    prtList(l)    fmt.Println("deleted list:")    var next *list.Element    for e := l.Front(); e != nil; e = next {        next = e.Next()        l.Remove(e)    }    prtList(l)}func prtList(l *list.List) {    for e := l.Front(); e != nil; e = e.Next() {        fmt.Printf("%v ", e.Value)    }    fmt.Printf("\n")}

運行程式輸出如下：

original list:0 1 2 3 deleted list:

可以看見，list中的所有元素已經被正確刪除。

本次薦書：簡單的邏輯學

簡單的邏輯學