簡單的 for 循環也會踩的坑

前言

最近實現某個業務時,需要讀取數據然後再非同步處理;在 Go 中實現起來自然就比較簡單,偽程式碼如下:

	list := []*Demo{{"a"}, {"b"}}
	for _, v := range list {
		go func() {
			fmt.Println("name="+v.Name)
		}()
	}
	
	type Demo struct {
		Name string
	}

看似非常簡單幾行程式碼卻和我們的預期不符,列印之後輸出的是:

name=b
name=b

並不是我們預期的:

name=a
name=b

坑一

由於寫 go 的資歷尚淺、道行更是淺薄,這 bug 我硬是找了個把小時;剛開始還以為是數據源的問題,經歷了好幾輪自我懷疑。總之過程先不表,先看看如何修復這個問題。

首先第一種辦法是使用臨時變數:

	list := []*Demo{{"a"}, {"b"}}
	for _, v := range list {
		temp:=v
		go func() {
			fmt.Println("name="+temp.Name)
		}()
	}

這樣便可正確輸出,其實從這種寫法中也能看出問題的端倪。

在第一種沒有使用臨時變數時,主協程很快就運行完畢,這時候列印的子協程可能還沒運行;當開始運行的時候,這裡的 v 已經被最後一個賦值了。

所以這裡列印的一直都是最後一個變數。

而使用臨時變數會將當前遍歷的值拷貝一份,自然就不會互相影響了。


當然除了臨時變數也可使用閉包解決。

	list := []*Demo{{"a"}, {"b"}}
	for _, v := range list {
		go func(temp *Demo) {
			fmt.Println("name="+temp.Name)
		}(v)
	}

將參數通過閉包傳遞時,每個 goroutine 都會在自己的棧中存放一份參數的拷貝,這樣也能區分了。

坑二

與之類似的還有第二個坑:

	list2 := []Demo{{"a"}, {"b"}}
	var alist []*Demo
	for _, test := range list2 {
		alist = append(alist, &test)
	}
	fmt.Println(alist[0].Name, alist[1].Name)

這段程式碼與我們預期不不符:

b b

但我們稍加修改就可以了:

	list2 := []Demo{{"a"}, {"b"}}
	var alist []Demo
	for _, test := range list2 {
		fmt.Printf("addr=%p\n", &test)
		alist = append(alist, test)
	}
	fmt.Println(alist[0].Name, alist[1].Name)
addr=0xc000010240
addr=0xc000010240
a b

順便列印了記憶體地址,其實從結果中大概就能猜到原因;每次遍歷列印的記憶體地址都是相同,所以如果我們存放的是指針,本質上存儲的都是同一塊記憶體地址的內容,所以值相同。

而如果我們只存儲值,不存指針自然也不會有這個問題。

但如果想使用指針如何處理呢?

	list2 := []Demo{{"a"}, {"b"}}
	var alist []*Demo
	for _, test := range list2 {
		temp := test
		//fmt.Printf("addr=%p\n", &test)
		alist = append(alist, &temp)
	}
	fmt.Println(alist[0].Name, alist[1].Name)

也簡單,同樣的使用臨時變數即可。

通過官方源碼可以得知,for range 只是語法糖,本質上也是 for 循環;因為每次都是對同一個對象遍歷賦值,所以便會出現這樣的「烏龍」。

defer 的坑

for 循環 + defer 也是組合坑(雖然不推薦這麼用),還是先來看個例子:


// demo1
func main() {
	a := []int{1, 2, 3}
	for _, v := range a {
		defer fmt.Println(v)
	}
}

// demo2
func main() {
	a := []int{1, 2, 3}
	for _, v := range a {
		defer func() {
			fmt.Println(v)
		}()
	}
}

分別輸出:

//demo1
3
2
1
//demo2
3
3
3

demo1的結果很好理解,defer 可以理解為將執行語句放入到棧中,所以呈現的結果是先進後出。

demo2中,由於是閉包,閉包對變數 v 持有的是引用,所以在最終延遲執行時 v 已經被最後一個值賦值,所以列印出來都是相同的。

解決方法與上文類似,傳入參數即可解決:

	for _, v := range a {
		defer func(v int) {
			fmt.Println(v)
		}(v)
	}

這類細節問題日常開發大概率是碰不上的,最有可能遇到的就是面試了,所以多了解了解也沒壞處。

總結

類似於第一種情況在 for 循環中 goroutine 調用,我覺得 IDE 完全是可以做到提醒的;比如 IDEA 中就把大部分認為可能發的錯誤包含進去,期待後續 goland 的更新。

但其實這幾種錯誤官方部落格已經提醒過了。


//github.com/golang/go/wiki/CommonMistakes#using-reference-to-loop-iterator-variable
只是大部分人估計都沒去看過,這事之後我也得花時間好好閱讀下。