Golang 新手要注意的陷阱和常見錯誤

原文: 50 Shades of Go: Traps, Gotchas, and Common Mistakes for New Golang Devs
翻譯: Go的50度灰:新Golang開發者要注意的陷阱、技巧和常見錯誤 , 譯者: 影風LEY

Go 是一門簡單有趣的語言,但與其他語言類似,它會有一些技巧。。。這些技巧的絕大部分並不是 Go 的缺陷造成的。如果你以前使用的是其他語言,那麼這其中的有些錯誤就是很自然的陷阱。其它的是由錯誤的假設和缺少細節造成的。

如果你花時間學習這門語言,閱讀官方說明、wiki、郵件列表討論、大量的優秀博文和 Rob Pike 的展示,以及源代碼,這些技巧中的絕大多數都是顯而易見的。儘管不是每個人都是以這種方式開始學習的,但也沒關係。如果你是 Go 語言新人,那麼這裏的信息將會節約你大量的調試代碼的時間。

一. 初級篇

1. 開大括號不能放在單獨的一行

在大多數其他使用大括號的語言中,你需要選擇放置它們的位置。 Go 的方式不同。你可以爲此感謝下自動分號的注入(沒有預讀)。是的, Go 中也是有分號的:-)
失敗的例子:

package main
import "fmt"
func main()  
{ //error, can't have the opening brace on a separate line
    fmt.Println("hello there!")
}

編譯錯誤:

/tmp/sandbox826898458/main.go:6: syntax error: unexpected semicolon or newline before {

有效的例子:

package main
import "fmt"
func main() {  
    fmt.Println("works!")
}

2. 未使用的變量

如果你有未使用的變量,代碼將編譯失敗。當然也有例外。在函數內一定要使用聲明的變量,但未使用的全局變量是沒問題的。
如果你給未使用的變量分配了一個新的值,代碼還是會編譯失敗。你需要在某個地方使用這個變量,才能讓編譯器愉快的編譯。
Fails:

package main
var gvar int //not an error
func main() {  
    var one int   //error, unused variable
    two := 2      //error, unused variable
    var three int //error, even though it's assigned 3 on the next line
    three = 3     
}

Compile Errors:

/tmp/sandbox473116179/main.go:6: one declared and not used 
/tmp/sandbox473116179/main.go:7: two declared and not used 
/tmp/sandbox473116179/main.go:8: three declared and not used

Works:

package main
import "fmt"
func main() {  
    var one int
    _ = one
    two := 2 
    fmt.Println(two)
    var three int 
    three = 3
    one = three
    var four int
    four = four
}

另一個選擇是註釋掉或者移除未使用的變量 :-)

3. 未使用的 import

如果你引入一個包,而沒有使用其中的任何函數、接口、結構體或者變量的話,代碼將會編譯失敗。
你可以使用 goimports 來增加引入或者移除未使用的引用:

$ go get golang.org/x/tools/cmd/goimports

如果你真的需要引入的包,你可以添加一個下劃線標記符 _ ,來作爲這個包的名字,從而避免編譯失敗。下滑線標記符用於引入,但不使用。

package main
import (  
    "fmt"
    "log"
    "time"
)
func main() {  
}

Compile Errors:

/tmp/sandbox627475386/main.go:4: imported and not used: "fmt" 
/tmp/sandbox627475386/main.go:5: imported and not used: "log" 
/tmp/sandbox627475386/main.go:6: imported and not used: "time"

Works:

package main
import (  
    _ "fmt"
    "log"
    "time"
)
var _ = log.Println
func main() {  
    _ = time.Now
}

另一個選擇是移除或者註釋掉未使用的 import

4. 簡式的變量聲明僅可以在函數內部使用

Fails:

package main
myvar := 1 //error
func main() {  
}

Compile Error:

/tmp/sandbox265716165/main.go:3: non-declaration statement outside function body

Works:

package main
var myvar = 1
func main() {  
}

5. 使用簡式聲明重複聲明變量

你不能在一個單獨的聲明中重複聲明一個變量,但在多變量聲明中這是允許的,其中至少要有一個新的聲明變量。
重複變量需要在相同的代碼塊內,否則你將得到一個隱藏變量。
Fails:

package main
func main() {  
    one := 0
    one := 1 //error
}

Compile Error:

/tmp/sandbox706333626/main.go:5: no new variables on left side of :=

Works:

package main
func main() {  
    one := 0
    one, two := 1,2
    one,two = two,one
}

6. 偶然的變量隱藏 Accidental Variable Shadowing

短式變量聲明的語法如此的方便(尤其對於那些使用過動態語言的開發者而言),很容易讓人把它當成一個正常的分配操作。如果你在一個新的代碼塊中犯了這個錯誤,將不會出現編譯錯誤,但你的應用將不會做你所期望的事情。

package main
import "fmt"
func main() {  
    x := 1
    fmt.Println(x)     //prints 1
    {
        fmt.Println(x) //prints 1
        x := 2
        fmt.Println(x) //prints 2
    }
    fmt.Println(x)     //prints 1 (bad if you need 2)
}

即使對於經驗豐富的Go開發者而言,這也是一個非常常見的陷阱。這個坑很容易挖,但又很難發現。
你可以使用 vet 命令來發現一些這樣的問題。 默認情況下, vet不會執行這樣的檢查,你需要設置 -shadow參數:
go tool vet -shadow your_file.go

7. 不使用顯式類型,無法使用“nil”來初始化變量

nil 標誌符用於表示 interface 、函數、 mapssliceschannels 的“零值”。如果你不指定變量的類型,編譯器將無法編譯你的代碼,因爲它猜不出具體的類型。
Fails:

package main
func main() {  
    var x = nil //error
    _ = x
}

Compile Error:

/tmp/sandbox188239583/main.go:4: use of untyped nil

Works:

package main
func main() {  
    var x interface{} = nil
    _ = x
}

8. 使用“nil” Slices and Maps

在一個 nilslice 中添加元素是沒問題的,但對一個 map 做同樣的事將會生成一個運行時的 panic
Works:

package main
func main() {  
    var s []int
    s = append(s,1)
}

Fails:

package main
func main() {  
    var m map[string]int
    m["one"] = 1 //error
}

9. map的容量

你可以在 map 創建時指定它的容量,但你無法在 map 上使用 cap() 函數。
Fails:

package main
func main() {  
    m := make(map[string]int,99)
    cap(m) //error
}

Compile Error:

/tmp/sandbox326543983/main.go:5: invalid argument m (type map[string]int) for cap

10. 字符串不會爲nil

這對於經常使用 nil 分配字符串變量的開發者而言是個需要注意的地方。
Fails:

package main
func main() {  
    var x string = nil //error
    if x == nil { //error
        x = "default"
    }
}

Compile Errors:

/tmp/sandbox630560459/main.go:4: cannot use nil as type string in assignment /tmp/sandbox630560459/main.go:6: invalid operation: x == nil (mismatched types string and nil)

Works:

package main
func main() {  
    var x string //defaults to "" (zero value)
    if x == "" {
        x = "default"
    }
}

11. array 函數的參數

如果你是一個 C 或則 C++ 開發者,那麼數組對你而言就是指針當你向函數中傳遞數組時,函數會參照相同的內存區域,這樣它們就可以修改原始的數據

Go 中的數組是數值,因此當你向函數中傳遞數組時,函數會得到原始數組數據的一份複製。如果你打算更新數組的數據,這將會是個問題。

package main
import "fmt"
func main() {  
    x := [3]int{1,2,3}
    func(arr [3]int) {
        arr[0] = 7
        fmt.Println(arr) //prints [7 2 3]
    }(x)
    fmt.Println(x) //prints [1 2 3] (not ok if you need [7 2 3])
}

如果你需要更新原始數組的數據,你可以使用數組指針類型。

package main
import "fmt"
func main() {  
    x := [3]int{1,2,3}
    func(arr *[3]int) {
        (*arr)[0] = 7
        fmt.Println(arr) //prints &[7 2 3]
    }(&x)
    fmt.Println(x) //prints [7 2 3]
}

另一個選擇是使用 slice 。即使你的函數得到了 slice 變量的一份拷貝,它依舊會參照原始的數據。

package main
import "fmt"
func main() {  
    x := []int{1,2,3}
    func(arr []int) {
        arr[0] = 7
        fmt.Println(arr) //prints [7 2 3]
    }(x)
    fmt.Println(x) //prints [7 2 3]
}

12. 在 slice 和 array 使用“range”語句時的出現的不希望得到的值

如果你在其他的語言中使用 for-in 或者 foreach 語句時會發生這種情況。 Go 中的 range 語法不太一樣。它會得到兩個值:第一個值是元素的索引,而另一個值是元素的數據。
Bad:

package main
import "fmt"
func main() {  
    x := []string{"a","b","c"}
    for v := range x {
        fmt.Println(v) //prints 0, 1, 2
    }
}

Good:

package main
import "fmt"
func main() {  
    x := []string{"a","b","c"}
    for _, v := range x {
        fmt.Println(v) //prints a, b, c
    }
}

13. slices 和 arrays 是一維的

看起來 Go 好像支持多維的 ArraySlice ,但不是這樣的。儘管可以創建數組的數組或者切片的切片。對於依賴於動態多維數組的數值計算應用而言, Go 在性能和複雜度上還相距甚遠。

你可以使用純一維數組、“獨立”切片的切片,“共享數據”切片的切片來構建動態的多維數組。
如果你使用純一維的數組,你需要處理索引、邊界檢查、當數組需要變大時的內存重新分配。

使用“獨立” slice 來創建一個動態的多維數組需要兩步。首先,你需要創建一個外部的 slice 。然後,你需要分配每個內部的 slice 。內部的 slice 相互之間獨立。你可以增加減少它們,而不會影響其他內部的 slice

package main
func main() {  
    x := 2
    y := 4
    table := make([][]int,x)
    for i:= range table {
        table[i] = make([]int,y)
    }
}

使用“共享數據” sliceslice 來創建一個動態的多維數組需要三步。首先,你需要創建一個用於存放原始數據的數據“容器”。然後,你再創建外部的 slice 。最後,通過重新切片原始數據 slice 來初始化各個內部的 slice

package main
import "fmt"
func main() {  
    h, w := 2, 4
    raw := make([]int,h*w)
    for i := range raw {
        raw[i] = i
    }
    fmt.Println(raw,&raw[4])
    //prints: [0 1 2 3 4 5 6 7] <ptr_addr_x>
    table := make([][]int,h)
    for i:= range table {
        table[i] = raw[i*w:i*w + w]
    }
    fmt.Println(table,&table[1][0])
    //prints: [[0 1 2 3] [4 5 6 7]] <ptr_addr_x>
}

關於多維 arrayslice 已經有了專門申請,但現在看起來這是個低優先級的特性。

14. 訪問不存在的 map keys

這對於那些希望得到 nil 標示符的開發者而言是個技巧(和其他語言中做的一樣)。如果對應的數據類型的“零值”是 nil ,那返回的值將會是 nil ,但對於其他的數據類型是不一樣的。檢測對應的“零值”可以用於確定 map 中的記錄是否存在,但這並不總是可信(比如,如果在二值的 map 中“零值”是 false ,這時你要怎麼做)。檢測給定 map 中的記錄是否存在的最可信的方法是,通過 map 的訪問操作,檢查第二個返回的值。
Bad:

package main
import "fmt"
func main() {  
    x := map[string]string{"one":"a","two":"","three":"c"}
    if v := x["two"]; v == "" { //incorrect
        fmt.Println("no entry")
    }
}

Good:

package main
import "fmt"
func main() {  
    x := map[string]string{"one":"a","two":"","three":"c"}
    if _,ok := x["two"]; !ok {
        fmt.Println("no entry")
    }
}

15. Strings 無法修改

嘗試使用索引操作來更新字符串變量中的單個字符將會失敗。 string 是隻讀的 byte slice (和一些額外的屬性)。如果你確實需要更新一個字符串,那麼使用 byte slice ,並在需要時把它轉換爲 string 類型。
Fails:

package main
import "fmt"
func main() {  
    x := "text"
    x[0] = 'T'
    fmt.Println(x)
}

Compile Error:

/tmp/sandbox305565531/main.go:7: cannot assign to x[0]

Works:

package main
import "fmt"
func main() {  
    x := "text"
    xbytes := []byte(x)
    xbytes[0] = 'T'
    fmt.Println(string(xbytes)) //prints Text
}

需要注意的是:這並不是在文字 string 中更新字符的正確方式,因爲給定的字符可能會存儲在多個 byte 中。如果你確實需要更新一個文字 string ,先把它轉換爲一個 rune slice
即使使用 rune slice ,單個字符也可能會佔據多個 rune ,比如當你的字符有特定的重音符號時就是這種情況。這種複雜又模糊的“字符”本質是 Go 字符串使用 byte 序列表示的原因。

16. String 和 Byte Slice之間的轉換

當你把一個字符串轉換爲一個 byte slice(或者反之)時,你就得到了一個原始數據的完整拷貝。這和其他語言中 cast 操作不同,也和新的 slice變量指向原始 byteslice使用的相同數組時的重新slice操作不同。

Go[]bytestringstring[]byte的轉換中確實使用了一些優化來避免額外的分配。

  • 第一個優化避免了當 []bytekeys用於在 map[string]集合中查詢時的額外分配: m[string(key)]
  • 第二個優化避免了字符串轉換爲 []byte後在 for range語句中的額外分配: for i,v := range []byte(str) {...}

17. String 和索引操作

字符串上的索引操作返回一個 byte 值,而不是一個字符(和其他語言中的做法一樣)。

package main
import "fmt"
func main() {  
    x := "text"
    fmt.Println(x[0]) //print 116
    fmt.Printf("%T",x[0]) //prints uint8
}

如果你需要訪問特定的字符串“字符”(unicode編碼的points/runes),使用for range。官方的“unicode/utf8”包和實驗中的utf8string包(golang.org/x/exp/utf8string)也可以用。utf8string包中包含了一個很方便的At()方法。把字符串轉換爲rune的切片也是一個選項。

18. 字符串不總是 UTF8 文本

字符串的值不需要是 UTF8 的文本。它們可以包含任意的字節。只有在 string literal 使用時,字符串纔會是 UTF8 。即使之後它們可以使用轉義序列來包含其他的數據。
爲了知道字符串是否是 UTF8 ,你可以使用 unicode/utf8 包中的 ValidString() 函數。

package main
import (  
    "fmt"
    "unicode/utf8"
)
func main() {  
    data1 := "ABC"
    fmt.Println(utf8.ValidString(data1)) //prints: true
    data2 := "A\xfeC"
    fmt.Println(utf8.ValidString(data2)) //prints: false
}

19. 字符串的長度

讓我們假設你是 Python 開發者,你有下面這段代碼:

data = u'♥'  
print(len(data)) #prints: 1

當把它轉換爲 Go 代碼時,你可能會大喫一驚。

package main
import "fmt"
func main() {  
    data := "♥"
    fmt.Println(len(data)) //prints: 3
}

內建的 len()函數返回 byte 的數量,而不是像 Python 中計算好的 unicode 字符串中字符的數量。
要在 Go 中得到相同的結果,可以使用 unicode/utf8 包中的 RuneCountInString()函數。

package main
import (  
    "fmt"
    "unicode/utf8"
)
func main() {  
    data := "♥"
    fmt.Println(utf8.RuneCountInString(data)) //prints: 1
}

理論上說 RuneCountInString()函數並不返回字符的數量,因爲單個字符可能佔用多個 rune

package main
import (  
    "fmt"
    "unicode/utf8"
)
func main() {  
    data := "é"
    fmt.Println(len(data))                    //prints: 3
    fmt.Println(utf8.RuneCountInString(data)) //prints: 2
}

20. 在多行的 Slice、Array 和 Map 語句中遺漏逗號

Fails:

package main
func main() {  
    x := []int{
,
 //error
    }
    _ = x
}

Compile Errors:

/tmp/sandbox367520156/main.go:6: syntax error: need trailing comma before newline in composite literal /tmp/sandbox367520156/main.go:8: non-declaration statement outside function body /tmp/sandbox367520156/main.go:9: syntax error: unexpected }

Works:

package main
func main() {  
    x := []int{
,
,
    }
    x = x
    y := []int{3,4,} //no error
    y = y
}

當你把聲明摺疊到單行時,如果你沒加末尾的逗號,你將不會得到編譯錯誤。

21. log.Fatal 和 log.Panic 不僅僅是 Log

logging 庫一般提供不同的 log 等級。與這些 logging 庫不同, Golog 包在你調用它的 Fatal*()Panic*()函數時,可以做的不僅僅是 log 。當你的應用調用這些函數時, Go 也將會終止應用 😃

package main
import "log"
func main() {  
    log.Fatalln("Fatal Level: log entry") //app exits here
    log.Println("Normal Level: log entry")
}

22. 內建的數據結構操作不是同步的

即使 Go 本身有很多特性來支持併發,併發安全的數據集合並不是其中之一 :-)確保數據集合以原子的方式更新是你的職責。 goroutineschannels 是實現這些原子操作的推薦方式,但你也可以使用 sync 包,如果它對你的應用有意義的話。

23. String在“range”語句中的迭代值

索引值( range 操作返回的第一個值)是返回的第二個值的當前“字符”( unicode 編碼的 point/rune )的第一個 byte 的索引。它不是當前“字符”的索引,這與其他語言不同。注意真實的字符可能會由多個 rune 表示。

如果你需要處理字符,確保你使用了“norm”包(golang.org/x/text/unicode/norm)。
string 變量的 for range語句將會嘗試把數據翻譯爲 UTF8 文本。對於它無法理解的任何 byte 序列,它將返回0xfffd runes(即 unicode 替換字符),而不是真實的數據。如果你任意(非 UTF8 文本)的數據保存在 string 變量中,確保把它們轉換爲 byte slice ,以得到所有保存的數據。

package main
import "fmt"
func main() {  
    data := "A\xfe\x02\xff\x04"
    for _,v := range data {
        fmt.Printf("%#x ",v)
    }
    //prints: 0x41 0xfffd 0x2 0xfffd 0x4 (not ok)
    fmt.Println()
    for _,v := range []byte(data) {
        fmt.Printf("%#x ",v)
    }
    //prints: 0x41 0xfe 0x2 0xff 0x4 (good)
}

24. 對Map使用“for range”語句迭代

如果你希望以某個順序(比如,按key值排序)的方式得到元素,就需要這個技巧。每次的 map 迭代將會生成不同的結果。 Goruntime 有心嘗試隨機化迭代順序,但並不總會成功,這樣你可能得到一些相同的 map 迭代結果。所以如果連續看到 5 個相同的迭代結果,不要驚訝。

package main
import "fmt"
func main() {  
    m := map[string]int{"one":1,"two":2,"three":3,"four":4}
    for k,v := range m {
        fmt.Println(k,v)
    }
}

25. "switch"聲明中的失效行爲

switch 聲明語句中的 case 語句塊在默認情況下會 break 。這和其他語言中的進入下一個“next”代碼塊的默認行爲不同。

package main
import "fmt"
func main() {  
    isSpace := func(ch byte) bool {
        switch(ch) {
        case ' ': //error
        case '\t':
            return true
        }
        return false
    }
    fmt.Println(isSpace('\t')) //prints true (ok)
    fmt.Println(isSpace(' '))  //prints false (not ok)
}

你可以通過在每個 case 塊的結尾使用 fallthrough ,來強制 case 代碼塊進入。你也可以重寫 switch 語句,來使用 case 塊中的表達式列表。

package main
import "fmt"
func main() {  
    isSpace := func(ch byte) bool {
        switch(ch) {
        case ' ', '\t':
            return true
        }
        return false
    }
    fmt.Println(isSpace('\t')) //prints true (ok)
    fmt.Println(isSpace(' '))  //prints true (ok)
}

26. 自增和自減

許多語言都有自增和自減操作。不像其他語言, Go 不支持前置版本的操作。你也無法在表達式中使用這兩個操作符。
Fails:

package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    i := 0
    ++i //error
    fmt.Println(data[i++]) //error
}

Compile Errors:

/tmp/sandbox101231828/main.go:8: syntax error: unexpected ++ /tmp/sandbox101231828/main.go:9: syntax error: unexpected ++, expecting :

Works:

package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    i := 0
    i++
    fmt.Println(data[i])
}

27. 按位NOT操作

許多語言使用 ~作爲一元的 NOT 操作符(即按位補足),但 Go 爲了這個重用了XOR操作符 ^
Fails:

package main
import "fmt"
func main() {  
    fmt.Println(~2) //error
}

Compile Error:

/tmp/sandbox965529189/main.go:6: the bitwise complement operator is ^

Works:

package main
import "fmt"
func main() {  
    var d uint8 = 2
    fmt.Printf("%08b\n",^d)
}

Go 依舊使用 ^作爲 XOR 的操作符,這可能會讓一些人迷惑。

如果你願意,你可以使用一個二元的 XOR 操作(如, 0x02 XOR 0xff)來表示一個一元的 NOT 操作(如,NOT 0x02)。這可以解釋爲什麼 ^被重用來表示一元的 NOT 操作。

Go 也有特殊的 AND NOT 按位操作( &^),這也讓 NOT 操作更加的讓人迷惑。這看起來需要特殊的特性/hack來支持 A AND (NOT B),而無需括號。

package main
import "fmt"
func main() {  
    var a uint8 = 0x82
    var b uint8 = 0x02
    fmt.Printf("%08b [A]\n",a)
    fmt.Printf("%08b [B]\n",b)
    fmt.Printf("%08b (NOT B)\n",^b)
    fmt.Printf("%08b ^ %08b = %08b [B XOR 0xff]\n",b,0xff,b ^ 0xff)
    fmt.Printf("%08b ^ %08b = %08b [A XOR B]\n",a,b,a ^ b)
    fmt.Printf("%08b & %08b = %08b [A AND B]\n",a,b,a & b)
    fmt.Printf("%08b &^%08b = %08b [A 'AND NOT' B]\n",a,b,a &^ b)
    fmt.Printf("%08b&(^%08b)= %08b [A AND (NOT B)]\n",a,b,a & (^b))
}

28. 操作優先級的差異

除了”bit clear“操作( &^), Go 也一個與許多其他語言共享的標準操作符的集合。儘管操作優先級並不總是一樣。

package main
import "fmt"
func main() {  
    fmt.Printf("0x2 & 0x2 + 0x4 -> %#x\n",0x2 & 0x2 + 0x4)
    //prints: 0x2 & 0x2 + 0x4 -> 0x6
    //Go:    (0x2 & 0x2) + 0x4
    //C++:    0x2 & (0x2 + 0x4) -> 0x2
    fmt.Printf("0x2 + 0x2 << 0x1 -> %#x\n",0x2 + 0x2 << 0x1)
    //prints: 0x2 + 0x2 << 0x1 -> 0x6
    //Go:     0x2 + (0x2 << 0x1)
    //C++:   (0x2 + 0x2) << 0x1 -> 0x8
    fmt.Printf("0xf | 0x2 ^ 0x2 -> %#x\n",0xf | 0x2 ^ 0x2)
    //prints: 0xf | 0x2 ^ 0x2 -> 0xd
    //Go:    (0xf | 0x2) ^ 0x2
    //C++:    0xf | (0x2 ^ 0x2) -> 0xf
}

29. 未導出的結構體不會被編碼

以小寫字母開頭的結構體將不會被( jsonxmlgob 等)編碼,因此當你編碼這些未導出的結構體時,你將會得到零值。
Fails:

package main
import (  
    "fmt"
    "encoding/json"
)
type MyData struct {  
    One int
    two string
}
func main() {  
    in := MyData{1,"two"}
    fmt.Printf("%#v\n",in) //prints main.MyData{One:1, two:"two"}
    encoded,_ := json.Marshal(in)
    fmt.Println(string(encoded)) //prints {"One":1}
    var out MyData
    json.Unmarshal(encoded,&out)
    fmt.Printf("%#v\n",out) //prints main.MyData{One:1, two:""}
}

30. 有活動的Goroutines下的應用退出

應用將不會等待所有的 goroutines 完成。這對於初學者而言是個很常見的錯誤。每個人都是以某個程度開始,因此如果犯了初學者的錯誤也沒神馬好丟臉的 😃

package main
import (  
    "fmt"
    "time"
)
func main() {  
    workerCount := 2
    for i := 0; i < workerCount; i++ {
        go doit(i)
    }
    time.Sleep(1 * time.Second)
    fmt.Println("all done!")
}
func doit(workerId int) {  
    fmt.Printf("[%v] is running\n",workerId)
    time.Sleep(3 * time.Second)
    fmt.Printf("[%v] is done\n",workerId)
}

你將會看到:

[0] is running 
[1] is running 
all done!

一個最常見的解決方法是使用 WaitGroup 變量。它將會讓主 goroutine 等待所有的 worker goroutine 完成。
如果你的應用有長時運行的消息處理循環的 worker,你也將需要一個方法向這些 goroutine 發送信號,讓它們退出。你可以給各個 worker 發送一個 kill 消息。另一個選項是關閉一個所有 worker 都接收的 channel 。這是一次向所有 goroutine 發送信號的簡單方式。

package main
import (  
    "fmt"
    "sync"
)
func main() {  
    var wg sync.WaitGroup
    done := make(chan struct{})
    workerCount := 2
    for i := 0; i < workerCount; i++ {
        wg.Add(1)
        go doit(i,done,wg)
    }
    close(done)
    wg.Wait()
    fmt.Println("all done!")
}
func doit(workerId int,done <-chan struct{},wg sync.WaitGroup) {  
    fmt.Printf("[%v] is running\n",workerId)
    defer wg.Done()
    <- done
    fmt.Printf("[%v] is done\n",workerId)
}

如果你運行這個應用,你將會看到:

[0] is running 
[0] is done 
[1] is running 
[1] is done

看起來所有的 worker 在主 goroutine 退出前都完成了。棒!然而,你也將會看到這個:

fatal error: all goroutines are asleep - deadlock!

這可不太好 😃 發送了神馬?爲什麼會出現死鎖?worker退出了,它們也執行了 wg.Done()。應用應該沒問題啊。
死鎖發生是因爲各個 worker 都得到了原始的 WaitGroup 變量的一個拷貝。當 worker 執行 wg.Done()時,並沒有在主 goroutine 上的 WaitGroup 變量上生效。

package main
import (  
    "fmt"
    "sync"
)
func main() {  
    var wg sync.WaitGroup
    done := make(chan struct{})
    wq := make(chan interface{})
    workerCount := 2
    for i := 0; i < workerCount; i++ {
        wg.Add(1)
        go doit(i,wq,done,&wg)
    }
    for i := 0; i < workerCount; i++ {
        wq <- i
    }
    close(done)
    wg.Wait()
    fmt.Println("all done!")
}
func doit(workerId int, wq <-chan interface{},done <-chan struct{},wg *sync.WaitGroup) {  
    fmt.Printf("[%v] is running\n",workerId)
    defer wg.Done()
    for {
        select {
        case m := <- wq:
            fmt.Printf("[%v] m => %v\n",workerId,m)
        case <- done:
            fmt.Printf("[%v] is done\n",workerId)
            return
        }
    }
}

現在它會如預期般工作 😃

31. 向無緩存的Channel發送消息,只要目標接收者準備好就會立即返回

發送者將不會被阻塞,除非消息正在被接收者處理。根據你運行代碼的機器的不同,接收者的 goroutine 可能會或者不會有足夠的時間,在發送者繼續執行前處理消息。

package main
import "fmt"
func main() {  
    ch := make(chan string)
    go func() {
        for m := range ch {
            fmt.Println("processed:",m)
        }
    }()
    ch <- "cmd.1"
    ch <- "cmd.2" //won't be processed
}

32. 向已關閉的Channel發送會引起Panic

從一個關閉的 channel 接收是安全的。在接收狀態下的 ok的返回值將被設置爲 false,這意味着沒有數據被接收。如果你從一個有緩存的 channel 接收,你將會首先得到緩存的數據,一旦它爲空,返回的 ok值將變爲 false
向關閉的 channel 中發送數據會引起 panic 。這個行爲有文檔說明,但對於新的 Go 開發者的直覺不同,他們可能希望發送行爲與接收行爲很像。

package main
import (  
    "fmt"
    "time"
)
func main() {  
    ch := make(chan int)
    for i := 0; i < 3; i++ {
        go func(idx int) {
            ch <- (idx + 1) * 2
        }(i)
    }
    
    //get the first result
    fmt.Println(<-ch)
    close(ch) //not ok (you still have other senders)
    //do other work
    time.Sleep(2 * time.Second)
}

根據不同的應用,修復方法也將不同。可能是很小的代碼修改,也可能需要修改應用的設計。無論是哪種方法,你都需要確保你的應用不會向關閉的 channel 中發送數據。
上面那個有 bug 的例子可以通過使用一個特殊的廢棄的 channel 來向剩餘的 worker 發送不再需要它們的結果的信號來修復。

package main
import (  
    "fmt"
    "time"
)
func main() {  
    ch := make(chan int)
    done := make(chan struct{})
    for i := 0; i < 3; i++ {
        go func(idx int) {
            select {
            case ch <- (idx + 1) * 2: fmt.Println(idx,"sent result")
            case <- done: fmt.Println(idx,"exiting")
            }
        }(i)
    }
    //get first result
    fmt.Println("result:",<-ch)
    close(done)
    //do other work
    time.Sleep(3 * time.Second)
}

33. 使用"nil" Channels

在一個 nilchannel上 發送和接收操作會被永久阻塞。這個行爲有詳細的文檔解釋,但它對於新的 Go 開發者而言是個驚喜。

package main
import (  
    "fmt"
    "time"
)
func main() {  
    var ch chan int
    for i := 0; i < 3; i++ {
        go func(idx int) {
            ch <- (idx + 1) * 2
        }(i)
    }
    //get first result
    fmt.Println("result:",<-ch)
    //do other work
    time.Sleep(2 * time.Second)
}

如果運行代碼你將會看到一個runtime錯誤:

fatal error: all goroutines are asleep - deadlock!

這個行爲可以在 select聲明中用於動態開啓和關閉 case代碼塊的方法。

package main
import "fmt"  
import "time"
func main() {  
    inch := make(chan int)
    outch := make(chan int)
    go func() {
        var in <- chan int = inch
        var out chan <- int
        var val int
        for {
           select {
            case out <- val:
                out = nil
                in = inch
            case val = <- in:
                out = outch
                in = nil
            }
        }
    }()
    go func() {
        for r := range outch {
            fmt.Println("result:",r)
        }
    }()
    time.Sleep(0)
    inch <- 1
    inch <- 2
    time.Sleep(3 * time.Second)
}

34. 傳值方法的接收者無法修改原有的值

方法的接收者就像常規的函數參數。如果聲明爲值,那麼你的函數/方法得到的是接收者參數的拷貝。這意味着對接收者所做的修改將不會影響原有的值,除非接收者是一個 map 或者 slice 變量,而你更新了集合中的元素,或者你更新的域的接收者是指針。

package main
import "fmt"
type data struct {  
    num int
    key *string
    items map[string]bool
}
func (this *data) pmethod() {  
    this.num = 7
}
func (this data) vmethod() {  
    this.num = 8
    *this.key = "v.key"
    this.items["vmethod"] = true
}
func main() {  
    key := "key.1"
    d := data{1,&key,make(map[string]bool)}
    fmt.Printf("num=%v key=%v items=%v\n",d.num,*d.key,d.items)
    //prints num=1 key=key.1 items=map[]
    d.pmethod()
    fmt.Printf("num=%v key=%v items=%v\n",d.num,*d.key,d.items) 
    //prints num=7 key=key.1 items=map[]
    d.vmethod()
    fmt.Printf("num=%v key=%v items=%v\n",d.num,*d.key,d.items)
    //prints num=7 key=v.key items=map[vmethod:true]
}

二. 中級篇

35. 關閉HTTP的響應

當你使用標準 http 庫發起請求時,你得到一個 http 的響應變量。如果你不讀取響應主體,你依舊需要關閉它。注意對於空的響應你也一定要這麼做。對於新的 Go 開發者而言,這個很容易就會忘掉。
一些新的 Go 開發者確實嘗試關閉響應主體,但他們在錯誤的地方做。

package main
import (  
    "fmt"
    "net/http"
    "io/ioutil"
)
func main() {  
    resp, err := http.Get("https://api.ipify.org?format=json")
    defer resp.Body.Close()//not ok
    if err != nil {
        fmt.Println(err)
        return
    }
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(string(body))
}

這段代碼對於成功的請求沒問題,但如果 http 的請求失敗, resp變量可能會是 nil,這將導致一個 runtime panic
最常見的關閉響應主體的方法是在 http 響應的錯誤檢查後調用 defer

package main
import (  
    "fmt"
    "net/http"
    "io/ioutil"
)
func main() {  
    resp, err := http.Get("https://api.ipify.org?format=json")
    if err != nil {
        fmt.Println(err)
        return
    }
    defer resp.Body.Close()//ok, most of the time :-)
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(string(body))
}

大多數情況下,當你的 http 響應失敗時, resp變量將爲 nil,而 err變量將是 non-nil。然而,當你得到一個重定向的錯誤時,兩個變量都將是 non-nil。這意味着你最後依然會內存泄露。
通過在 http 響應錯誤處理中添加一個關閉 non-nil響應主體的的調用來修復這個問題。另一個方法是使用一個 defer調用來關閉所有失敗和成功的請求的響應主體。

package main
import (  
    "fmt"
    "net/http"
    "io/ioutil"
)
func main() {  
    resp, err := http.Get("https://api.ipify.org?format=json")
    if resp != nil {
        defer resp.Body.Close()
    }
    if err != nil {
        fmt.Println(err)
        return
    }
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(string(body))
}

resp.Body.Close()的原始實現也會讀取並丟棄剩餘的響應主體數據。這確保了 http 的鏈接在 keepalive http 連接行爲開啓的情況下,可以被另一個請求複用。
最新的 http 客戶端的行爲是不同的。現在讀取並丟棄剩餘的響應數據是你的職責。如果你不這麼做,http的連接可能會關閉,而無法被重用。這個小技巧應該會寫在Go 1.5的文檔中。
如果 http 連接的重用對你的應用很重要,你可能需要在響應處理邏輯的後面添加像下面的代碼:

_, err = io.Copy(ioutil.Discard, resp.Body)

如果你不立即讀取整個響應將是必要的,這可能在你處理 json API響應時會發生:

json.NewDecoder(resp.Body).Decode(&data;)

36. 關閉HTTP的連接

一些 HTTP 服務器保持會保持一段時間的網絡連接(根據HTTP 1.1的說明和服務器端的“keep-alive”配置)。默認情況下,標準 http 庫只在目標 HTTP 服務器要求關閉時纔會關閉網絡連接。這意味着你的應用在某些條件下消耗完sockets/file的描述符。
你可以通過設置請求變量中的 Close域的值爲 true,來讓 http 庫在請求完成時關閉連接。
另一個選項是添加一個 Connection的請求頭,並設置爲 close。目標HTTP服務器應該也會響應一個 Connection: close的頭。當 http 庫看到這個響應頭時,它也將會關閉連接。

package main
import (  
    "fmt"
    "net/http"
    "io/ioutil"
)
func main() {  
    req, err := http.NewRequest("GET","http://golang.org",nil)
    if err != nil {
        fmt.Println(err)
        return
    }
    req.Close = true
    //or do this:
    //req.Header.Add("Connection", "close")
    resp, err := http.DefaultClient.Do(req)
    if resp != nil {
        defer resp.Body.Close()
    }
    if err != nil {
        fmt.Println(err)
        return
    }
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(len(string(body)))
}

你也可以取消 http 的全局連接複用。你將需要爲此創建一個自定義的 http 傳輸配置。

package main
import (  
    "fmt"
    "net/http"
    "io/ioutil"
)
func main() {  
    tr := &http.Transport{DisableKeepAlives: true}
    client := &http.Client{Transport: tr}
    resp, err := client.Get("http://golang.org")
    if resp != nil {
        defer resp.Body.Close()
    }
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(resp.StatusCode)
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(len(string(body)))
}

如果你向同一個 HTTP 服務器發送大量的請求,那麼把保持網絡連接的打開是沒問題的。然而,如果你的應用在短時間內向大量不同的 HTTP 服務器發送一兩個請求,那麼在引用收到響應後立刻關閉網絡連接是一個好主意。增加打開文件的限制數可能也是個好主意。當然,正確的選擇源自於應用。

37. 比較Structs, Arrays, Slices, and Maps

如果結構體中的各個元素都可以用你可以使用等號來比較的話,那就可以使用相等號 == ,來比較結構體變量。

package main
import "fmt"
type data struct {  
    num int
    fp float32
    complex complex64
    str string
    char rune
    yes bool
    events <-chan string
    handler interface{}
    ref *byte
    raw [10]byte
}
func main() {  
    v1 := data{}
    v2 := data{}
    fmt.Println("v1 == v2:",v1 == v2) //prints: v1 == v2: true
}

如果結構體中的元素無法比較,那使用等號將導致編譯錯誤。注意數組僅在它們的數據元素可比較的情況下才可以比較。

package main
import "fmt"
type data struct {  
    num int                //ok
    checks [10]func() bool //not comparable
    doit func() bool       //not comparable
    m map[string] string   //not comparable
    bytes []byte           //not comparable
}
func main() {  
    v1 := data{}
    v2 := data{}
    fmt.Println("v1 == v2:",v1 == v2)
}

Go 確實提供了一些助手函數,用於比較那些無法使用等號比較的變量。
最常用的方法是使用 reflect 包中的 DeepEqual()函數。

package main
import (  
    "fmt"
    "reflect"
)
type data struct {  
    num int                //ok
    checks [10]func() bool //not comparable
    doit func() bool       //not comparable
    m map[string] string   //not comparable
    bytes []byte           //not comparable
}
func main() {  
    v1 := data{}
    v2 := data{}
    fmt.Println("v1 == v2:",reflect.DeepEqual(v1,v2)) //prints: v1 == v2: true
    m1 := map[string]string{"one": "a","two": "b"}
    m2 := map[string]string{"two": "b", "one": "a"}
    fmt.Println("m1 == m2:",reflect.DeepEqual(m1, m2)) //prints: m1 == m2: true
    s1 := []int{1, 2, 3}
    s2 := []int{1, 2, 3}
    fmt.Println("s1 == s2:",reflect.DeepEqual(s1, s2)) //prints: s1 == s2: true
}

除了很慢(這個可能會也可能不會影響你的應用), DeepEqual()也有其他自身的技巧。

package main
import (  
    "fmt"
    "reflect"
)
func main() {  
    var b1 []byte = nil
    b2 := []byte{}
    fmt.Println("b1 == b2:",reflect.DeepEqual(b1, b2)) //prints: b1 == b2: false
}

DeepEqual()不會認爲空的 slicenilslice相等。這個行爲與你使用 bytes.Equal()函數的行爲不同。 bytes.Equal()認爲 nil 和空的 slice 是相等的。

package main
import (  
    "fmt"
    "bytes"
)
func main() {  
    var b1 []byte = nil
    b2 := []byte{}
    fmt.Println("b1 == b2:",bytes.Equal(b1, b2)) //prints: b1 == b2: true
}

DeepEqual()在比較 slice 時並不總是完美的。

package main
import (  
    "fmt"
    "reflect"
    "encoding/json"
)
func main() {  
    var str string = "one"
    var in interface{} = "one"
    fmt.Println("str == in:",str == in,reflect.DeepEqual(str, in)) 
    //prints: str == in: true true
    v1 := []string{"one","two"}
    v2 := []interface{}{"one","two"}
    fmt.Println("v1 == v2:",reflect.DeepEqual(v1, v2)) 
    //prints: v1 == v2: false (not ok)
    data := map[string]interface{}{
        "code": 200,
        "value": []string{"one","two"},
    }
    encoded, _ := json.Marshal(data)
    var decoded map[string]interface{}
    json.Unmarshal(encoded, &decoded)
    fmt.Println("data == decoded:",reflect.DeepEqual(data, decoded)) 
    //prints: data == decoded: false (not ok)
}

如果你的 byte slice(或者字符串)中包含文字數據,而當你要不區分大小寫形式的值時(在使用 ==bytes.Equal(),或者 bytes.Compare()),你可能會嘗試使用 bytesstring 包中的 ToUpper()或者 ToLower()函數。對於英語文本,這麼做是沒問題的,但對於許多其他的語言來說就不行了。這時應該使用 strings.EqualFold()bytes.EqualFold()
如果你的byte slice中包含需要驗證用戶數據的隱私信息(比如,加密哈希、tokens等),不要使用 reflect.DeepEqual()bytes.Equal(),或者 bytes.Compare(),因爲這些函數將會讓你的應用易於被定時攻擊。爲了避免泄露時間信息,使用’crypto/subtle’包中的函數(即, subtle.ConstantTimeCompare())。

38. 從Panic中恢復

recover()函數可以用於獲取/攔截 panic。僅當在一個 defer函數中被完成時,調用 recover()將會完成這個小技巧。
Incorrect:

package main
import "fmt"
func main() {  
    recover() //doesn't do anything
    panic("not good")
    recover() //won't be executed :)
    fmt.Println("ok")
}

Works:

package main
import "fmt"
func main() {  
    defer func() {
        fmt.Println("recovered:",recover())
    }()
    panic("not good")
}

recover()的調用僅當它在 defer函數中被直接調用時纔有效。
Fails:

package main
import "fmt"
func doRecover() {  
    fmt.Println("recovered =>",recover()) //prints: recovered => <nil>
}
func main() {  
    defer func() {
        doRecover() //panic is not recovered
    }()
    panic("not good")
}

39. 在Slice, Array, and Map "range"語句中更新引用元素的值

range 語句中生成的數據的值是真實集合元素的拷貝。它們不是原有元素的引用。
這意味着更新這些值將不會修改原來的數據。同時也意味着使用這些值的地址將不會得到原有數據的指針。

package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    for _,v := range data {
        v *= 10 //original item is not changed
    }
    fmt.Println("data:",data) //prints data: [1 2 3]
}

如果你需要更新原有集合中的數據,使用索引操作符來獲得數據。

package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    for i,_ := range data {
        data[i] *= 10
    }
    fmt.Println("data:",data) //prints data: [10 20 30]
}

如果你的集合保存的是指針,那規則會稍有不同。
如果要更新原有記錄指向的數據,你依然需要使用索引操作,但你可以使用 for range 語句中的第二個值來更新存儲在目標位置的數據。

package main
import "fmt"
func main() {  
    data := []*struct{num int} { {1},{2},{3} }
    for _,v := range data {
        v.num *= 10
    }
    fmt.Println(data[0],data[1],data[2]) //prints &{10} &{20} &{30}
}

40. 在Slice中"隱藏"數據

當你重新劃分一個 slice 時,新的 slice 將引用原有 slice 的數組。如果你忘了這個行爲的話,在你的應用分配大量臨時的 slice 用於創建新的 slice 來引用原有數據的一小部分時,會導致難以預期的內存使用。

package main
import "fmt"
func get() []byte {  
    raw := make([]byte,10000)
    fmt.Println(len(raw),cap(raw),&raw[0]) //prints: 10000 10000 <byte_addr_x>
    return raw[:3]
}
func main() {  
    data := get()
    fmt.Println(len(data),cap(data),&data[0]) //prints: 3 10000 <byte_addr_x>
}

爲了避免這個陷阱,你需要從臨時的 slice 中拷貝數據(而不是重新劃分 slice )。

package main
import "fmt"
func get() []byte {  
    raw := make([]byte,10000)
    fmt.Println(len(raw),cap(raw),&raw[0]) //prints: 10000 10000 <byte_addr_x>
    res := make([]byte,3)
    copy(res,raw[:3])
    return res
}
func main() {  
    data := get()
    fmt.Println(len(data),cap(data),&data[0]) //prints: 3 3 <byte_addr_y>
}

41. Slice的數據“毀壞”

比如說你需要重新一個路徑(在 slice 中保存)。你通過修改第一個文件夾的名字,然後把名字合併來創建新的路勁,來重新劃分指向各個文件夾的路徑。

package main
import (  
    "fmt"
    "bytes"
)
func main() {  
    path := []byte("AAAA/BBBBBBBBB")
    sepIndex := bytes.IndexByte(path,'/')
    dir1 := path[:sepIndex]
    dir2 := path[sepIndex+1:]
    fmt.Println("dir1 =>",string(dir1)) //prints: dir1 => AAAA
    fmt.Println("dir2 =>",string(dir2)) //prints: dir2 => BBBBBBBBB
    dir1 = append(dir1,"suffix"...)
    path = bytes.Join([][]byte{dir1,dir2},[]byte{'/'})
    fmt.Println("dir1 =>",string(dir1)) //prints: dir1 => AAAAsuffix
    fmt.Println("dir2 =>",string(dir2)) //prints: dir2 => uffixBBBB (not ok)
    fmt.Println("new path =>",string(path))
}

結果與你想的不一樣。與"AAAAsuffix/BBBBBBBBB"相反,你將會得到"AAAAsuffix/uffixBBBB"。這個情況的發生是因爲兩個文件夾的 slice 都潛在的引用了同一個原始的路徑 slice 。這意味着原始路徑也被修改了。根據你的應用,這也許會是個問題。
通過分配新的 slice 並拷貝需要的數據,你可以修復這個問題。另一個選擇是使用完整的 slice 表達式。

package main
import (  
    "fmt"
    "bytes"
)
func main() {  
    path := []byte("AAAA/BBBBBBBBB")
    sepIndex := bytes.IndexByte(path,'/')
    dir1 := path[:sepIndex:sepIndex] //full slice expression
    dir2 := path[sepIndex+1:]
    fmt.Println("dir1 =>",string(dir1)) //prints: dir1 => AAAA
    fmt.Println("dir2 =>",string(dir2)) //prints: dir2 => BBBBBBBBB
    dir1 = append(dir1,"suffix"...)
    path = bytes.Join([][]byte{dir1,dir2},[]byte{'/'})
    fmt.Println("dir1 =>",string(dir1)) //prints: dir1 => AAAAsuffix
    fmt.Println("dir2 =>",string(dir2)) //prints: dir2 => BBBBBBBBB (ok now)
    fmt.Println("new path =>",string(path))
}

完整的 slice 表達式中的額外參數可以控制新的 slice 的容量。現在在那個 slice 後添加元素將會觸發一個新的buffer分配,而不是覆蓋第二個 slice 中的數據。

42. 陳舊的(Stale)Slices

多個 slice 可以引用同一個數據。比如,當你從一個已有的 slice 創建一個新的 slice 時,這就會發生。如果你的應用功能需要這種行爲,那麼你將需要關注下“走味的” slice
在某些情況下,在一個 slice 中添加新的數據,在原有數組無法保持更多新的數據時,將導致分配一個新的數組。而現在其他的 slice 還指向老的數組(和老的數據)。

import "fmt"
func main() {  
    s1 := []int{1,2,3}
    fmt.Println(len(s1),cap(s1),s1) //prints 3 3 [1 2 3]
    s2 := s1[1:]
    fmt.Println(len(s2),cap(s2),s2) //prints 2 2 [2 3]
    for i := range s2 { s2[i] += 20 }
    //still referencing the same array
    fmt.Println(s1) //prints [1 22 23]
    fmt.Println(s2) //prints [22 23]
    s2 = append(s2,4)
    for i := range s2 { s2[i] += 10 }
    //s1 is now "stale"
    fmt.Println(s1) //prints [1 22 23]
    fmt.Println(s2) //prints [32 33 14]
}

43. 類型聲明和方法

當你通過把一個現有(非 interface )的類型定義爲一個新的類型時,新的類型不會繼承現有類型的方法。
Fails:

package main
import "sync"
type myMutex sync.Mutex
func main() {  
    var mtx myMutex
    mtx.Lock() //error
    mtx.Unlock() //error  
}

Compile Errors:

/tmp/sandbox106401185/main.go:9: mtx.Lock undefined (type myMutex has no field or method Lock) /tmp/sandbox106401185/main.go:10: mtx.Unlock undefined (type myMutex has no field or method Unlock)

如果你確實需要原有類型的方法,你可以定義一個新的 struct 類型,用匿名方式把原有類型嵌入其中。
Works:

package main
import "sync"
type myLocker struct {  
    sync.Mutex
}
func main() {  
    var lock myLocker
    lock.Lock() //ok
    lock.Unlock() //ok
}

interface 類型的聲明也會保留它們的方法集合。
Works:

package main
import "sync"
type myLocker sync.Locker
func main() {  
    var lock myLocker = new(sync.Mutex)
    lock.Lock() //ok
    lock.Unlock() //ok
}

44. 從"for switch"和"for select"代碼塊中跳出

沒有標籤的 break 聲明只能從內部的 switch/select 代碼塊中跳出來。如果無法使用 return 聲明的話,那就爲外部循環定義一個標籤是另一個好的選擇。

package main
import "fmt"
func main() {  
    loop:
        for {
            switch {
            case true:
                fmt.Println("breaking out...")
                break loop
            }
        }
    fmt.Println("out!")
}

goto 聲明也可以完成這個功能。。。

45. "for"聲明中的迭代變量和閉包

這在 Go 中是個很常見的技巧。 for 語句中的迭代變量在每次迭代時被重新使用。這就意味着你在 for 循環中創建的閉包(即函數字面量)將會引用同一個變量(而在那些 goroutine 開始執行時就會得到那個變量的值)。
Incorrect:

package main
import (  
    "fmt"
    "time"
)
func main() {  
    data := []string{"one","two","three"}
    for _,v := range data {
        go func() {
            fmt.Println(v)
        }()
    }
    time.Sleep(3 * time.Second)
    //goroutines print: three, three, three
}

最簡單的解決方法(不需要修改 goroutine )是,在 for 循環代碼塊內把當前迭代的變量值保存到一個局部變量中。
Works:

package main
import (  
    "fmt"
    "time"
)
func main() {  
    data := []string{"one","two","three"}
    for _,v := range data {
        vcopy := v //
        go func() {
            fmt.Println(vcopy)
        }()
    }
    time.Sleep(3 * time.Second)
    //goroutines print: one, two, three
}

另一個解決方法是把當前的迭代變量作爲匿名 goroutine 的參數。
Works:

package main
import (  
    "fmt"
    "time"
)
func main() {  
    data := []string{"one","two","three"}
    for _,v := range data {
        go func(in string) {
            fmt.Println(in)
        }(v)
    }
    time.Sleep(3 * time.Second)
    //goroutines print: one, two, three
}

下面這個陷阱稍微複雜一些的版本。
Incorrect:

package main
import (  
    "fmt"
    "time"
)
type field struct {  
    name string
}
func (p *field) print() {  
    fmt.Println(p.name)
}
func main() {  
    data := []field{ {"one"},{"two"},{"three"} }
    for _,v := range data {
        go v.print()
    }
    time.Sleep(3 * time.Second)
    //goroutines print: three, three, three
}

Works:

package main
import (  
    "fmt"
    "time"
)
type field struct {  
    name string
}
func (p *field) print() {  
    fmt.Println(p.name)
}
func main() {  
    data := []field{ {"one"},{"two"},{"three"} }
    for _,v := range data {
        v := v
        go v.print()
    }
    time.Sleep(3 * time.Second)
    //goroutines print: one, two, three
}

在運行這段代碼時你認爲會看到什麼結果?(原因是什麼?)

package main
import (  
    "fmt"
    "time"
)
type field struct {  
    name string
}
func (p *field) print() {  
    fmt.Println(p.name)
}
func main() {  
    data := []*field{ {"one"},{"two"},{"three"} }
    for _,v := range data {
        go v.print()
    }
    time.Sleep(3 * time.Second)
}

46. Defer函數調用參數的求值

defer的函數的參數會在 defer聲明時求值(而不是在函數實際執行時)。

Arguments for a deferred function call are evaluated when the defer statement is evaluated (not when the function is actually executing).

package main
import "fmt"
func main() {  
    var i int = 1
    defer fmt.Println("result =>",func() int { return i * 2 }())
    i++
    //prints: result => 2 (not ok if you expected 4)
}

47. 被Defer的函數調用執行

defer 的調用會在包含的函數的末尾執行,而不是包含代碼塊的末尾。對於 Go 新手而言,一個很常犯的錯誤就是無法區分被 defer 的代碼執行規則和變量作用規則。如果你有一個長時運行的函數,而函數內有一個 for 循環試圖在每次迭代時都 defer 資源清理調用,那就會出現問題。

package main
import (  
    "fmt"
    "os"
    "path/filepath"
)
func main() {  
    if len(os.Args) != 2 {
        os.Exit(-1)
    }
    start, err := os.Stat(os.Args[1])
    if err != nil || !start.IsDir(){
        os.Exit(-1)
    }
    var targets []string
    filepath.Walk(os.Args[1], func(fpath string, fi os.FileInfo, err error) error {
        if err != nil {
            return err
        }
        if !fi.Mode().IsRegular() {
            return nil
        }
        targets = append(targets,fpath)
        return nil
    })
    for _,target := range targets {
        f, err := os.Open(target)
        if err != nil {
            fmt.Println("bad target:",target,"error:",err) //prints error: too many open files
            break
        }
        defer f.Close() //will not be closed at the end of this code block
        //do something with the file...
    }
}

解決這個問題的一個方法是把代碼塊寫成一個函數。

package main
import (  
    "fmt"
    "os"
    "path/filepath"
)
func main() {  
    if len(os.Args) != 2 {
        os.Exit(-1)
    }
    start, err := os.Stat(os.Args[1])
    if err != nil || !start.IsDir(){
        os.Exit(-1)
    }
    var targets []string
    filepath.Walk(os.Args[1], func(fpath string, fi os.FileInfo, err error) error {
        if err != nil {
            return err
        }
        if !fi.Mode().IsRegular() {
            return nil
        }
        targets = append(targets,fpath)
        return nil
    })
    for _,target := range targets {
        func() {
            f, err := os.Open(target)
            if err != nil {
                fmt.Println("bad target:",target,"error:",err)
                return
            }
            defer f.Close() //ok
            //do something with the file...
        }()
    }
}

另一個方法是去掉 defer語句 😃

48. 失敗的類型斷言

失敗的類型斷言返回斷言聲明中使用的目標類型的“零值”。這在與隱藏變量混合時,會發生未知情況。
Incorrect:

package main
import "fmt"
func main() {  
    var data interface{} = "great"
    if data, ok := data.(int); ok {
        fmt.Println("[is an int] value =>",data)
    } else {
        fmt.Println("[not an int] value =>",data) 
        //prints: [not an int] value => 0 (not "great")
    }
}

Works:

package main
import "fmt"
func main() {  
    var data interface{} = "great"
    if res, ok := data.(int); ok {
        fmt.Println("[is an int] value =>",res)
    } else {
        fmt.Println("[not an int] value =>",data) 
        //prints: [not an int] value => great (as expected)
    }
}

49. 阻塞的Goroutine和資源泄露

Rob Pike在2012年的Google I/O大會上所做的“Go Concurrency Patterns”的演講上,說道過幾種基礎的併發模式。從一組目標中獲取第一個結果就是其中之一。

func First(query string, replicas ...Search) Result {  
    c := make(chan Result)
    searchReplica := func(i int) { c <- replicas[i](query) }
    for i := range replicas {
        go searchReplica(i)
    }
    return <-c
}

這個函數在每次搜索重複時都會起一個 goroutine 。每個 goroutine 把它的搜索結果發送到結果的 channel 中。結果 channel 的第一個值被返回。
那其他 goroutine 的結果會怎樣呢?還有那些 goroutine 自身呢?
First()函數中的結果 channel 是沒緩存的。這意味着只有第一個 goroutine 返回。其他的 goroutine 會困在嘗試發送結果的過程中。這意味着,如果你有不止一個的重複時,每個調用將會泄露資源。
爲了避免泄露,你需要確保所有的 goroutine 退出。一個不錯的方法是使用一個有足夠保存所有緩存結果的 channel

func First(query string, replicas ...Search) Result {  
    c := make(chan Result,len(replicas))
    searchReplica := func(i int) { c <- replicas[i](query) }
    for i := range replicas {
        go searchReplica(i)
    }
    return <-c
}

另一個不錯的解決方法是使用一個有 default 情況的 select 語句和一個保存一個緩存結果的 channeldefault 情況保證了即使當結果 channel 無法收到消息的情況下, goroutine 也不會堵塞。

func First(query string, replicas ...Search) Result {  
    c := make(chan Result,1)
    searchReplica := func(i int) { 
        select {
        case c <- replicas[i](query):
        default:
        }
    }
    for i := range replicas {
        go searchReplica(i)
    }
    return <-c
}

你也可以使用特殊的取消 channel 來終止 workers

func First(query string, replicas ...Search) Result {  
    c := make(chan Result)
    done := make(chan struct{})
    defer close(done)
    searchReplica := func(i int) { 
        select {
        case c <- replicas[i](query):
        case <- done:
        }
    }
    for i := range replicas {
        go searchReplica(i)
    }
    return <-c
}

爲何在演講中會包含這些bug?Rob Pike僅僅是不想把演示覆雜化。這麼作是合理的,但對於Go新手而言,可能會直接使用代碼,而不去思考它可能有問題。

三. 高級篇

50. 使用指針接收方法的值的實例

只要值是可取址的,那在這個值上調用指針接收方法是沒問題的。換句話說,在某些情況下,你不需要在有一個接收值的方法版本。
然而並不是所有的變量是可取址的。 map 的元素就不是。通過 interface 引用的變量也不是。

package main
import "fmt"
type data struct {  
    name string
}
func (p *data) print() {  
    fmt.Println("name:",p.name)
}
type printer interface {  
    print()
}
func main() {  
    d1 := data{"one"}
    d1.print() //ok
    var in printer = data{"two"} //error
    in.print()
    m := map[string]data {"x":data{"three"}}
    m["x"].print() //error
}

Compile Errors:

/tmp/sandbox017696142/main.go:21: cannot use data literal (type data) as type printer in assignment: data does not implement printer (print method has pointer receiver) 
/tmp/sandbox017696142/main.go:25: cannot call pointer method on m["x"] 
/tmp/sandbox017696142/main.go:25: cannot take the address of m["x"]

51. 更新 map 的值

如果你有一個 struct 值的 map ,你無法更新單個的 struct 值。
Fails:

package main
type data struct {  
    name string
}
func main() {  
    m := map[string]data {"x":{"one"}}
    m["x"].name = "two" //error
}

Compile Error:

/tmp/sandbox380452744/main.go:9: cannot assign to m["x"].name

這個操作無效是因爲 map 元素是無法取址的。
而讓 Go 新手更加困惑的是 slice 元素是可以取址的。

package main
import "fmt"
type data struct {  
    name string
}
func main() {  
    s := []data one
    s[0].name = "two" //ok
    fmt.Println(s)    //prints: [{two}]
}

注意在不久之前,使用編譯器之一(gccgo)是可以更新 map 的元素值的,但這一行爲很快就被修復了 :-)它也被認爲是Go 1.3的潛在特性。在那時還不是要急需支持的,但依舊在todo list中。
第一個有效的方法是使用一個臨時變量。

package main
import "fmt"
type data struct {  
    name string
}
func main() {  
    m := map[string]data {"x":{"one"}}
    r := m["x"]
    r.name = "two"
    m["x"] = r
    fmt.Printf("%v",m) //prints: map[x:{two}]
}

另一個有效的方法是使用指針的map。

package main
import "fmt"
type data struct {  
    name string
}
func main() {  
    m := map[string]*data {"x":{"one"}}
    m["x"].name = "two" //ok
    fmt.Println(m["x"]) //prints: &{two}
}

順便說下,當你運行下面的代碼時會發生什麼?

package main
type data struct {  
    name string
}
func main() {  
    m := map[string]*data {"x":{"one"}}
    m["z"].name = "what?" //???
}

52. “nil” Interfaces 和 “nil” Interfaces的值

這在 Go 中是第二最常見的技巧,因爲 interface 雖然看起來像指針,但並不是指針。 interface 變量僅在類型和值爲 nil 時才爲 nil
interface 的類型和值會根據用於創建對應 interface 變量的類型和值的變化而變化。當你檢查一個 interface 變量是否等於 nil 時,這就會導致未預期的行爲。

package main
import "fmt"
func main() {  
    var data *byte
    var in interface{}
    fmt.Println(data,data == nil) //prints: <nil> true
    fmt.Println(in,in == nil)     //prints: <nil> true
    in = data
    fmt.Println(in,in == nil)     //prints: <nil> false
    //'data' is 'nil', but 'in' is not 'nil'
}

當你的函數返回 interface 時,小心這個陷阱。
Incorrect:

package main
import "fmt"
func main() {  
    doit := func(arg int) interface{} {
        var result *struct{} = nil
        if(arg > 0) {
            result = &struct;{}{}
        }
        return result
    }
    if res := doit(-1); res != nil {
        fmt.Println("good result:",res) //prints: good result: <nil>
        //'res' is not 'nil', but its value is 'nil'
    }
}

Works:

package main
import "fmt"
func main() {  
    doit := func(arg int) interface{} {
        var result *struct{} = nil
        if(arg > 0) {
            result = &struct;{}{}
        } else {
            ret

53. 棧和堆變量

你並不總是知道變量是分配到棧還是堆上。在 C++ 中,使用 new 創建的變量總是在堆上。在 Go 中,即使是使用 new()或者 make()函數來分配,變量的位置還是由編譯器決定。編譯器根據變量的大小和“泄露分析”的結果來決定其位置。這也意味着在局部變量上返回引用是沒問題的,而這在 C 或者 C++ 這樣的語言中是不行的。
如果你想知道變量分配的位置,在 go buildgo run 上傳入 -m gc標誌(即, go run -gcflags -m app.go )。

54. GOMAXPROCS, 併發, 和並行

默認情況下, Go 僅使用一個執行上下文/OS線程(在當前的版本)。這個數量可以通過設置 GOMAXPROCS來提高。
一個常見的誤解是, GOMAXPROCS表示了 CPU 的數量, Go 將使用這個數量來運行 goroutine 。而 runtime.GOMAXPROCS()函數的文檔讓人更加的迷茫。 GOMAXPROCS變量描述( https://golang.org/pkg/runtime/)所討論OS線程的內容比較好。
你可以設置 GOMAXPROCS的數量大於 CPU 的數量。 GOMAXPROCS的最大值是256。

package main
import (  
    "fmt"
    "runtime"
)
func main() {  
    fmt.Println(runtime.GOMAXPROCS(-1)) //prints: 1
    fmt.Println(runtime.NumCPU())       //prints: 1 (on play.golang.org)
    runtime.GOMAXPROCS(20)
    fmt.Println(runtime.GOMAXPROCS(-1)) //prints: 20
    runtime.GOMAXPROCS(300)
    fmt.Println(runtime.GOMAXPROCS(-1)) //prints: 256
}

55. 讀寫操作的重排順序

Go 可能會對某些操作進行重新排序,但它能保證在一個 goroutine 內的所有行爲順序是不變的。然而,它並不保證多 goroutine 的執行順序。

package main
import (  
    "runtime"
    "time"
)
var _ = runtime.GOMAXPROCS(3)
var a, b int
func u1() {  
    a = 1
    b = 2
}
func u2() {  
    a = 3
    b = 4
}
func p() {  
    println(a)
    println(b)
}
func main() {  
    go u1()
    go u2()
    go p()
    time.Sleep(1 * time.Second)
}

如果你多運行幾次上面的代碼,你可能會發現 a 和 b 變量有多個不同的組合:
ab最有趣的組合式是"02"。這表明 ba之前更新了。
如果你需要在多 goroutine 內放置讀寫順序的變化,你將需要使用 channel ,或者使用 sync 包構建合適的結構體。

56. 優先調度

有可能會出現這種情況,一個無恥的 goroutine 阻止其他 goroutine 運行。當你有一個不讓調度器運行的 for 循環時,這就會發生。

package main
import "fmt"
func main() {  
    done := false
    go func(){
        done = true
    }()
    for !done {
    }
    fmt.Println("done!")
}

for 循環並不需要是空的。只要它包含了不會觸發調度執行的代碼,就會發生這種問題。
調度器會在 GCgo 聲明、阻塞 channel 操作、阻塞系統調用和 lock 操作後運行。它也會在非內聯函數調用後執行。

package main
import "fmt"
func main() {  
    done := false
    go func(){
        done = true
    }()
    for !done {
        fmt.Println("not done!") //not inlined
    }
    fmt.Println("done!")
}

要想知道你在 for 循環中調用的函數是否是內聯的,你可以在 go buildgo run 時傳入 -m gc標誌(如, go build -gcflags -m)。
另一個選擇是顯式的喚起調度器。你可以使用 runtime 包中的 Goshed()函數。

package main
import (  
    "fmt"
    "runtime"
)
func main() {  
    done := false
    go func(){
        done = true
    }()
    for !done {
        runtime.Gosched()
    }
    fmt.Println("done!")
}
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章