[[413679]]

本文轉(zhuǎn)載自微信公眾號(hào)「Golang來(lái)啦」，作者Seekload。轉(zhuǎn)載本文請(qǐng)聯(lián)系Golang來(lái)啦公眾號(hào)。

四哥水平有限，如有翻譯或理解錯(cuò)誤，煩請(qǐng)幫忙指出，感謝!

相信大家對(duì) Go 語(yǔ)言的鎖拷貝問題并不陌生，那我們應(yīng)該如何規(guī)范使用Go 語(yǔ)言才能規(guī)避這個(gè)問題呢?一起來(lái)看作者是如何處理的。

原文如下：

假設(shè)我們有一個(gè)包含 map 的結(jié)構(gòu)體，現(xiàn)在想在方法中修改這個(gè) map，看下面的例子[1]：

package main 
 
import "fmt" 
 
type Container struct { 
  counters map[string]int 
} 
 
func (c Container) inc(name string) { 
  c.counters[name]++ 
} 
 
func main() { 
  c := Container{counters: map[string]int{"a": 0, "b": 0}} 
 
  doIncrement := func(name string, n int) { 
    for i := 0; i < n; i++ { 
      c.inc(name) 
    } 
  } 
 
  doIncrement("a", 100000) 
 
  fmt.Println(c.counters) 
} 

Container 包含一個(gè)計(jì)數(shù)器集合，按 name 區(qū)分。inc() 會(huì)按 name 對(duì)相應(yīng)的計(jì)數(shù)器執(zhí)行自增操作(假設(shè)計(jì)數(shù)器存在)。main() 里循環(huán)多次調(diào)用 inc()。

執(zhí)行上面的代碼，輸出：

map[a:100000 b:0] 

現(xiàn)在假設(shè)有兩個(gè) goroutine 會(huì)并發(fā)地調(diào)用 inc()。因?yàn)槲覀儽仨毿⌒母?jìng)爭(zhēng)條件，所以使用了 Mutex 保護(hù)臨界區(qū)。

package main 
 
import ( 
  "fmt" 
  "sync" 
  "time" 
) 
 
type Container struct { 
  sync.Mutex                       // <-- Added a mutex 
  counters map[string]int 
} 
 
func (c Container) inc(name string) { 
  c.Lock()                         // <-- Added locking of the mutex 
  defer c.Unlock() 
  c.counters[name]++ 
} 
 
func main() { 
  c := Container{counters: map[string]int{"a": 0, "b": 0}} 
 
  doIncrement := func(name string, n int) { 
    for i := 0; i < n; i++ { 
      c.inc(name) 
    } 
  } 
 
  go doIncrement("a", 100000) 
  go doIncrement("a", 100000) 
 
  // Wait a bit for the goroutines to finish 
  time.Sleep(300 * time.Millisecond) 
  fmt.Println(c.counters) 
} 

你期望上面這段代碼會(huì)輸出什么呢?我得到的結(jié)果是這樣的：

func (c *Container) inc(name string) { 
  c.Lock() 
  defer c.Unlock() 
  c.counters[name]++ 
} 

我們使用 mutex 時(shí)已經(jīng)很小心了，怎么還會(huì)出問題呢?你覺得應(yīng)該如何修復(fù)這個(gè)問題?提示：只需要改動(dòng)一個(gè)字符的代碼就可以了!

代碼的問題在于，無(wú)論何時(shí)調(diào)用 inc()，c 都會(huì)是一份拷貝，因?yàn)?inc() 是定義在 Container 上，而非 *Container;換句話說，c 是值接受者，而不是指針接受者。因此，inc() 并不能真正修改 c 的內(nèi)容。

但等等，文章第一個(gè)示例是如何工作的?在單協(xié)程的例子中，c 也是按值傳遞，但是為什么能得到正確的結(jié)果 -- 在 inc() 在對(duì) map 所做的修改，能影響到 main() 函數(shù)的原始值。這是因?yàn)?map 是引用類型而非值類型。Container 里保存的是指向 map 的指針，而不是 map 實(shí)際的數(shù)據(jù)。所以即使我們創(chuàng)建 Container 的副本，counters 保存的仍是指向 map 的地址。

所以文章第一個(gè)例子也是存在問題的，盡管執(zhí)行結(jié)果沒有問題，但是使用方法不符合官方指南[2] - 在方法中對(duì)原始數(shù)據(jù)進(jìn)行修改，則方法應(yīng)定義成指針方法，而非值方法。這里對(duì) map 的使用給了我們一種錯(cuò)誤的提示。作為練習(xí)，可以將第一個(gè)示例中的 map 換成 int 類型的計(jì)數(shù)器，并注意觀察 inc() 的副本是如何遞增的，在 inc() 中對(duì)副本做的修改不會(huì)影響到 main() 中的原始值。

Mutex 是值類型(可以看 Go 文檔[3]相關(guān)的定義，包括注釋里也明確地提示不能拷貝)，復(fù)制再使用是錯(cuò)誤的。復(fù)制僅僅是創(chuàng)建了一個(gè)新的 mutex，很顯然地，對(duì)計(jì)數(shù)器的互斥使用就失效了。

所以應(yīng)該這樣修改，定義 inc() 方法時(shí)在 Container 之前添加 *：

func (c *Container) inc(name string) { 
  c.Lock() 
  defer c.Unlock() 
  c.counters[name]++ 
} 

c 通過指針方式傳到方法中，指向的 Container 與 main() 函數(shù)里面的是同一個(gè)。

這個(gè)問題并不罕見，事實(shí)上，使用 go vet 命令就會(huì)發(fā)現(xiàn)這個(gè)問題：

$ go tool vet method-mutex-value-receiver.go 
method-mutex-value-receiver.go:19: inc passes lock by value: main.Container 

在我看來(lái)，實(shí)際上這個(gè)問題幫助我們理清了值接收者與指針接收者之間的區(qū)別。為了說明這一點(diǎn)，下面還有一個(gè)示例，這個(gè)示例與上面兩個(gè)示例沒有關(guān)系。這個(gè)示例使用到了 & 取值符和 %p 格式化輸出變量的地址。

package main 
 
import "fmt" 
 
type Container struct { 
  i int 
  s string 
} 
 
func (c Container) byValMethod() { 
  fmt.Printf("byValMethod got &c=%p, &(c.s)=%p\n", &c, &(c.s)) 
} 
 
func (c *Container) byPtrMethod() { 
  fmt.Printf("byPtrMethod got &c=%p, &(c.s)=%p\n", c, &(c.s)) 
} 
 
func main() { 
  var c Container 
  fmt.Printf("in main &c=%p, &(c.s)=%p\n", &c, &(c.s)) 
 
  c.byValMethod() 
  c.byPtrMethod() 
} 

執(zhí)行代碼后輸出(如果在你的機(jī)器上執(zhí)行，輸出的地址可能不同，但是這不影響說明問題)：

in main &c=0xc00000a060, &(c.s)=0xc00000a068 
byValMethod got &c=0xc00000a080, &(c.s)=0xc00000a088 
byPtrMethod got &c=0xc00000a060, &(c.s)=0xc00000a068 

main() 函數(shù)里創(chuàng)建了 Container 變量 c，并且輸出它的地址和它的成員 s 的地址，接著調(diào)用了 Container 的兩個(gè)方法。byValMethod() 是值接受者，因?yàn)槭窃档目截愃写蛴〉牡刂凡灰粯?。另一方面，byPtrMethod() 是指針接收者，輸出的地址與 main() 函數(shù)輸出的地址一致，因?yàn)檎{(diào)用時(shí)獲取的是 c 實(shí)際的地址，而不是副本。

參考資料

[1]例子: https://github.com/eliben/code-for-blog/tree/master/2018/go-copying-mutex

[2]官方指南: https://golang.org/doc/faq#methods_on_values_or_pointers

[3]Go 文檔: https://golang.org/src/sync/mutex.go