用 Go struct 不能犯的一個低級錯誤！
大家好，我是煎魚。
前段時間我分享了 《手撕 Go 面試官：Go 結(jié)構(gòu)體是否可以比較，為什么?》的文章，把基本 Go struct 的比較依據(jù)研究了一番。這不，最近有一位讀者，遇到了一個關(guān)于 struct 的新問題，踩到了雷區(qū)。不得解。
大家一起來看看，建議大家在看到代碼例子后先思考一下答案，再往下看。
獨(dú)立思考很重要。
疑惑的例子
其給出的例子一如下：
- type People struct {}
- func main() {
- a := &People{}
- b := &People{}
- fmt.Println(a == b)
- }
你認(rèn)為輸出結(jié)果是什么呢?
輸出結(jié)果是：false。
再稍加改造一下，例子二如下：
- type People struct {}
- func main() {
- a := &People{}
- b := &People{}
- fmt.Printf("%p\n", a)
- fmt.Printf("%p\n", b)
- fmt.Println(a == b)
- }
輸出結(jié)果是：true。
他的問題是 "為什么第一個返回 false 第二個返回 true，是什么原因?qū)е碌?
煎魚進(jìn)一步的精簡這個例子，得到最小示例：
- func main() {
- a := new(struct{})
- b := new(struct{})
- println(a, b, a == b)
- c := new(struct{})
- d := new(struct{})
- fmt.Println(c, d)
- println(c, d, c == d)
- }
輸出結(jié)果：
- // a, b; a == b
- 0xc00005cf57 0xc00005cf57 false
- // c, d
- &{} &{}
- // c, d, c == d
- 0x118c370 0x118c370 true
第一段代碼的結(jié)果是 false，第二段的結(jié)果是 true，且可以看到內(nèi)存地址指向的完全一樣，也就是排除了輸出后變量內(nèi)存指向改變導(dǎo)致的原因。
進(jìn)一步來看，似乎是 fmt.Print 方法導(dǎo)致的，但一個標(biāo)準(zhǔn)庫里的輸出方法，會導(dǎo)致這種奇怪的問題?
問題剖析
如果之前有被這個 “坑” 過，或有看過源碼的同學(xué)。可能能夠快速的意識到，導(dǎo)致這個輸出是逃逸分析所致的結(jié)果。
我們對例子進(jìn)行逃逸分析：
- // 源代碼結(jié)構(gòu)
- $ cat -n main.go
- 5 func main() {
- 6 a := new(struct{})
- 7 b := new(struct{})
- 8 println(a, b, a == b)
- 9
- 10 c := new(struct{})
- 11 d := new(struct{})
- 12 fmt.Println(c, d)
- 13 println(c, d, c == d)
- 14 }
- // 進(jìn)行逃逸分析
- $ go run -gcflags="-m -l" main.go
- # command-line-arguments
- ./main.go:6:10: a does not escape
- ./main.go:7:10: b does not escape
- ./main.go:10:10: c escapes to heap
- ./main.go:11:10: d escapes to heap
- ./main.go:12:13: ... argument does not escape
通過分析可得知變量 a, b 均是分配在棧中，而變量 c, d 分配在堆中。
其關(guān)鍵原因是因?yàn)檎{(diào)用了 fmt.Println 方法，該方法內(nèi)部是涉及到大量的反射相關(guān)方法的調(diào)用，會造成逃逸行為，也就是分配到堆上。
為什么逃逸后相等
關(guān)注第一個細(xì)節(jié)，就是 “為什么逃逸后，兩個空 struct 會是相等的?”。
這里主要與 Go runtime 的一個優(yōu)化細(xì)節(jié)有關(guān)，如下：
- // runtime/malloc.go
- var zerobase uintptr
變量 zerobase 是所有 0 字節(jié)分配的基礎(chǔ)地址。更進(jìn)一步來講，就是空(0字節(jié))的在進(jìn)行了逃逸分析后，往堆分配的都會指向 zerobase 這一個地址。
所以空 struct 在逃逸后本質(zhì)上指向了 zerobase，其兩者比較就是相等的，返回了 true。
為什么沒逃逸不相等
關(guān)注第二個細(xì)節(jié)，就是 “為什么沒逃逸前，兩個空 struct 比較不相等?”。
Go spec
從 Go spec 來看，這是 Go 團(tuán)隊(duì)刻意而為之的設(shè)計，不希望大家依賴這一個來做判斷依據(jù)。如下：
This is an intentional language choice to give implementations flexibility in how they handle pointers to zero-sized objects. If every pointer to a zero-sized object were required to be different, then each allocation of a zero-sized object would have to allocate at least one byte. If every pointer to a zero-sized object were required to be the same, it would be different to handle taking the address of a zero-sized field within a larger struct.
還說了一句很經(jīng)典的，細(xì)品：
Pointers to distinct zero-size variables may or may not be equal.
另外空 struct 在實(shí)際使用中的場景是比較少的，常見的是：
- 設(shè)置 context，傳遞時作為 key 時用到。
- 設(shè)置空 struct 業(yè)務(wù)場景中臨時用到。
但業(yè)務(wù)場景的情況下，也大多數(shù)會隨著業(yè)務(wù)發(fā)展而不斷改變，假設(shè)有個遠(yuǎn)古時代的 Go 代碼，依賴了空 struct 的直接判斷，豈不是事故上身?
不可直接依賴
因此 Go 團(tuán)隊(duì)這番操作，與 Go map 的隨機(jī)性如出一轍，避免大家對這類邏輯的直接依賴，是值得思考的。
而在沒逃逸的場景下，兩個空 struct 的比較動作，你以為是真的在比較。實(shí)際上已經(jīng)在代碼優(yōu)化階段被直接優(yōu)化掉，轉(zhuǎn)為了 false。
因此，雖然在代碼上看上去是 == 在做比較，實(shí)際上結(jié)果是 a == b 時就直接轉(zhuǎn)為了 false，比都不需要比了。
你說妙不?
沒逃逸讓他相等
既然我們知道了他是在代碼優(yōu)化階段被優(yōu)化的，那么相對的，知道了原理的我們也可以借助在 go 編譯運(yùn)行時的 gcflags 指令，讓他不優(yōu)化。
在運(yùn)行前面的例子時，執(zhí)行 -gcflags="-N -l" 指令：
- $ go run -gcflags="-N -l" main.go
- 0xc000092f06 0xc000092f06 true
- &{} &{}
- 0x118c370 0x118c370 true
你看，兩個比較的結(jié)果都是 true 了。
總結(jié)
在今天這篇文章中，我們針對 Go 語言中的空結(jié)構(gòu)體(struct)的比較場景進(jìn)行了進(jìn)一步的補(bǔ)全。經(jīng)過這兩篇文章的洗禮，你會更好的理解 Go 結(jié)構(gòu)體為什么叫既可比較又不可比較了。
而空結(jié)構(gòu)比較的奇妙，主要原因如下：
若逃逸到堆上，空結(jié)構(gòu)體則默認(rèn)分配的是 runtime.zerobase 變量，是專門用于分配到堆上的 0 字節(jié)基礎(chǔ)地址。因此兩個空結(jié)構(gòu)體，都是 runtime.zerobase，一比較當(dāng)然就是 true 了。
若沒有發(fā)生逃逸，也就分配到棧上。在 Go 編譯器的代碼優(yōu)化階段，會對其進(jìn)行優(yōu)化，直接返回 false。并不是傳統(tǒng)意義上的，真的去比較了。
不會有人拿來出面試題，不會吧，為什么 Go 結(jié)構(gòu)體說可比較又不可比較?
