天天看點

Go的50度灰:開發者要注意的陷阱和常見錯誤

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

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

初級

開大括号不能放在單獨的一行

在大多數其他使用大括号的語言中,你需要選擇放置它們的位置。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!")
}
           

未使用的變量

如果你有未使用的變量,代碼将編譯失敗。當然也有例外。在函數内一定要使用聲明的變量,但未使用的全局變量是沒問題的。

如果你給未使用的變量配置設定了一個新的值,代碼還是會編譯失敗。你需要在某個地方使用這個變量,才能讓編譯器愉快的編譯。

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
}
           

另一個選擇是注釋掉或者移除未使用的變量

未使用的Imports

如果你引入一個包,而沒有使用其中的任何函數、接口、結構體或者變量的話,代碼将會編譯失敗。

你可以使用goimports來增加引入或者移除未使用的引用:

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

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

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

/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"

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

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

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

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

Compile Error:

/tmp/sandbox265716165/main.go:3: non-declaration statement outside function body
package main
var myvar = 1
func main() {  
}
           

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

你不能在一個單獨的聲明中重複聲明一個變量,但在多變量聲明中這是允許的,其中至少要有一個新的聲明變量。

重複變量需要在相同的代碼塊内,否則你将得到一個隐藏變量。

package main
func main() {  
    one := 0
    one := 1 //error
}
           
/tmp/sandbox706333626/main.go:5: no new variables on left side of :=
package main
func main() {  
    one := 0
    one, two := 1,2
    one,two = two,one
}
           

偶然的變量隐藏

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

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。

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

nil标志符用于表示interface、函數、maps、slices和channels的“零值”。如果你不指定變量的類型,編譯器将無法編譯你的代碼,因為它猜不出具體的類型。

package main
func main() {  
    var x = nil //error
    _ = x
}
           
/tmp/sandbox188239583/main.go:4: use of untyped nil
package main
func main() {  
    var x interface{} = nil
    _ = x
}
           

使用“nil” Slices and Maps

在一個nil的slice中添加元素是沒問題的,但對一個map做同樣的事将會生成一個運作時的panic。

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

Map的容量

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

package main
func main() {  
    m := make(map[string]int,99)
    cap(m) //error
}
           
/tmp/sandbox326543983/main.go:5: invalid argument m (type map[string]int) for cap

字元串不會為nil

這對于經常使用nil配置設定字元串變量的開發者而言是個需要注意的地方。

package main
func main() {  
    var x string = nil //error
    if x == nil { //error
        x = "default"
    }
}
           
/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)
package main
func main() {  
    var x string //defaults to "" (zero value)
    if x == "" {
        x = "default"
    }
}
           

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]
}
           

在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
    }
}
           

Slices和Arrays是一維的

看起來Go好像支援多元的Array和Slice,但不是這樣的。盡管可以建立數組的數組或者切片的切片。對于依賴于動态多元數組的數值計算應用而言,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)
    }
}
           

使用“共享資料”slice的slice來建立一個動态的多元數組需要三步。首先,你需要建立一個用于存放原始資料的資料“容器”。然後,你再建立外部的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>
}
           

關于多元array和slice已經有了專門申請,但現在看起來這是個低優先級的特性。

通路不存在的Map Keys

這對于那些希望得到“nil”标示符的開發者而言是個技巧(和其他語言中做的一樣)。如果對應的資料類型的“零值”是“nil”,那傳回的值将會是“nil”,但對于其他的資料類型是不一樣的。檢測對應的“零值”可以用于确定map中的記錄是否存在,但這并不總是可信(比如,如果在二值的map中“零值”是false,這時你要怎麼做)。檢測給定map中的記錄是否存在的最可信的方法是,通過map的通路操作,檢查第二個傳回的值。

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

Strings無法修改

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

package main
import "fmt"
func main() {  
    x := "text"
    x[0] = 'T'
    fmt.Println(x)
}
           
/tmp/sandbox305565531/main.go:7: cannot assign to x[0]
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序清單示的原因。

String和Byte Slice之間的轉換

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

Go在[]byte到string和string到[]byte的轉換中确實使用了一些優化來避免額外的配置設定(在todo清單中有更多的優化)。

第一個優化避免了當[]byte keys用于在map[string]集合中查詢時的額外配置設定:m[string(key)]。

第二個優化避免了字元串轉換為[]byte後在for range語句中的額外配置設定:

for i,v := range []byte(str) {...}

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包也可以用。utf8string包中包含了一個很友善的At()方法。把字元串轉換為rune的切片也是一個選項。

字元串不總是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
}
           

字元串的長度

讓我們假設你是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
}
           

在多行的Slice、Array和Map語句中遺漏逗号

package main
func main() {  
    x := []int{
    1,
    2 //error
    }
    _ = x
}
           
/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 }
           
package main
func main() {  
    x := []int{
        1,
        2,
    }
    x = x
    y := []int{3,4,} //no error
    y = y
}
           

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

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

Logging庫一般提供不同的log等級。與這些logging庫不同,Go中log包在你調用它的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")
}
           

内建的資料結構操作不是同步的

即使Go本身有很多特性來支援并發,并發安全的資料集合并不是其中之一。確定資料集合以原子的方式更新是你的職責。Goroutines和channels是實作這些原子操作的推薦方式,但你也可以使用“sync”包,如果它對你的應用有意義的話。

String在“range”語句中的疊代值

索引值(“range”操作傳回的第一個值)是傳回的第二個值的目前“字元”(unicode編碼的point/rune)的第一個byte的索引。它不是目前“字元”的索引,這與其他語言不同。注意真實的字元可能會由多個rune表示。如果你需要處理字元,確定你使用了“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)
}
           

對Map使用“for range”語句疊代

如果你希望以某個順序(比如,按key值排序)的方式得到元素,就需要這個技巧。每次的map疊代将會生成不同的結果。Go的runtime有心嘗試随機化疊代順序,但并不總會成功,這樣你可能得到一些相同的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)
    }
}
           

而且如果你使用Go Playground,你将總會得到同樣的結果,因為除非你修改代碼,否則它不會重新編譯代碼。

"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)
}
           

自增和自減

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

package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    i := 0
    ++i //error
    fmt.Println(data[i++]) //error
}
           
/tmp/sandbox101231828/main.go:8: syntax error: unexpected ++ /tmp/sandbox101231828/main.go:9: syntax error: unexpected ++, expecting :
package main
import "fmt"
func main() {  
    data := []int{1,2,3}
    i := 0
    i++
    fmt.Println(data[i])
}
           

按位NOT操作

許多語言使用 ~作為一進制的NOT操作符(即按位補足),但Go為了這個重用了XOR操作符(^)。

package main
import "fmt"
func main() {  
    fmt.Println(~2) //error
}
           
/tmp/sandbox965529189/main.go:6: the bitwise complement operator is ^
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))
}
           

操作優先級的差異

除了”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
}
           

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

以小寫字母開頭的結構體将不會被(json、xml、gob等)編碼,是以當你編碼這些未導出的結構體時,你将會得到零值。

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:""}
}
           

有活動的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)
}
           

你将會看到:

1
2
3
[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)
}
           

如果你運作這個應用,你将會看到:

1
2
3
4
[0] is running 
[0] is done 
[1] is running 
[1] is done
           

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

1
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
        }
    }
}
           

現在它會如預期般工作

向無緩存的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
}
           

向已關閉的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)
}
           

使用"nil" Channels

在一個nil的channel上發送和接收操作會被永久阻塞。這個行為有詳細的文檔解釋,但它對于新的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錯誤:

1
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)
}
           

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

方法的接收者就像正常的函數參數。如果聲明為值,那麼你的函數/方法得到的是接收者參數的拷貝。這意味着對接收者所做的修改将不會影響原有的值,除非接收者是一個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]
}
           

中級

關閉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)
           

關閉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伺服器發送一兩個請求,那麼在引用收到響應後立刻關閉網絡連接配接是一個好主意。增加打開檔案的限制數可能也是個好主意。當然,正确的選擇源自于應用。

比較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()不會認為空的slice與“nil”的slice相等。這個行為與你使用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()),你可能會嘗試使用“bytes”和“string”包中的ToUpper()或者ToLower()函數。對于英國文本,這麼做是沒問題的,但對于許多其他的語言來說就不行了。這時應該使用strings.EqualFold()和bytes.EqualFold()。

如果你的byte slice中包含需要驗證使用者資料的隐私資訊(比如,加密哈希、tokens等),不要使用reflect.DeepEqual()、bytes.Equal(),或者bytes.Compare(),因為這些函數将會讓你的應用易于被定時攻擊。為了避免洩露時間資訊,使用'crypto/subtle'包中的函數(即,subtle.ConstantTimeCompare())。

從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")
}
           
package main
import "fmt"
func main() {  
    defer func() {
        fmt.Println("recovered:",recover())
    }()
    panic("not good")
}
           

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

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")
}
           

在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}
}
           

在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>
}
           

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中的資料。

陳舊的(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]
}
           

類型聲明和方法

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

package main
import "sync"
type myMutex sync.Mutex
func main() {  
    var mtx myMutex
    mtx.Lock() //error
    mtx.Unlock() //error  
}
           
/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類型,用匿名方式把原有類型嵌入其中。

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

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

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

從"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"聲明也可以完成這個功能。。。

"for"聲明中的疊代變量和閉包

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

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循環代碼塊内把目前疊代的變量值儲存到一個局部變量中。

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的參數。

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
}
           

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

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
}
           
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)
}
           

Defer函數調用參數的求值

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

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)
}
           

被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語句

失敗的類型斷言

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

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")
    }
}
           
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)
    }
}
           

阻塞的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語句和一個儲存一個緩存結果的channel。default情況保證了即使當結果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新手而言,可能會直接使用代碼,而不去思考它可能有問題。

進階

使用指針接收方法的值的執行個體

隻要值是可取址的,那在這個值上調用指針接收方法是沒問題的。換句話說,在某些情況下,你不需要在有一個接收值的方法版本。

然而并不是所有的變量是可取址的。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
}
           
/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"]
           

更新Map的值

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

package main
type data struct {  
    name string
}
func main() {  
    m := map[string]data {"x":{"one"}}
    m["x"].name = "two" //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?" //???
}
           

"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時,小心這個陷阱。

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'
    }
}
           
package main
import "fmt"
func main() {  
    doit := func(arg int) interface{} {
        var result *struct{} = nil
        if(arg > 0) {
            result = &struct{}{}
        } else {
            return nil //return an explicit 'nil'
        }
        return result
    }
    if res := doit(-1); res != nil {
        fmt.Println("good result:",res)
    } else {
        fmt.Println("bad result (res is nil)") //here as expected
    }
}
           

棧和堆變量

你并不總是知道變量是配置設定到棧還是堆上。在C++中,使用new建立的變量總是在堆上。在Go中,即使是使用new()或者make()函數來配置設定,變量的位置還是由編譯器決定。編譯器根據變量的大小和“洩露分析”的結果來決定其位置。這也意味着在局部變量上傳回引用是沒問題的,而這在C或者C++這樣的語言中是不行的。

如果你想知道變量配置設定的位置,在“go build”或“go run”上傳入“-m“ gc标志(即,go run -gcflags -m app.go)。

GOMAXPROCS, 并發, 和并行

預設情況下,Go僅使用一個執行上下文/OS線程(在目前的版本)。這個數量可以通過設定GOMAXPROCS來提高。

一個常見的誤解是,GOMAXPROCS表示了CPU的數量,Go将使用這個數量來運作goroutine。而runtime.GOMAXPROCS()函數的文檔讓人更加的迷茫。GOMAXPROCS變量描述所讨論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
}
           

讀寫操作的重排順序

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變量有多個不同的組合:

1 
2
           
3 
4
           
0 
2
           
0 
0
           
1 
4
           

a和b最有趣的組合式是"02"。這表明b在a之前更新了。

如果你需要在多goroutine内放置讀寫順序的變化,你将需要使用channel,或者使用"sync"包建構合适的結構體。

優先排程

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

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

for循環并不需要是空的。隻要它包含了不會觸發排程執行的代碼,就會發生這種問題。

排程器會在GC、“go”聲明、阻塞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 build”或“go 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!")
}