1. Golang新手可能会踩的58个坑

1.1. 前言

Go 是一门简单有趣的编程语言,与其他语言一样,在使用时不免会遇到很多坑,不过它们大多不是 Go 本身的设计缺陷。如果你刚从其他语言转到 Go,那这篇文章里的坑多半会踩到。

如果花时间学习官方 doc、wiki、讨论邮件列表、 Rob Pike 的大量文章以及 Go 的源码,会发现这篇文章中的坑是很常见的,新手跳过这些坑,能减少大量调试代码的时间。

1.1.1. 初级篇:1-34

1.左大括号 { 不能单独放一行

在其他大多数语言中,{ 的位置你自行决定。Go比较特别,遵守分号注入规则(automatic semicolon injection):编译器会在每行代码尾部特定分隔符后加;来分隔多条语句,比如会在 ) 后加分号:

  1. // 错误示例
  2. func main()
  3. {
  4. println("www.topgoer.com是个不错的go语言中文文档")
  5. }
  6. // 等效于
  7. func main(); // 无函数体
  8. {
  9. println("hello world")
  10. }
  1. ./main.go: missing function body
  2. ./main.go: syntax error: unexpected semicolon or newline before {
  1. // 正确示例
  2. func main() {
  3. println("www.topgoer.com是个不错的go语言中文文档")
  4. }

2.未使用的变量

如果在函数体代码中有未使用的变量,则无法通过编译,不过全局变量声明但不使用是可以的。即使变量声明后为变量赋值,依旧无法通过编译,需在某处使用它:

  1. // 错误示例
  2. var gvar int // 全局变量,声明不使用也可以
  3. func main() {
  4. var one int // error: one declared and not used
  5. two := 2 // error: two declared and not used
  6. var three int // error: three declared and not used
  7. three = 3
  8. }
  9. // 正确示例
  10. // 可以直接注释或移除未使用的变量
  11. func main() {
  12. var one int
  13. _ = one
  14. two := 2
  15. println(two)
  16. var three int
  17. one = three
  18. var four int
  19. four = four
  20. }

3.未使用的 import

如果你 import一个包,但包中的变量、函数、接口和结构体一个都没有用到的话,将编译失败。可以使用 _下划线符号作为别名来忽略导入的包,从而避免编译错误,这只会执行 package 的 init()

  1. // 错误示例
  2. import (
  3. "fmt" // imported and not used: "fmt"
  4. "log" // imported and not used: "log"
  5. "time" // imported and not used: "time"
  6. )
  7. func main() {
  8. }
  9. // 正确示例
  10. // 可以使用 goimports 工具来注释或移除未使用到的包
  11. import (
  12. _ "fmt"
  13. "log"
  14. "time"
  15. )
  16. func main() {
  17. _ = log.Println
  18. _ = time.Now
  19. }

4.简短声明的变量只能在函数内部使用

  1. // 错误示例
  2. myvar := 1 // syntax error: non-declaration statement outside function body
  3. func main() {
  4. }
  5. // 正确示例
  6. var myvar = 1
  7. func main() {
  8. }

5.使用简短声明来重复声明变量

不能用简短声明方式来单独为一个变量重复声明,:=左侧至少有一个新变量,才允许多变量的重复声明:

  1. // 错误示例
  2. func main() {
  3. one := 0
  4. one := 1 // error: no new variables on left side of :=
  5. }
  6. // 正确示例
  7. func main() {
  8. one := 0
  9. one, two := 1, 2 // two 是新变量,允许 one 的重复声明。比如 error 处理经常用同名变量 err
  10. one, two = two, one // 交换两个变量值的简写
  11. }

6.不能使用简短声明来设置字段的值

struct 的变量字段不能使用 := 来赋值以使用预定义的变量来避免解决:

  1. // 错误示例
  2. type info struct {
  3. result int
  4. }
  5. func work() (int, error) {
  6. return 3, nil
  7. }
  8. func main() {
  9. var data info
  10. data.result, err := work() // error: non-name data.result on left side of :=
  11. fmt.Printf("info: %+v\n", data)
  12. }
  13. // 正确示例
  14. func main() {
  15. var data info
  16. var err error // err 需要预声明
  17. data.result, err = work()
  18. if err != nil {
  19. fmt.Println(err)
  20. return
  21. }
  22. fmt.Printf("info: %+v\n", data)
  23. }

7.不小心覆盖了变量

对从动态语言转过来的开发者来说,简短声明很好用,这可能会让人误会 := 是一个赋值操作符。如果你在新的代码块中像下边这样误用了 :=,编译不会报错,但是变量不会按你的预期工作:

  1. func main() {
  2. x := 1
  3. println(x) // 1
  4. {
  5. println(x) // 1
  6. x := 2
  7. println(x) // 2 // 新的 x 变量的作用域只在代码块内部
  8. }
  9. println(x) // 1
  10. }

这是 Go 开发者常犯的错,而且不易被发现。可使用 vet工具来诊断这种变量覆盖,Go 默认不做覆盖检查,添加 -shadow 选项来启用:

  1. > go tool vet -shadow main.go
  2. main.go:9: declaration of "x" shadows declaration at main.go:5

注意 vet 不会报告全部被覆盖的变量,可以使用 go-nyet 来做进一步的检测:

  1. > $GOPATH/bin/go-nyet main.go
  2. main.go:10:3:Shadowing variable `x`

8.显式类型的变量无法使用 nil 来初始化

nil 是 interface、function、pointer、map、slice 和 channel 类型变量的默认初始值。但声明时不指定类型,编译器也无法推断出变量的具体类型。

  1. // 错误示例
  2. func main() {
  3. var x = nil // error: use of untyped nil
  4. _ = x
  5. }
  6. // 正确示例
  7. func main() {
  8. var x interface{} = nil
  9. _ = x
  10. }

9.直接使用值为 nil 的 slice、map

允许对值为 nil 的 slice 添加元素,但对值为 nil 的 map添加元素则会造成运行时 panic

  1. // map 错误示例
  2. func main() {
  3. var m map[string]int
  4. m["one"] = 1 // error: panic: assignment to entry in nil map
  5. // m := make(map[string]int)// map 的正确声明,分配了实际的内存
  6. }
  7. // slice 正确示例
  8. func main() {
  9. var s []int
  10. s = append(s, 1)
  11. }

10.map 容量

在创建 map 类型的变量时可以指定容量,但不能像 slice 一样使用 cap() 来检测分配空间的大小:

  1. // 错误示例
  2. func main() {
  3. m := make(map[string]int, 99)
  4. println(cap(m)) // error: invalid argument m1 (type map[string]int) for cap
  5. }

11.string 类型的变量值不能为 nil

对那些喜欢用 nil 初始化字符串的人来说,这就是坑:

  1. // 错误示例
  2. func main() {
  3. var s string = nil // cannot use nil as type string in assignment
  4. if s == nil { // invalid operation: s == nil (mismatched types string and nil)
  5. s = "default"
  6. }
  7. }
  8. // 正确示例
  9. func main() {
  10. var s string // 字符串类型的零值是空串 ""
  11. if s == "" {
  12. s = "default"
  13. }
  14. }

12.Array 类型的值作为函数参数

在 C/C++ 中,数组(名)是指针。将数组作为参数传进函数时,相当于传递了数组内存地址的引用,在函数内部会改变该数组的值。

在 Go 中,数组是值。作为参数传进函数时,传递的是数组的原始值拷贝,此时在函数内部是无法更新该数组的:

  1. // 数组使用值拷贝传参
  2. func main() {
  3. x := [3]int{1,2,3}
  4. func(arr [3]int) {
  5. arr[0] = 7
  6. fmt.Println(arr) // [7 2 3]
  7. }(x)
  8. fmt.Println(x) // [1 2 3] // 并不是你以为的 [7 2 3]
  9. }

如果想修改参数数组:

  • 直接传递指向这个数组的指针类型:
  1. // 传址会修改原数据
  2. func main() {
  3. x := [3]int{1,2,3}
  4. func(arr *[3]int) {
  5. (*arr)[0] = 7
  6. fmt.Println(arr) // &[7 2 3]
  7. }(&x)
  8. fmt.Println(x) // [7 2 3]
  9. }
  • 直接使用 slice:即使函数内部得到的是 slice 的值拷贝,但依旧会更新 slice 的原始数据(底层 array)
  1. // 会修改 slice 的底层 array,从而修改 slice
  2. func main() {
  3. x := []int{1, 2, 3}
  4. func(arr []int) {
  5. arr[0] = 7
  6. fmt.Println(x) // [7 2 3]
  7. }(x)
  8. fmt.Println(x) // [7 2 3]
  9. }

13.range 遍历 slice 和 array 时混淆了返回值

与其他编程语言中的 for-in 、foreach 遍历语句不同,Go 中的 range 在遍历时会生成 2 个值,第一个是元素索引,第二个是元素的值:

  1. // 错误示例
  2. func main() {
  3. x := []string{"a", "b", "c"}
  4. for v := range x {
  5. fmt.Println(v) // 1 2 3
  6. }
  7. }
  8. // 正确示例
  9. func main() {
  10. x := []string{"a", "b", "c"}
  11. for _, v := range x { // 使用 _ 丢弃索引
  12. fmt.Println(v)
  13. }
  14. }

14.slice 和 array 其实是一维数据

看起来 Go 支持多维的 array 和 slice,可以创建数组的数组、切片的切片,但其实并不是。

对依赖动态计算多维数组值的应用来说,就性能和复杂度而言,用 Go 实现的效果并不理想。

可以使用原始的一维数组、“独立“ 的切片、“共享底层数组”的切片来创建动态的多维数组。

1.使用原始的一维数组:要做好索引检查、溢出检测、以及当数组满时再添加值时要重新做内存分配。

2.使用“独立”的切片分两步:

  • 创建外部 slice

    • 对每个内部 slice 进行内存分配

注意内部的 slice 相互独立,使得任一内部 slice 增缩都不会影响到其他的 slice

  1. // 使用各自独立的 6 个 slice 来创建 [2][3] 的动态多维数组
  2. func main() {
  3. x := 2
  4. y := 4
  5. table := make([][]int, x)
  6. for i := range table {
  7. table[i] = make([]int, y)
  8. }
  9. }

1.使用“共享底层数组”的切片

  • 创建一个存放原始数据的容器 slice
  • 创建其他的 slice
  • 切割原始 slice 来初始化其他的 slice
  1. func main() {
  2. h, w := 2, 4
  3. raw := make([]int, h*w)
  4. for i := range raw {
  5. raw[i] = i
  6. }
  7. // 初始化原始 slice
  8. fmt.Println(raw, &raw[4]) // [0 1 2 3 4 5 6 7] 0xc420012120
  9. table := make([][]int, h)
  10. for i := range table {
  11. // 等间距切割原始 slice,创建动态多维数组 table
  12. // 0: raw[0*4: 0*4 + 4]
  13. // 1: raw[1*4: 1*4 + 4]
  14. table[i] = raw[i*w : i*w + w]
  15. }
  16. fmt.Println(table, &table[1][0]) // [[0 1 2 3] [4 5 6 7]] 0xc420012120
  17. }

更多关于多维数组的参考

go-how-is-two-dimensional-arrays-memory-representation

what-is-a-concise-way-to-create-a-2d-slice-in-go

15.访问 map 中不存在的 key

和其他编程语言类似,如果访问了 map 中不存在的 key 则希望能返回 nil,比如在 PHP 中:

  1. > php -r '$v = ["x"=>1, "y"=>2]; @var_dump($v["z"]);'
  2. NULL

Go 则会返回元素对应数据类型的零值,比如 nil、'' 、false 和 0,取值操作总有值返回,故不能通过取出来的值来判断 key 是不是在 map 中。

检查 key 是否存在可以用 map 直接访问,检查返回的第二个参数即可:

  1. // 错误的 key 检测方式
  2. func main() {
  3. x := map[string]string{"one": "2", "two": "", "three": "3"}
  4. if v := x["two"]; v == "" {
  5. fmt.Println("key two is no entry") // 键 two 存不存在都会返回的空字符串
  6. }
  7. }
  8. // 正确示例
  9. func main() {
  10. x := map[string]string{"one": "2", "two": "", "three": "3"}
  11. if _, ok := x["two"]; !ok {
  12. fmt.Println("key two is no entry")
  13. }
  14. }

16.string 类型的值是常量,不可更改

尝试使用索引遍历字符串,来更新字符串中的个别字符,是不允许的。

string 类型的值是只读的二进制 byte slice,如果真要修改字符串中的字符,将 string 转为 []byte 修改后,再转为 string 即可:

  1. // 修改字符串的错误示例
  2. func main() {
  3. x := "text"
  4. x[0] = "T" // error: cannot assign to x[0]
  5. fmt.Println(x)
  6. }
  7. // 修改示例
  8. func main() {
  9. x := "text"
  10. xBytes := []byte(x)
  11. xBytes[0] = 'T' // 注意此时的 T 是 rune 类型
  12. x = string(xBytes)
  13. fmt.Println(x) // Text
  14. }

注意: 上边的示例并不是更新字符串的正确姿势,因为一个 UTF8 编码的字符可能会占多个字节,比如汉字就需要 3~4个字节来存储,此时更新其中的一个字节是错误的。

更新字串的正确姿势:将 string 转为 rune slice(此时 1 个 rune 可能占多个 byte),直接更新 rune 中的字符

  1. func main() {
  2. x := "text"
  3. xRunes := []rune(x)
  4. xRunes[0] = '我'
  5. x = string(xRunes)
  6. fmt.Println(x) // 我ext
  7. }

17.string 与 byte slice 之间的转换

当进行 string 和 byte slice 相互转换时,参与转换的是拷贝的原始值。这种转换的过程,与其他编程语的强制类型转换操作不同,也和新 slice 与旧 slice 共享底层数组不同。

Go 在 string 与 byte slice 相互转换上优化了两点,避免了额外的内存分配:

  • 在 map[string] 中查找 key 时,使用了对应的 []byte,避免做 m[string(key)] 的内存分配
  • 使用 for range 迭代 string 转换为 []byte 的迭代:for i,v := range []byte(str) {…}

18.string 与索引操作符

对字符串用索引访问返回的不是字符,而是一个 byte 值。

这种处理方式和其他语言一样,比如 PHP 中:

  1. > php -r '$name="中文"; var_dump($name);' # "中文" 占用 6 个字节
  2. string(6) "中文"
  3. > php -r '$name="中文"; var_dump($name[0]);' # 把第一个字节当做 Unicode 字符读取,显示 U+FFFD
  4. string(1) "�"
  5. > php -r '$name="中文"; var_dump($name[0].$name[1].$name[2]);'
  6. string(3) "中"
  1. func main() {
  2. x := "ascii"
  3. fmt.Println(x[0]) // 97
  4. fmt.Printf("%T\n", x[0])// uint8
  5. }

如果需要使用 for range 迭代访问字符串中的字符(unicode code point / rune),标准库中有 "unicode/utf8" 包来做 UTF8 的相关解码编码。另外 utf8string 也有像 func (s *String) At(i int) rune 等很方便的库函数。

19.字符串并不都是 UTF8 文本

string 的值不必是 UTF8 文本,可以包含任意的值。只有字符串是文字字面值时才是 UTF8 文本,字串可以通过转义来包含其他数据。

判断字符串是否是 UTF8 文本,可使用 "unicode/utf8" 包中的 ValidString() 函数:

  1. func main() {
  2. str1 := "ABC"
  3. fmt.Println(utf8.ValidString(str1)) // true
  4. str2 := "A\xfeC"
  5. fmt.Println(utf8.ValidString(str2)) // false
  6. str3 := "A\\xfeC"
  7. fmt.Println(utf8.ValidString(str3)) // true // 把转义字符转义成字面值
  8. }

20.字符串的长度

在 Python 中:

  1. data = u'♥'
  2. print(len(data)) # 1

然而在 Go 中:

  1. func main() {
  2. char := "♥"
  3. fmt.Println(len(char)) // 3
  4. }

Go 的内建函数 len() 返回的是字符串的 byte 数量,而不是像 Python 中那样是计算 Unicode 字符数。

如果要得到字符串的字符数,可使用 "unicode/utf8" 包中的 RuneCountInString(str string) (n int)

  1. func main() {
  2. char := "♥"
  3. fmt.Println(utf8.RuneCountInString(char)) // 1
  4. }

注意: RuneCountInString 并不总是返回我们看到的字符数,因为有的字符会占用 2 个 rune:

  1. func main() {
  2. char := "é"
  3. fmt.Println(len(char)) // 3
  4. fmt.Println(utf8.RuneCountInString(char)) // 2
  5. fmt.Println("cafe\u0301") // café // 法文的 cafe,实际上是两个 rune 的组合
  6. }

21.在多行 array、slice、map 语句中缺少 , 号

  1. func main() {
  2. x := []int {
  3. 1,
  4. 2 // syntax error: unexpected newline, expecting comma or }
  5. }
  6. y := []int{1,2,}
  7. z := []int{1,2}
  8. // ...
  9. }

声明语句中 } 折叠到单行后,尾部的 , 不是必需的。

22.log.Fatal 和 log.Panic 不只是 log

log 标准库提供了不同的日志记录等级,与其他语言的日志库不同,Go 的 log 包在调用 Fatal*()Panic*() 时能做更多日志外的事,如中断程序的执行等:

  1. func main() {
  2. log.Fatal("Fatal level log: log entry") // 输出信息后,程序终止执行
  3. log.Println("Nomal level log: log entry")
  4. }

23.对内建数据结构的操作并不是同步的

尽管 Go 本身有大量的特性来支持并发,但并不保证并发的数据安全,用户需自己保证变量等数据以原子操作更新。

goroutine 和 channel 是进行原子操作的好方法,或使用 "sync" 包中的锁。

24.range 迭代 string 得到的值

range 得到的索引是字符值(Unicode point / rune)第一个字节的位置,与其他编程语言不同,这个索引并不直接是字符在字符串中的位置。

注意一个字符可能占多个 rune,比如法文单词 café 中的 é。操作特殊字符可使用norm 包。

for range 迭代会尝试将 string 翻译为 UTF8 文本,对任何无效的码点都直接使用 0XFFFD rune(�)UNicode 替代字符来表示。如果 string 中有任何非 UTF8 的数据,应将 string 保存为 byte slice 再进行操作。

  1. func main() {
  2. data := "A\xfe\x02\xff\x04"
  3. for _, v := range data {
  4. fmt.Printf("%#x ", v) // 0x41 0xfffd 0x2 0xfffd 0x4 // 错误
  5. }
  6. for _, v := range []byte(data) {
  7. fmt.Printf("%#x ", v) // 0x41 0xfe 0x2 0xff 0x4 // 正确
  8. }
  9. }

25.range 迭代 map

如果你希望以特定的顺序(如按 key 排序)来迭代 map,要注意每次迭代都可能产生不一样的结果。

Go 的运行时是有意打乱迭代顺序的,所以你得到的迭代结果可能不一致。但也并不总会打乱,得到连续相同的 5 个迭代结果也是可能的,如:

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

如果你去 Go Playground 重复运行上边的代码,输出是不会变的,只有你更新代码它才会重新编译。重新编译后迭代顺序是被打乱的:

Golang 58个坑 - 图1

26.switch 中的 fallthrough 语句

switch 语句中的 case 代码块会默认带上 break,但可以使用 fallthrough 来强制执行下一个 case 代码块。

  1. func main() {
  2. isSpace := func(char byte) bool {
  3. switch char {
  4. case ' ': // 空格符会直接 break,返回 false // 和其他语言不一样
  5. // fallthrough // 返回 true
  6. case '\t':
  7. return true
  8. }
  9. return false
  10. }
  11. fmt.Println(isSpace('\t')) // true
  12. fmt.Println(isSpace(' ')) // false
  13. }

不过你可以在 case 代码块末尾使用 fallthrough,强制执行下一个 case 代码块。

也可以改写 case 为多条件判断:

  1. func main() {
  2. isSpace := func(char byte) bool {
  3. switch char {
  4. case ' ', '\t':
  5. return true
  6. }
  7. return false
  8. }
  9. fmt.Println(isSpace('\t')) // true
  10. fmt.Println(isSpace(' ')) // true
  11. }

27.自增和自减运算

很多编程语言都自带前置后置的 ++、— 运算。但 Go 特立独行,去掉了前置操作,同时 ++、— 只作为运算符而非表达式。

  1. // 错误示例
  2. func main() {
  3. data := []int{1, 2, 3}
  4. i := 0
  5. ++i // syntax error: unexpected ++, expecting }
  6. fmt.Println(data[i++]) // syntax error: unexpected ++, expecting :
  7. }
  8. // 正确示例
  9. func main() {
  10. data := []int{1, 2, 3}
  11. i := 0
  12. i++
  13. fmt.Println(data[i]) // 2
  14. }

28.按位取反

很多编程语言使用 ~ 作为一元按位取反(NOT)操作符,Go 重用 ^ XOR 操作符来按位取反:

  1. // 错误的取反操作
  2. func main() {
  3. fmt.Println(~2) // bitwise complement operator is ^
  4. }
  5. // 正确示例
  6. func main() {
  7. var d uint8 = 2
  8. fmt.Printf("%08b\n", d) // 00000010
  9. fmt.Printf("%08b\n", ^d) // 11111101
  10. }

同时 ^ 也是按位异或(XOR)操作符。

一个操作符能重用两次,是因为一元的 NOT 操作 NOT 0x02,与二元的 XOR 操作 0x22 XOR 0xff 是一致的。

Go 也有特殊的操作符 AND NOT &^ 操作符,不同位才取1。

  1. func main() {
  2. var a uint8 = 0x82
  3. var b uint8 = 0x02
  4. fmt.Printf("%08b [A]\n", a)
  5. fmt.Printf("%08b [B]\n", b)
  6. fmt.Printf("%08b (NOT B)\n", ^b)
  7. fmt.Printf("%08b ^ %08b = %08b [B XOR 0xff]\n", b, 0xff, b^0xff)
  8. fmt.Printf("%08b ^ %08b = %08b [A XOR B]\n", a, b, a^b)
  9. fmt.Printf("%08b & %08b = %08b [A AND B]\n", a, b, a&b)
  10. fmt.Printf("%08b &^%08b = %08b [A 'AND NOT' B]\n", a, b, a&^b)
  11. fmt.Printf("%08b&(^%08b)= %08b [A AND (NOT B)]\n", a, b, a&(^b))
  12. }
  1. 10000010 [A]
  2. 00000010 [B]
  3. 11111101 (NOT B)
  4. 00000010 ^ 11111111 = 11111101 [B XOR 0xff]
  5. 10000010 ^ 00000010 = 10000000 [A XOR B]
  6. 10000010 & 00000010 = 00000010 [A AND B]
  7. 10000010 &^00000010 = 10000000 [A 'AND NOT' B]
  8. 10000010&(^00000010)= 10000000 [A AND (NOT B)]

29.运算符的优先级

除了位清除(bit clear)操作符,Go 也有很多和其他语言一样的位操作符,但优先级另当别论。

  1. func main() {
  2. fmt.Printf("0x2 & 0x2 + 0x4 -> %#x\n", 0x2&0x2+0x4) // & 优先 +
  3. //prints: 0x2 & 0x2 + 0x4 -> 0x6
  4. //Go: (0x2 & 0x2) + 0x4
  5. //C++: 0x2 & (0x2 + 0x4) -> 0x2
  6. fmt.Printf("0x2 + 0x2 << 0x1 -> %#x\n", 0x2+0x2<<0x1) // << 优先 +
  7. //prints: 0x2 + 0x2 << 0x1 -> 0x6
  8. //Go: 0x2 + (0x2 << 0x1)
  9. //C++: (0x2 + 0x2) << 0x1 -> 0x8
  10. fmt.Printf("0xf | 0x2 ^ 0x2 -> %#x\n", 0xf|0x2^0x2) // | 优先 ^
  11. //prints: 0xf | 0x2 ^ 0x2 -> 0xd
  12. //Go: (0xf | 0x2) ^ 0x2
  13. //C++: 0xf | (0x2 ^ 0x2) -> 0xf
  14. }

优先级列表:

  1. Precedence Operator
  2. 5 * / % << >> & &^
  3. 4 + - | ^
  4. 3 == != < <= > >=
  5. 2 &&
  6. 1 ||

30.不导出的 struct 字段无法被 encode

以小写字母开头的字段成员是无法被外部直接访问的,所以 struct 在进行 json、xml、gob 等格式的 encode 操作时,这些私有字段会被忽略,导出时得到零值:

  1. func main() {
  2. in := MyData{1, "two"}
  3. fmt.Printf("%#v\n", in) // main.MyData{One:1, two:"two"}
  4. encoded, _ := json.Marshal(in)
  5. fmt.Println(string(encoded)) // {"One":1} // 私有字段 two 被忽略了
  6. var out MyData
  7. json.Unmarshal(encoded, &out)
  8. fmt.Printf("%#v\n", out) // main.MyData{One:1, two:""}
  9. }

31.程序退出时还有 goroutine 在执行

程序默认不等所有 goroutine 都执行完才退出,这点需要特别注意:

  1. // 主程序会直接退出
  2. func main() {
  3. workerCount := 2
  4. for i := 0; i < workerCount; i++ {
  5. go doIt(i)
  6. }
  7. time.Sleep(1 * time.Second)
  8. fmt.Println("all done!")
  9. }
  10. func doIt(workerID int) {
  11. fmt.Printf("[%v] is running\n", workerID)
  12. time.Sleep(3 * time.Second) // 模拟 goroutine 正在执行
  13. fmt.Printf("[%v] is done\n", workerID)
  14. }

如下,main() 主程序不等两个 goroutine 执行完就直接退出了:

Golang 58个坑 - 图2

常用解决办法:使用 "WaitGroup" 变量,它会让主程序等待所有 goroutine 执行完毕再退出。

如果你的 goroutine 要做消息的循环处理等耗时操作,可以向它们发送一条 kill 消息来关闭它们。或直接关闭一个它们都等待接收数据的 channel:

  1. // www.topgoer.com go语言中文文档
  2. // 等待所有 goroutine 执行完毕
  3. // 进入死锁
  4. func main() {
  5. var wg sync.WaitGroup
  6. done := make(chan struct{})
  7. workerCount := 2
  8. for i := 0; i < workerCount; i++ {
  9. wg.Add(1)
  10. go doIt(i, done, wg)
  11. }
  12. close(done)
  13. wg.Wait()
  14. fmt.Println("all done!")
  15. }
  16. func doIt(workerID int, done <-chan struct{}, wg sync.WaitGroup) {
  17. fmt.Printf("[%v] is running\n", workerID)
  18. defer wg.Done()
  19. <-done
  20. fmt.Printf("[%v] is done\n", workerID)
  21. }

执行结果:

Golang 58个坑 - 图3

看起来好像 goroutine 都执行完了,然而报错:

fatal error: all goroutines are asleep - deadlock!

为什么会发生死锁?goroutine 在退出前调用了 wg.Done() ,程序应该正常退出的。

原因是 goroutine 得到的 "WaitGroup" 变量是 var wg WaitGroup 的一份拷贝值,即 doIt() 传参只传值。所以哪怕在每个 goroutine 中都调用了 wg.Done(), 主程序中的 wg 变量并不会受到影响。

  1. // www.topgoer.com go语言中文文档
  2. // 等待所有 goroutine 执行完毕
  3. // 使用传址方式为 WaitGroup 变量传参
  4. // 使用 channel 关闭 goroutine
  5. func main() {
  6. var wg sync.WaitGroup
  7. done := make(chan struct{})
  8. ch := make(chan interface{})
  9. workerCount := 2
  10. for i := 0; i < workerCount; i++ {
  11. wg.Add(1)
  12. go doIt(i, ch, done, &wg) // wg 传指针,doIt() 内部会改变 wg 的值
  13. }
  14. for i := 0; i < workerCount; i++ { // 向 ch 中发送数据,关闭 goroutine
  15. ch <- i
  16. }
  17. close(done)
  18. wg.Wait()
  19. close(ch)
  20. fmt.Println("all done!")
  21. }
  22. func doIt(workerID int, ch <-chan interface{}, done <-chan struct{}, wg *sync.WaitGroup) {
  23. fmt.Printf("[%v] is running\n", workerID)
  24. defer wg.Done()
  25. for {
  26. select {
  27. case m := <-ch:
  28. fmt.Printf("[%v] m => %v\n", workerID, m)
  29. case <-done:
  30. fmt.Printf("[%v] is done\n", workerID)
  31. return
  32. }
  33. }
  34. }

运行效果:

Golang 58个坑 - 图4

32.向无缓冲的 channel 发送数据,只要 receiver 准备好了就会立刻返回

只有在数据被 receiver 处理时,sender 才会阻塞。因运行环境而异,在 sender 发送完数据后,receiver 的 goroutine 可能没有足够的时间处理下一个数据。如:

  1. func main() {
  2. ch := make(chan string)
  3. go func() {
  4. for m := range ch {
  5. fmt.Println("Processed:", m)
  6. time.Sleep(1 * time.Second) // 模拟需要长时间运行的操作
  7. }
  8. }()
  9. ch <- "cmd.1"
  10. ch <- "cmd.2" // 不会被接收处理
  11. }

运行效果:

Golang 58个坑 - 图5

33.向已关闭的 channel 发送数据会造成 panic

从已关闭的 channel 接收数据是安全的:

接收状态值 ok 是 false 时表明 channel 中已没有数据可以接收了。类似的,从有缓冲的 channel 中接收数据,缓存的数据获取完再没有数据可取时,状态值也是 false

向已关闭的 channel 中发送数据会造成 panic:

Golang 58个坑 - 图6

针对上边有 bug 的这个例子,可使用一个废弃 channel done 来告诉剩余的 goroutine 无需再向 ch 发送数据。此时 <- done 的结果是 {}:

  1. func main() {
  2. ch := make(chan int)
  3. done := make(chan struct{})
  4. for i := 0; i < 3; i++ {
  5. go func(idx int) {
  6. select {
  7. case ch <- (idx + 1) * 2:
  8. fmt.Println(idx, "Send result")
  9. case <-done:
  10. fmt.Println(idx, "Exiting")
  11. }
  12. }(i)
  13. }
  14. fmt.Println("Result: ", <-ch)
  15. close(done)
  16. time.Sleep(3 * time.Second)
  17. }

运行效果:

Golang 58个坑 - 图7

34.使用了值为 nil 的 channel

在一个值为 nil 的 channel 上发送和接收数据将永久阻塞:

  1. func main() {
  2. var ch chan int // 未初始化,值为 nil
  3. for i := 0; i < 3; i++ {
  4. go func(i int) {
  5. ch <- i
  6. }(i)
  7. }
  8. fmt.Println("Result: ", <-ch)
  9. time.Sleep(2 * time.Second)
  10. }

runtime 死锁错误:

fatal error: all goroutines are asleep - deadlock! goroutine 1 [chan receive (nil chan)]

利用这个死锁的特性,可以用在 select 中动态的打开和关闭 case 语句块:

  1. func main() {
  2. inCh := make(chan int)
  3. outCh := make(chan int)
  4. go func() {
  5. var in <-chan int = inCh
  6. var out chan<- int
  7. var val int
  8. for {
  9. select {
  10. case out <- val:
  11. println("--------")
  12. out = nil
  13. in = inCh
  14. case val = <-in:
  15. println("++++++++++")
  16. out = outCh
  17. in = nil
  18. }
  19. }
  20. }()
  21. go func() {
  22. for r := range outCh {
  23. fmt.Println("Result: ", r)
  24. }
  25. }()
  26. time.Sleep(0)
  27. inCh <- 1
  28. inCh <- 2
  29. time.Sleep(3 * time.Second)
  30. }

运行效果:

Golang 58个坑 - 图8

35.若函数 receiver 传参是传值方式,则无法修改参数的原有值

方法 receiver 的参数与一般函数的参数类似:如果声明为值,那方法体得到的是一份参数的值拷贝,此时对参数的任何修改都不会对原有值产生影响。

除非 receiver 参数是 map 或 slice 类型的变量,并且是以指针方式更新 map 中的字段、slice 中的元素的,才会更新原有值:

  1. type data struct {
  2. num int
  3. key *string
  4. items map[string]bool
  5. }
  6. func (this *data) pointerFunc() {
  7. this.num = 7
  8. }
  9. func (this data) valueFunc() {
  10. this.num = 8
  11. *this.key = "valueFunc.key"
  12. this.items["valueFunc"] = true
  13. }
  14. func main() {
  15. key := "key1"
  16. d := data{1, &key, make(map[string]bool)}
  17. fmt.Printf("num=%v key=%v items=%v\n", d.num, *d.key, d.items)
  18. d.pointerFunc() // 修改 num 的值为 7
  19. fmt.Printf("num=%v key=%v items=%v\n", d.num, *d.key, d.items)
  20. d.valueFunc() // 修改 key 和 items 的值
  21. fmt.Printf("num=%v key=%v items=%v\n", d.num, *d.key, d.items)
  22. }

运行结果:

Golang 58个坑 - 图9

1.1.2. 中级篇:36-51

36.关闭 HTTP 的响应体

使用 HTTP 标准库发起请求、获取响应时,即使你不从响应中读取任何数据或响应为空,都需要手动关闭响应体。新手很容易忘记手动关闭,或者写在了错误的位置:

  1. // 请求失败造成 panic
  2. func main() {
  3. resp, err := http.Get("https://api.ipify.org?format=json")
  4. defer resp.Body.Close() // resp 可能为 nil,不能读取 Body
  5. if err != nil {
  6. fmt.Println(err)
  7. return
  8. }
  9. body, err := ioutil.ReadAll(resp.Body)
  10. checkError(err)
  11. fmt.Println(string(body))
  12. }
  13. func checkError(err error) {
  14. if err != nil{
  15. log.Fatalln(err)
  16. }
  17. }

上边的代码能正确发起请求,但是一旦请求失败,变量 resp 值为 nil,造成 panic:

panic: runtime error: invalid memory address or nil pointer dereference

应该先检查 HTTP 响应错误为 nil,再调用 resp.Body.Close() 来关闭响应体:

  1. // 大多数情况正确的示例
  2. func main() {
  3. resp, err := http.Get("https://api.ipify.org?format=json")
  4. checkError(err)
  5. defer resp.Body.Close() // 绝大多数情况下的正确关闭方式
  6. body, err := ioutil.ReadAll(resp.Body)
  7. checkError(err)
  8. fmt.Println(string(body))
  9. }

输出:

  1. Get https://api.ipify.org?format=...: x509: certificate signed by unknown authority

绝大多数请求失败的情况下,resp 的值为 nil 且 err 为 non-nil。但如果你得到的是重定向错误,那它俩的值都是 non-nil,最后依旧可能发生内存泄露。2 个解决办法:

  • 可以直接在处理 HTTP 响应错误的代码块中,直接关闭非 nil 的响应体。
  • 手动调用 defer 来关闭响应体:
  1. // 正确示例
  2. func main() {
  3. resp, err := http.Get("http://www.baidu.com")
  4. // 关闭 resp.Body 的正确姿势
  5. if resp != nil {
  6. defer resp.Body.Close()
  7. }
  8. checkError(err)
  9. defer resp.Body.Close()
  10. body, err := ioutil.ReadAll(resp.Body)
  11. checkError(err)
  12. fmt.Println(string(body))
  13. }

resp.Body.Close() 早先版本的实现是读取响应体的数据之后丢弃,保证了 keep-alive 的 HTTP 连接能重用处理不止一个请求。但 Go 的最新版本将读取并丢弃数据的任务交给了用户,如果你不处理,HTTP 连接可能会直接关闭而非重用,参考在 Go 1.5 版本文档。

如果程序大量重用 HTTP 长连接,你可能要在处理响应的逻辑代码中加入:

  1. _, err = io.Copy(ioutil.Discard, resp.Body) // 手动丢弃读取完毕的数据

如果你需要完整读取响应,上边的代码是需要写的。比如在解码 API 的 JSON 响应数据:

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

37.关闭 HTTP 连接

一些支持 HTTP1.1 或 HTTP1.0 配置了 connection: keep-alive 选项的服务器会保持一段时间的长连接。但标准库 "net/http" 的连接默认只在服务器主动要求关闭时才断开,所以你的程序可能会消耗完 socket 描述符。解决办法有 2 个,请求结束后:

  • 直接设置请求变量的 Close 字段值为 true,每次请求结束后就会主动关闭连接。
  • 设置 Header 请求头部选项 Connection: close,然后服务器返回的响应头部也会有这个选项,此时 HTTP 标准库会主动断开连接。
  1. // 主动关闭连接
  2. func main() {
  3. req, err := http.NewRequest("GET", "http://golang.org", nil)
  4. checkError(err)
  5. req.Close = true
  6. //req.Header.Add("Connection", "close") // 等效的关闭方式
  7. resp, err := http.DefaultClient.Do(req)
  8. if resp != nil {
  9. defer resp.Body.Close()
  10. }
  11. checkError(err)
  12. body, err := ioutil.ReadAll(resp.Body)
  13. checkError(err)
  14. fmt.Println(string(body))
  15. }

你可以创建一个自定义配置的 HTTP transport 客户端,用来取消 HTTP 全局的复用连接:

  1. func main() {
  2. tr := http.Transport{DisableKeepAlives: true}
  3. client := http.Client{Transport: &tr}
  4. resp, err := client.Get("https://golang.google.cn/")
  5. if resp != nil {
  6. defer resp.Body.Close()
  7. }
  8. checkError(err)
  9. fmt.Println(resp.StatusCode) // 200
  10. body, err := ioutil.ReadAll(resp.Body)
  11. checkError(err)
  12. fmt.Println(len(string(body)))
  13. }

根据需求选择使用场景:

  • 若你的程序要向同一服务器发大量请求,使用默认的保持长连接。
  • 若你的程序要连接大量的服务器,且每台服务器只请求一两次,那收到请求后直接关闭连接。或增加最大文件打开数 fs.file-max 的值。

38.将 JSON 中的数字解码为 interface 类型

在 encode/decode JSON 数据时,Go 默认会将数值当做 float64 处理,比如下边的代码会造成 panic:

  1. func main() {
  2. var data = []byte(`{"status": 200}`)
  3. var result map[string]interface{}
  4. if err := json.Unmarshal(data, &result); err != nil {
  5. log.Fatalln(err)
  6. }
  7. fmt.Printf("%T\n", result["status"]) // float64
  8. var status = result["status"].(int) // 类型断言错误
  9. fmt.Println("Status value: ", status)
  10. }

panic: interface conversion: interface {} is float64, not int

如果你尝试 decode 的 JSON 字段是整型,你可以:

  • 将 int 值转为 float 统一使用
  • 将 decode 后需要的 float 值转为 int 使用
  1. // 将 decode 的值转为 int 使用
  2. func main() {
  3. var data = []byte(`{"status": 200}`)
  4. var result map[string]interface{}
  5. if err := json.Unmarshal(data, &result); err != nil {
  6. log.Fatalln(err)
  7. }
  8. var status = uint64(result["status"].(float64))
  9. fmt.Println("Status value: ", status)
  10. }
  • 使用 Decoder 类型来 decode JSON 数据,明确表示字段的值类型
  1. // 指定字段类型
  2. func main() {
  3. var data = []byte(`{"status": 200}`)
  4. var result map[string]interface{}
  5. var decoder = json.NewDecoder(bytes.NewReader(data))
  6. decoder.UseNumber()
  7. if err := decoder.Decode(&result); err != nil {
  8. log.Fatalln(err)
  9. }
  10. var status, _ = result["status"].(json.Number).Int64()
  11. fmt.Println("Status value: ", status)
  12. }
  13. // 你可以使用 string 来存储数值数据,在 decode 时再决定按 int 还是 float 使用
  14. // 将数据转为 decode 为 string
  15. func main() {
  16. var data = []byte({"status": 200})
  17. var result map[string]interface{}
  18. var decoder = json.NewDecoder(bytes.NewReader(data))
  19. decoder.UseNumber()
  20. if err := decoder.Decode(&result); err != nil {
  21. log.Fatalln(err)
  22. }
  23. var status uint64
  24. err := json.Unmarshal([]byte(result["status"].(json.Number).String()), &status);
  25. checkError(err)
  26. fmt.Println("Status value: ", status)
  27. }

使用 struct 类型将你需要的数据映射为数值型

  1. // struct 中指定字段类型
  2. func main() {
  3. var data = []byte(`{"status": 200}`)
  4. var result struct {
  5. Status uint64 `json:"status"`
  6. }
  7. err := json.NewDecoder(bytes.NewReader(data)).Decode(&result)
  8. checkError(err)
  9. fmt.Printf("Result: %+v", result)
  10. }
  • 可以使用 struct 将数值类型映射为 json.RawMessage 原生数据类型 适用于如果 JSON 数据不着急 decode 或 JSON 某个字段的值类型不固定等情况:
  1. // 状态名称可能是 int 也可能是 string,指定为 json.RawMessage 类型
  2. func main() {
  3. records := [][]byte{
  4. []byte(`{"status":200, "tag":"one"}`),
  5. []byte(`{"status":"ok", "tag":"two"}`),
  6. }
  7. for idx, record := range records {
  8. var result struct {
  9. StatusCode uint64
  10. StatusName string
  11. Status json.RawMessage `json:"status"`
  12. Tag string `json:"tag"`
  13. }
  14. err := json.NewDecoder(bytes.NewReader(record)).Decode(&result)
  15. checkError(err)
  16. var name string
  17. err = json.Unmarshal(result.Status, &name)
  18. if err == nil {
  19. result.StatusName = name
  20. }
  21. var code uint64
  22. err = json.Unmarshal(result.Status, &code)
  23. if err == nil {
  24. result.StatusCode = code
  25. }
  26. fmt.Printf("[%v] result => %+v\n", idx, result)
  27. }

39.struct、array、slice 和 map 的值比较

可以使用相等运算符 == 来比较结构体变量,前提是两个结构体的成员都是可比较的类型:

  1. type data struct {
  2. num int
  3. fp float32
  4. complex complex64
  5. str string
  6. char rune
  7. yes bool
  8. events <-chan string
  9. handler interface{}
  10. ref *byte
  11. raw [10]byte
  12. }
  13. func main() {
  14. v1 := data{}
  15. v2 := data{}
  16. fmt.Println("v1 == v2: ", v1 == v2) // true
  17. }

如果两个结构体中有任意成员是不可比较的,将会造成编译错误。注意数组成员只有在数组元素可比较时候才可比较。

  1. type data struct {
  2. num int
  3. checks [10]func() bool // 无法比较
  4. doIt func() bool // 无法比较
  5. m map[string]string // 无法比较
  6. bytes []byte // 无法比较
  7. }
  8. func main() {
  9. v1 := data{}
  10. v2 := data{}
  11. fmt.Println("v1 == v2: ", v1 == v2)
  12. }

invalid operation: v1 == v2 (struct containing [10]func() bool cannot be compared)

Go 提供了一些库函数来比较那些无法使用 == 比较的变量,比如使用 "reflect" 包的 DeepEqual() :

  1. // 比较相等运算符无法比较的元素
  2. func main() {
  3. v1 := data{}
  4. v2 := data{}
  5. fmt.Println("v1 == v2: ", reflect.DeepEqual(v1, v2)) // true
  6. m1 := map[string]string{"one": "a", "two": "b"}
  7. m2 := map[string]string{"two": "b", "one": "a"}
  8. fmt.Println("v1 == v2: ", reflect.DeepEqual(m1, m2)) // true
  9. s1 := []int{1, 2, 3}
  10. s2 := []int{1, 2, 3}
  11. // 注意两个 slice 相等,值和顺序必须一致
  12. fmt.Println("v1 == v2: ", reflect.DeepEqual(s1, s2)) // true
  13. }

这种比较方式可能比较慢,根据你的程序需求来使用。DeepEqual() 还有其他用法:

  1. func main() {
  2. var b1 []byte = nil
  3. b2 := []byte{}
  4. fmt.Println("b1 == b2: ", reflect.DeepEqual(b1, b2)) // false
  5. }

注意:

  • DeepEqual() 并不总适合于比较 slice
  1. func main() {
  2. var str = "one"
  3. var in interface{} = "one"
  4. fmt.Println("str == in: ", reflect.DeepEqual(str, in)) // true
  5. v1 := []string{"one", "two"}
  6. v2 := []string{"two", "one"}
  7. fmt.Println("v1 == v2: ", reflect.DeepEqual(v1, v2)) // false
  8. data := map[string]interface{}{
  9. "code": 200,
  10. "value": []string{"one", "two"},
  11. }
  12. encoded, _ := json.Marshal(data)
  13. var decoded map[string]interface{}
  14. json.Unmarshal(encoded, &decoded)
  15. fmt.Println("data == decoded: ", reflect.DeepEqual(data, decoded)) // false
  16. }

如果要大小写不敏感来比较 byte 或 string 中的英文文本,可以使用 "bytes" 或 "strings" 包的 ToUpper() 和 ToLower() 函数。比较其他语言的 byte 或 string,应使用 bytes.EqualFold() 和 strings.EqualFold()

如果 byte slice 中含有验证用户身份的数据(密文哈希、token 等),不应再使用 reflect.DeepEqual()、bytes.Equal()、 bytes.Compare()。这三个函数容易对程序造成 timing attacks,此时应使用 "crypto/subtle" 包中的 subtle.ConstantTimeCompare() 等函数

  • reflect.DeepEqual() 认为空 slice 与 nil slice 并不相等,但注意 byte.Equal() 会认为二者相等:
  1. func main() {
  2. var b1 []byte = nil
  3. b2 := []byte{}
  4. // b1 与 b2 长度相等、有相同的字节序
  5. // nil 与 slice 在字节上是相同的
  6. fmt.Println("b1 == b2: ", bytes.Equal(b1, b2)) // true
  7. }

40.从 panic 中恢复

在一个 defer 延迟执行的函数中调用 recover() ,它便能捕捉 / 中断 panic

  1. // 错误的 recover 调用示例
  2. func main() {
  3. recover() // 什么都不会捕捉
  4. panic("not good") // 发生 panic,主程序退出
  5. recover() // 不会被执行
  6. println("ok")
  7. }
  8. // 正确的 recover 调用示例
  9. func main() {
  10. defer func() {
  11. fmt.Println("recovered: ", recover())
  12. }()
  13. panic("not good")
  14. }

从上边可以看出,recover() 仅在 defer 执行的函数中调用才会生效。

  1. // 错误的调用示例
  2. func main() {
  3. defer func() {
  4. doRecover()
  5. }()
  6. panic("not good")
  7. }
  8. func doRecover() {
  9. fmt.Println("recobered: ", recover())
  10. }

recobered: panic: not good

41.在 range 迭代 slice、array、map 时通过更新引用来更新元素

在 range 迭代中,得到的值其实是元素的一份值拷贝,更新拷贝并不会更改原来的元素,即是拷贝的地址并不是原有元素的地址:

  1. func main() {
  2. data := []int{1, 2, 3}
  3. for _, v := range data {
  4. v *= 10 // data 中原有元素是不会被修改的
  5. }
  6. fmt.Println("data: ", data) // data: [1 2 3]
  7. }

如果要修改原有元素的值,应该使用索引直接访问:

  1. func main() {
  2. data := []int{1, 2, 3}
  3. for i, v := range data {
  4. data[i] = v * 10
  5. }
  6. fmt.Println("data: ", data) // data: [10 20 30]
  7. }

如果你的集合保存的是指向值的指针,需稍作修改。依旧需要使用索引访问元素,不过可以使用 range 出来的元素直接更新原有值:

  1. func main() {
  2. data := []*struct{ num int }{{1}, {2}, {3},}
  3. for _, v := range data {
  4. v.num *= 10 // 直接使用指针更新
  5. }
  6. fmt.Println(data[0], data[1], data[2]) // &{10} &{20} &{30}
  7. }

42.slice 中隐藏的数据

从 slice 中重新切出新 slice 时,新 slice 会引用原 slice 的底层数组。如果跳了这个坑,程序可能会分配大量的临时 slice 来指向原底层数组的部分数据,将导致难以预料的内存使用。

  1. func get() []byte {
  2. raw := make([]byte, 10000)
  3. fmt.Println(len(raw), cap(raw), &raw[0]) // 10000 10000 0xc420080000
  4. return raw[:3] // 重新分配容量为 10000 的 slice
  5. }
  6. func main() {
  7. data := get()
  8. fmt.Println(len(data), cap(data), &data[0]) // 3 10000 0xc420080000
  9. }

可以通过拷贝临时 slice 的数据,而不是重新切片来解决:

  1. func get() (res []byte) {
  2. raw := make([]byte, 10000)
  3. fmt.Println(len(raw), cap(raw), &raw[0]) // 10000 10000 0xc420080000
  4. res = make([]byte, 3)
  5. copy(res, raw[:3])
  6. return
  7. }
  8. func main() {
  9. data := get()
  10. fmt.Println(len(data), cap(data), &data[0]) // 3 3 0xc4200160b8
  11. }

43.Slice 中数据的误用

举个简单例子,重写文件路径(存储在 slice 中)

分割路径来指向每个不同级的目录,修改第一个目录名再重组子目录名,创建新路径:

  1. // 错误使用 slice 的拼接示例
  2. func main() {
  3. path := []byte("AAAA/BBBBBBBBB")
  4. sepIndex := bytes.IndexByte(path, '/') // 4
  5. println(sepIndex)
  6. dir1 := path[:sepIndex]
  7. dir2 := path[sepIndex+1:]
  8. println("dir1: ", string(dir1)) // AAAA
  9. println("dir2: ", string(dir2)) // BBBBBBBBB
  10. dir1 = append(dir1, "suffix"...)
  11. println("current path: ", string(path)) // AAAAsuffixBBBB
  12. path = bytes.Join([][]byte{dir1, dir2}, []byte{'/'})
  13. println("dir1: ", string(dir1)) // AAAAsuffix
  14. println("dir2: ", string(dir2)) // uffixBBBB
  15. println("new path: ", string(path)) // AAAAsuffix/uffixBBBB // 错误结果
  16. }

拼接的结果不是正确的 AAAAsuffix/BBBBBBBBB,因为 dir1、 dir2 两个 slice 引用的数据都是 path 的底层数组,第 13 行修改 dir1 同时也修改了 path,也导致了 dir2 的修改

解决方法:

  • 重新分配新的 slice 并拷贝你需要的数据
  • 使用完整的 slice 表达式:input[low:high:max],容量便调整为 max - low
  1. // 使用 full slice expression
  2. func main() {
  3. path := []byte("AAAA/BBBBBBBBB")
  4. sepIndex := bytes.IndexByte(path, '/') // 4
  5. dir1 := path[:sepIndex:sepIndex] // 此时 cap(dir1) 指定为4, 而不是先前的 16
  6. dir2 := path[sepIndex+1:]
  7. dir1 = append(dir1, "suffix"...)
  8. path = bytes.Join([][]byte{dir1, dir2}, []byte{'/'})
  9. println("dir1: ", string(dir1)) // AAAAsuffix
  10. println("dir2: ", string(dir2)) // BBBBBBBBB
  11. println("new path: ", string(path)) // AAAAsuffix/BBBBBBBBB
  12. }

第 6 行中第三个参数是用来控制 dir1 的新容量,再往 dir1 中 append 超额元素时,将分配新的 buffer 来保存。而不是覆盖原来的 path 底层数组

44.旧 slice

当你从一个已存在的 slice 创建新 slice 时,二者的数据指向相同的底层数组。如果你的程序使用这个特性,那需要注意 "旧"(stale) slice 问题。

某些情况下,向一个 slice 中追加元素而它指向的底层数组容量不足时,将会重新分配一个新数组来存储数据。而其他 slice 还指向原来的旧底层数组。

  1. // 超过容量将重新分配数组来拷贝值、重新存储
  2. func main() {
  3. s1 := []int{1, 2, 3}
  4. fmt.Println(len(s1), cap(s1), s1) // 3 3 [1 2 3 ]
  5. s2 := s1[1:]
  6. fmt.Println(len(s2), cap(s2), s2) // 2 2 [2 3]
  7. for i := range s2 {
  8. s2[i] += 20
  9. }
  10. // 此时的 s1 与 s2 是指向同一个底层数组的
  11. fmt.Println(s1) // [1 22 23]
  12. fmt.Println(s2) // [22 23]
  13. s2 = append(s2, 4) // 向容量为 2 的 s2 中再追加元素,此时将分配新数组来存
  14. for i := range s2 {
  15. s2[i] += 10
  16. }
  17. fmt.Println(s1) // [1 22 23] // 此时的 s1 不再更新,为旧数据
  18. fmt.Println(s2) // [32 33 14]
  19. }

45.类型声明与方法

从一个现有的非 interface 类型创建新类型时,并不会继承原有的方法:

  1. // 定义 Mutex 的自定义类型
  2. type myMutex sync.Mutex
  3. func main() {
  4. var mtx myMutex
  5. mtx.Lock()
  6. mtx.UnLock()
  7. }

mtx.Lock undefined (type myMutex has no field or method Lock)…

如果你需要使用原类型的方法,可将原类型以匿名字段的形式嵌到你定义的新 struct 中:

  1. // 类型以字段形式直接嵌入
  2. type myLocker struct {
  3. sync.Mutex
  4. }
  5. func main() {
  6. var locker myLocker
  7. locker.Lock()
  8. locker.Unlock()
  9. }

interface 类型声明也保留它的方法集:

  1. type myLocker sync.Locker
  2. func main() {
  3. var locker myLocker
  4. locker.Lock()
  5. locker.Unlock()
  6. }

46.跳出 for-switch 和 for-select 代码块

没有指定标签的 break 只会跳出 switch/select 语句,若不能使用 return 语句跳出的话,可为 break 跳出标签指定的代码块:

  1. // break 配合 label 跳出指定代码块
  2. func main() {
  3. loop:
  4. for {
  5. switch {
  6. case true:
  7. fmt.Println("breaking out...")
  8. //break // 死循环,一直打印 breaking out...
  9. break loop
  10. }
  11. }
  12. fmt.Println("out...")
  13. }

goto 虽然也能跳转到指定位置,但依旧会再次进入 for-switch,死循环。

47.for 语句中的迭代变量与闭包函数

for 语句中的迭代变量在每次迭代中都会重用,即 for 中创建的闭包函数接收到的参数始终是同一个变量,在 goroutine 开始执行时都会得到同一个迭代值:

  1. func main() {
  2. data := []string{"one", "two", "three"}
  3. for _, v := range data {
  4. go func() {
  5. fmt.Println(v)
  6. }()
  7. }
  8. time.Sleep(3 * time.Second)
  9. // 输出 three three three
  10. }

最简单的解决方法:无需修改 goroutine 函数,在 for 内部使用局部变量保存迭代值,再传参:

  1. func main() {
  2. data := []string{"one", "two", "three"}
  3. for _, v := range data {
  4. vCopy := v
  5. go func() {
  6. fmt.Println(vCopy)
  7. }()
  8. }
  9. time.Sleep(3 * time.Second)
  10. // 输出 one two three
  11. }

另一个解决方法:直接将当前的迭代值以参数形式传递给匿名函数:

  1. func main() {
  2. data := []string{"one", "two", "three"}
  3. for _, v := range data {
  4. go func(in string) {
  5. fmt.Println(in)
  6. }(v)
  7. }
  8. time.Sleep(3 * time.Second)
  9. // 输出 one two three
  10. }

注意下边这个稍复杂的 3 个示例区别:

  1. type field struct {
  2. name string
  3. }
  4. func (p *field) print() {
  5. fmt.Println(p.name)
  6. }
  7. // 错误示例
  8. func main() {
  9. data := []field{{"one"}, {"two"}, {"three"}}
  10. for _, v := range data {
  11. go v.print()
  12. }
  13. time.Sleep(3 * time.Second)
  14. // 输出 three three three
  15. }
  16. // 正确示例
  17. func main() {
  18. data := []field{{"one"}, {"two"}, {"three"}}
  19. for _, v := range data {
  20. v := v
  21. go v.print()
  22. }
  23. time.Sleep(3 * time.Second)
  24. // 输出 one two three
  25. }
  26. // 正确示例
  27. func main() {
  28. data := []*field{{"one"}, {"two"}, {"three"}}
  29. for _, v := range data { // 此时迭代值 v 是三个元素值的地址,每次 v 指向的值不同
  30. go v.print()
  31. }
  32. time.Sleep(3 * time.Second)
  33. // 输出 one two three
  34. }

48.defer 函数的参数值

对 defer 延迟执行的函数,它的参数会在声明时候就会求出具体值,而不是在执行时才求值:

  1. // 在 defer 函数中参数会提前求值
  2. func main() {
  3. var i = 1
  4. defer fmt.Println("result: ", func() int { return i * 2 }())
  5. i++
  6. }

result: 2

49.defer 函数的执行时机

对 defer 延迟执行的函数,会在调用它的函数结束时执行,而不是在调用它的语句块结束时执行,注意区分开。

比如在一个长时间执行的函数里,内部 for 循环中使用 defer 来清理每次迭代产生的资源调用,就会出现问题:

  1. // www.topgoer.com go语言中文文档
  2. // 命令行参数指定目录名
  3. // 遍历读取目录下的文件
  4. func main() {
  5. if len(os.Args) != 2 {
  6. os.Exit(1)
  7. }
  8. dir := os.Args[1]
  9. start, err := os.Stat(dir)
  10. if err != nil || !start.IsDir() {
  11. os.Exit(2)
  12. }
  13. var targets []string
  14. filepath.Walk(dir, func(fPath string, fInfo os.FileInfo, err error) error {
  15. if err != nil {
  16. return err
  17. }
  18. if !fInfo.Mode().IsRegular() {
  19. return nil
  20. }
  21. targets = append(targets, fPath)
  22. return nil
  23. })
  24. for _, target := range targets {
  25. f, err := os.Open(target)
  26. if err != nil {
  27. fmt.Println("bad target:", target, "error:", err) //error:too many open files
  28. break
  29. }
  30. defer f.Close() // 在每次 for 语句块结束时,不会关闭文件资源
  31. // 使用 f 资源
  32. }
  33. }

先创建 10000 个文件:

  1. #!/bin/bash
  2. for n in {1..10000}; do
  3. echo content > "file${n}.txt"
  4. done

运行效果:

Golang 58个坑 - 图10

解决办法:defer 延迟执行的函数写入匿名函数中:

  1. // 目录遍历正常
  2. func main() {
  3. // ...
  4. for _, target := range targets {
  5. func() {
  6. f, err := os.Open(target)
  7. if err != nil {
  8. fmt.Println("bad target:", target, "error:", err)
  9. return // 在匿名函数内使用 return 代替 break 即可
  10. }
  11. defer f.Close() // 匿名函数执行结束,调用关闭文件资源
  12. // 使用 f 资源
  13. }()
  14. }
  15. }

当然你也可以去掉 defer,在文件资源使用完毕后,直接调用 f.Close() 来关闭。

50.失败的类型断言

在类型断言语句中,断言失败则会返回目标类型的“零值”,断言变量与原来变量混用可能出现异常情况:

  1. // 错误示例
  2. func main() {
  3. var data interface{} = "great"
  4. // data 混用
  5. if data, ok := data.(int); ok {
  6. fmt.Println("[is an int], data: ", data)
  7. } else {
  8. fmt.Println("[not an int], data: ", data) // [isn't a int], data: 0
  9. }
  10. }
  11. // 正确示例
  12. func main() {
  13. var data interface{} = "great"
  14. if res, ok := data.(int); ok {
  15. fmt.Println("[is an int], data: ", res)
  16. } else {
  17. fmt.Println("[not an int], data: ", data) // [not an int], data: great
  18. }
  19. }

51.阻塞的 gorutinue 与资源泄露

在 2012 年 Google I/O 大会上,Rob Pike 的 Go Concurrency Patterns 演讲讨论 Go 的几种基本并发模式,如 完整代码 中从数据集中获取第一条数据的函数:

  1. func First(query string, replicas []Search) Result {
  2. c := make(chan Result)
  3. replicaSearch := func(i int) { c <- replicas[i](query) }
  4. for i := range replicas {
  5. go replicaSearch(i)
  6. }
  7. return <-c
  8. }

在搜索重复时依旧每次都起一个 goroutine 去处理,每个 goroutine 都把它的搜索结果发送到结果 channel 中,channel 中收到的第一条数据会直接返回。

返回完第一条数据后,其他 goroutine 的搜索结果怎么处理?他们自己的协程如何处理?

在 First() 中的结果 channel 是无缓冲的,这意味着只有第一个 goroutine 能返回,由于没有 receiver,其他的 goroutine 会在发送上一直阻塞。如果你大量调用,则可能造成资源泄露。

为避免泄露,你应该确保所有的 goroutine 都能正确退出,有 2 个解决方法:

  • 使用带缓冲的 channel,确保能接收全部 goroutine 的返回结果:
  1. func First(query string, replicas ...Search) Result {
  2. c := make(chan Result,len(replicas))
  3. searchReplica := func(i int) { c <- replicas[i](query) }
  4. for i := range replicas {
  5. go searchReplica(i)
  6. }
  7. return <-c
  8. }
  • 使用 select 语句,配合能保存一个缓冲值的 channel default 语句: default 的缓冲 channel 保证了即使结果 channel 收不到数据,也不会阻塞 goroutine
  1. func First(query string, replicas ...Search) Result {
  2. c := make(chan Result,1)
  3. searchReplica := func(i int) {
  4. select {
  5. case c <- replicas[i](query):
  6. default:
  7. }
  8. }
  9. for i := range replicas {
  10. go searchReplica(i)
  11. }
  12. return <-c
  13. }
  • 使用特殊的废弃(cancellation) channel 来中断剩余 goroutine 的执行:
  1. func First(query string, replicas ...Search) Result {
  2. c := make(chan Result)
  3. done := make(chan struct{})
  4. defer close(done)
  5. searchReplica := func(i int) {
  6. select {
  7. case c <- replicas[i](query):
  8. case <- done:
  9. }
  10. }
  11. for i := range replicas {
  12. go searchReplica(i)
  13. }
  14. return <-c
  15. }

Rob Pike 为了简化演示,没有提及演讲代码中存在的这些问题。不过对于新手来说,可能会不加思考直接使用。

1.1.3. 高级篇:52-58

52.使用指针作为方法的 receiver

只要值是可寻址的,就可以在值上直接调用指针方法。即是对一个方法,它的 receiver 是指针就足矣。

但不是所有值都是可寻址的,比如 map 类型的元素、通过 interface 引用的变量:

  1. type data struct {
  2. name string
  3. }
  4. type printer interface {
  5. print()
  6. }
  7. func (p *data) print() {
  8. fmt.Println("name: ", p.name)
  9. }
  10. func main() {
  11. d1 := data{"one"}
  12. d1.print() // d1 变量可寻址,可直接调用指针 receiver 的方法
  13. var in printer = data{"two"}
  14. in.print() // 类型不匹配
  15. m := map[string]data{
  16. "x": data{"three"},
  17. }
  18. m["x"].print() // m["x"] 是不可寻址的 // 变动频繁
  19. }

cannot use data literal (type data) as type printer in assignment: data does not implement printer (print method has pointer receiver)

cannot call pointer method on m["x"] cannot take the address of m["x"]

53.更新 map 字段的值

如果 map 一个字段的值是 struct 类型,则无法直接更新该 struct 的单个字段:

  1. // 无法直接更新 struct 的字段值
  2. type data struct {
  3. name string
  4. }
  5. func main() {
  6. m := map[string]data{
  7. "x": {"Tom"},
  8. }
  9. m["x"].name = "Jerry"
  10. }

cannot assign to struct field m["x"].name in map

因为 map 中的元素是不可寻址的。需区分开的是,slice 的元素可寻址:

  1. type data struct {
  2. name string
  3. }
  4. func main() {
  5. s := []data{{"Tom"}}
  6. s[0].name = "Jerry"
  7. fmt.Println(s) // [{Jerry}]
  8. }

注意:不久前 gccgo 编译器可更新 map struct 元素的字段值,不过很快便修复了,官方认为是 Go1.3 的潜在特性,无需及时实现,依旧在 todo list 中。

更新 map 中 struct 元素的字段值,有 2 个方法:

  • 使用局部变量
  1. // 提取整个 struct 到局部变量中,修改字段值后再整个赋值
  2. type data struct {
  3. name string
  4. }
  5. func main() {
  6. m := map[string]data{
  7. "x": {"Tom"},
  8. }
  9. r := m["x"]
  10. r.name = "Jerry"
  11. m["x"] = r
  12. fmt.Println(m) // map[x:{Jerry}]
  13. }
  • 使用指向元素的 map 指针
  1. func main() {
  2. m := map[string]*data{
  3. "x": {"Tom"},
  4. }
  5. m["x"].name = "Jerry" // 直接修改 m["x"] 中的字段
  6. fmt.Println(m["x"]) // &{Jerry}
  7. }

但是要注意下边这种误用:

  1. func main() {
  2. m := map[string]*data{
  3. "x": {"Tom"},
  4. }
  5. m["z"].name = "what???"
  6. fmt.Println(m["x"])
  7. }

panic: runtime error: invalid memory address or nil pointer dereference

54.nil interface 和 nil interface 值

虽然 interface 看起来像指针类型,但它不是。interface 类型的变量只有在类型和值均为 nil 时才为 nil

如果你的 interface 变量的值是跟随其他变量变化的(雾),与 nil 比较相等时小心:

  1. func main() {
  2. var data *byte
  3. var in interface{}
  4. fmt.Println(data, data == nil) // <nil> true
  5. fmt.Println(in, in == nil) // <nil> true
  6. in = data
  7. fmt.Println(in, in == nil) // <nil> false // data 值为 nil,但 in 值不为 nil
  8. }

如果你的函数返回值类型是 interface,更要小心这个坑:

  1. // 错误示例
  2. func main() {
  3. doIt := func(arg int) interface{} {
  4. var result *struct{} = nil
  5. if arg > 0 {
  6. result = &struct{}{}
  7. }
  8. return result
  9. }
  10. if res := doIt(-1); res != nil {
  11. fmt.Println("Good result: ", res) // Good result: <nil>
  12. fmt.Printf("%T\n", res) // *struct {} // res 不是 nil,它的值为 nil
  13. fmt.Printf("%v\n", res) // <nil>
  14. }
  15. }
  16. // 正确示例
  17. func main() {
  18. doIt := func(arg int) interface{} {
  19. var result *struct{} = nil
  20. if arg > 0 {
  21. result = &struct{}{}
  22. } else {
  23. return nil // 明确指明返回 nil
  24. }
  25. return result
  26. }
  27. if res := doIt(-1); res != nil {
  28. fmt.Println("Good result: ", res)
  29. } else {
  30. fmt.Println("Bad result: ", res) // Bad result: <nil>
  31. }
  32. }

55.堆栈变量

你并不总是清楚你的变量是分配到了堆还是栈。

在 C++ 中使用 new 创建的变量总是分配到堆内存上的,但在 Go 中即使使用 new()、make() 来创建变量,变量为内存分配位置依旧归 Go 编译器管。

Go 编译器会根据变量的大小及其 "escape analysis" 的结果来决定变量的存储位置,故能准确返回本地变量的地址,这在 C/C++ 中是不行的。

在 go build 或 go run 时,加入 -m 参数,能准确分析程序的变量分配位置:

Golang 58个坑 - 图11

56.GOMAXPROCS、Concurrency(并发)and Parallelism(并行)

Go 1.4 及以下版本,程序只会使用 1 个执行上下文 / OS 线程,即任何时间都最多只有 1 个 goroutine 在执行。

Go 1.5 版本将可执行上下文的数量设置为 runtime.NumCPU() 返回的逻辑 CPU 核心数,这个数与系统实际总的 CPU 逻辑核心数是否一致,取决于你的 CPU 分配给程序的核心数,可以使用 GOMAXPROCS 环境变量或者动态的使用 runtime.GOMAXPROCS() 来调整。

误区:GOMAXPROCS 表示执行 goroutine 的 CPU 核心数,参考文档

GOMAXPROCS 的值是可以超过 CPU 的实际数量的,在 1.5 中最大为 256

  1. func main() {
  2. fmt.Println(runtime.GOMAXPROCS(-1)) // 4
  3. fmt.Println(runtime.NumCPU()) // 4
  4. runtime.GOMAXPROCS(20)
  5. fmt.Println(runtime.GOMAXPROCS(-1)) // 20
  6. runtime.GOMAXPROCS(300)
  7. fmt.Println(runtime.GOMAXPROCS(-1)) // Go 1.9.2 // 300
  8. }

57.读写操作的重新排序

Go 可能会重排一些操作的执行顺序,可以保证在一个 goroutine 中操作是顺序执行的,但不保证多 goroutine 的执行顺序:

  1. var _ = runtime.GOMAXPROCS(3)
  2. var a, b int
  3. func u1() {
  4. a = 1
  5. b = 2
  6. }
  7. func u2() {
  8. a = 3
  9. b = 4
  10. }
  11. func p() {
  12. println(a)
  13. println(b)
  14. }
  15. func main() {
  16. go u1() // 多个 goroutine 的执行顺序不定
  17. go u2()
  18. go p()
  19. time.Sleep(1 * time.Second)
  20. }

运行效果:

Golang 58个坑 - 图12

如果你想保持多 goroutine 像代码中的那样顺序执行,可以使用 channel 或 sync 包中的锁机制等。

58.优先调度

你的程序可能出现一个 goroutine 在运行时阻止了其他 goroutine 的运行,比如程序中有一个不让调度器运行的 for 循环:

  1. func main() {
  2. done := false
  3. go func() {
  4. done = true
  5. }()
  6. for !done {
  7. }
  8. println("done !")
  9. }

for 的循环体不必为空,但如果代码不会触发调度器执行,将出现问题。

调度器会在 GC、Go 声明、阻塞 channel、阻塞系统调用和锁操作后再执行,也会在非内联函数调用时执行:

  1. func main() {
  2. done := false
  3. go func() {
  4. done = true
  5. }()
  6. for !done {
  7. println("not done !") // 并不内联执行
  8. }
  9. println("done !")
  10. }

可以添加 -m 参数来分析 for 代码块中调用的内联函数:

Golang 58个坑 - 图13

你也可以使用 runtime 包中的 Gosched() 来 手动启动调度器:

  1. func main() {
  2. done := false
  3. go func() {
  4. done = true
  5. }()
  6. for !done {
  7. runtime.Gosched()
  8. }
  9. println("done !")
  10. }

运行效果:

Golang 58个坑 - 图14

转自:http://devs.cloudimmunity.com/gotchas-and-common-mistakes-in-go-golang/index.html#string_byte_slice_conv