Go 的 50 度灰: 新 Golang 开发者要注意的陷阱、技巧和常见错误

最新推荐文章于 2024-05-22 16:22:16 发布

云满笔记

最新推荐文章于 2024-05-22 16:22:16 发布

阅读量3k

点赞数 1

分类专栏： golang 文章标签： golang

本文链接：https://blog.csdn.net/wan212000/article/details/126161144

版权

golang 专栏收录该内容

127 篇文章 9 订阅

订阅专栏

这里写目录标题

1. Go 的 50 度灰: 新 Golang 开发者要注意的陷阱、技巧和常见错误

1. Go 的 50 度灰: 新 Golang 开发者要注意的陷阱、技巧和常见错误

Go 是一门简单有趣的语言, 但与其他语言类似, 它会有一些技巧。。。这些技巧的绝大部分并不是 Go 的缺陷造成的。如果你以前使用的是其他语言, 那么这其中的有些错误就是很自然的陷阱。其它的是由错误的假设和缺少细节造成的。

如果你花时间学习这门语言, 阅读官方说明、wiki、邮件列表讨论、大量的优秀博文和 Rob Pike 的展示, 以及源代码, 这些技巧中的绝大多数都是显而易见的。尽管不是每个人都是以这种方式开始学习的, 但也没关系。如果你是 Go 语言新人, 那么这里的信息将会节约你大量的调试代码的时间。

1. 初级

1.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!")
}

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

另一个选择是注释掉或者移除未使用的变量 : -)

1.3. 未使用的 Imports

如果你引入一个包, 而没有使用其中的任何函数、接口、结构体或者变量的话, 代码将会编译失败。
你可以使用 goimports 来增加引入或者移除未使用的引用:

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

如果你真的需要引入的包, 你可以添加一个下划线标记符, _, 来作为这个包的名字, 从而避免编译失败。下滑线标记符用于引入, 但不使用。

Fails:

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
}

另一个选择是移除或者注释掉未使用的 imports : -)

1.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() {  
}

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

1.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。

1.7. 不使用显式类型, 无法使用 “nil” 来初始化变量

nil 标志符用于表示 interface、函数、maps、slices 和 channels 的 “零值”。如果你不指定变量的类型, 编译器将无法编译你的代码, 因为它猜不出具体的类型。
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
}

1.8. 使用 “nil” Slices and Maps

在一个 nil 的 slice 中添加元素是没问题的, 但对一个 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
}

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

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

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

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

1.13. 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 已经有了专门申请, 但现在看起来这是个低优先级的特性。

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

1.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 序列表示的原因。

1.16. 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) {...}。

1.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 的切片也是一个选项。

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

1.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 := "é"
    fmt.Println(len(data))                    //prints: 3
    fmt.Println(utf8.RuneCountInString(data)) //prints: 2
}

1.20. 在多行的 Slice、Array 和 Map 语句中遗漏逗号

Fails:

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

当你把声明折叠到单行时, 如果你没加末尾的逗号, 你将不会得到编译错误。

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

1.22. 内建的数据结构操作不是同步的

即使 Go 本身有很多特性来支持并发, 并发安全的数据集合并不是其中之一 :-)确保数据集合以原子的方式更新是你的职责。Goroutines 和 channels 是实现这些原子操作的推荐方式, 但你也可以使用 “sync” 包, 如果它对你的应用有意义的话。

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

1.24. 对 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 的游乐场(https://play.golang.org/), 你将总会得到同样的结果, 因为除非你修改代码, 否则它不会重新编译代码。

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

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

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

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

1.29. 未导出的结构体不会被编码

以小写字母开头的结构体将不会被 (json、xml、gob 等) 编码, 因此当你编码这些未导出的结构体时, 你将会得到零值。

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

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

现在它会如预期般工作 😃

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

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

1.33. 使用 “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 错误:

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

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

2. 中级

2.1. 关闭 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)

2.2. 关闭 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 服务器发送一两个请求, 那么在引用收到响应后立刻关闭网络连接是一个好主意。增加打开文件的限制数可能也是个好主意。当然, 正确的选择源自于应用。

2.3. 比较 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())。

2.4. 从 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")
}

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

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

2.7. 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 中的数据。

2.8. 陈旧的(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]
}

2.9. 类型声明和方法

当你通过把一个现有 (非 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
}

2.10. 从 “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” 声明也可以完成这个功能。。。

2.11. “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)
}

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

2.13. 被 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 语句 😃

2.14. 失败的类型断言

失败的类型断言返回断言声明中使用的目标类型的 “零值”。这在与隐藏变量混合时, 会发生未知情况。

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

2.15. 阻塞的 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 新手而言, 可能会直接使用代码, 而不去思考它可能有问题。

3. 高级

3.1. 使用指针接收方法的值的实例

只要值是可取址的, 那在这个值上调用指针接收方法是没问题的。换句话说, 在某些情况下, 你不需要在有一个接收值的方法版本。

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

3.2. 更新 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?" //???
}

3.3. “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

3.4. 栈和堆变量

你并不总是知道变量是分配到栈还是堆上。在 C++ 中, 使用 new 创建的变量总是在堆上。在 Go 中, 即使是使用 new()或者 make()函数来分配, 变量的位置还是由编译器决定。编译器根据变量的大小和 “泄露分析” 的结果来决定其位置。这也意味着在局部变量上返回引用是没问题的, 而这在 C 或者 C++ 这样的语言中是不行的。

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

3.5. 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
}

3.6. 读写操作的重排顺序

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 变量有多个不同的组合:

a 和 b 最有趣的组合式是 “02”。这表明 b 在 a 之前更新了。

如果你需要在多 goroutine 内放置读写顺序的变化, 你将需要使用 channel, 或者使用 “sync” 包构建合适的结构体。

3.7. 优先调度

有可能会出现这种情况, 一个无耻的 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!")
}

如果你看到了这里, 并想留下评论或者想法, 你可以在这个 Reddit 讨论里随意留言。

4. Cgo (aka Brave Beginner)

4.1. Import C and Multiline Import Blocks

level: Cgo

You need to import the “C” package to use Cgo. You can do that with a single line import or you can do it with an import block.

package main

/*
#include <stdlib.h>
*/
import (
  "C"
)

import (
  "unsafe"
)

func main() {
  cs := C.CString("my go string")
  C.free(unsafe.Pointer(cs))
}

If you are using the import block format you can’t import other packages in the same block.

package main

/*
#include <stdlib.h>
*/
import (
  "C"
  "unsafe"
)

func main() {
  cs := C.CString("my go string")
  C.free(unsafe.Pointer(cs))
}

Compile Error:

./main.go:13:2: could not determine kind of name for C.free

4.2. No blank lines Between Import C and Cgo Comments

level: Cgo

One of the first gotchas with Cgo is the location of the cgo comments above the import “C” statement.

package main

/*
#include <stdlib.h>
*/

import "C"

import (
  "unsafe"
)

func main() {
  cs := C.CString("my go string")
  C.free(unsafe.Pointer(cs))
}

Compile Error:

./main.go:15:2: could not determine kind of name for C.free

Make sure you don’t have any blank lines above import “C” statement.

4.3. Can’t Call C Functions with Variable Arguments

level: Cgo

You can’t call C functions with variable arguments directly.

package main

/*
#include <stdio.h>
#include <stdlib.h>
*/
import "C"

import (
  "unsafe"
)

func main() {
  cstr := C.CString("go")
  C.printf("%s\n",cstr) //not ok
  C.free(unsafe.Pointer(cstr))
}

Compile Error:

./main.go:15:2: unexpected type: ...

You have to wrap your variadic C functions in functions with a known number of parameters.

package main

/*
#include <stdio.h>
#include <stdlib.h>

void out(char* in) {
  printf("%s\n", in);
}
*/
import "C"

import (
  "unsafe"
)

func main() {
  cstr := C.CString("go")
  C.out(cstr) //ok
  C.free(unsafe.Pointer(cstr))
}

云满笔记

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
0
评论
Go 的 50 度灰: 新 Golang 开发者要注意的陷阱、技巧和常见错误

Go 是一门简单有趣的语言, 但与其他语言类似, 它会有一些技巧。。。这些技巧的绝大部分并不是 Go 的缺陷造成的。如果你以前使用的是其他语言, 那么这其中的有些错误就是很自然的陷阱。其它的是由错误的假设和缺少细节造成的。如果你花时间学习这门语言, 阅读官方说明、wiki、邮件列表讨论、大量的优秀博文和 Rob Pike 的展示, 以及源代码, 这些技巧中的绝大多数都是显而易见的。尽管不是每个人都是以这种方式开始学习的, 但也没关系。如果你是 Go 语言新人, 那么这里的信息将会节约你大量的调试代码的时间。
复制链接

扫一扫