Golang新手可能会踩的50个坑(初级篇)

译文:Golang 新手可能会踩的 50 个坑原文:50 Shades of Go: Traps, Gotchas, and Common Mistakes翻译已获作者授权,转载请注明来源。

不久前发现在知乎这篇质量很高的文章,打算加上自己的理解翻译一遍。文章分为三部分:初级篇 1-34,中级篇 35-50,高级篇 51-57

前言

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

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

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

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

  1. // 错误示例

  2. func main()

  3. {

  4. println("hello world")

  5. }

  6. // 等效于

  7. func main();// 无函数体

  8. {

  9. println("hello world")

  10. }

./main.go: missing function body./main.go: syntax error: unexpected semicolon or newline before {

  1. // 正确示例

  2. func main(){

  3. println("hello world")

  4. }

2. 未使用的变量

如果在函数体代码中有未使用的变量,则无法通过编译,不过全局变量声明但不使用是可以的。

即使变量声明后为变量赋值,依旧无法通过编译,需在某处使用它:

  1. // 错误示例

  2. vargvarint// 全局变量,声明不使用也可以

  3. func main(){

  4. varoneint// error: one declared and not used

  5. two:=2// error: two declared and not used

  6. varthreeint// error: three declared and not used

  7. three=3

  8. }

  9. // 正确示例

  10. // 可以直接注释或移除未使用的变量

  11. func main(){

  12. varoneint

  13. _=one

  14. two:=2

  15. println(two)

  16. varthreeint

  17. one=three

  18. varfourint

  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. varmyvar=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 infostruct{

  3. resultint

  4. }

  5. func work()(int,error){

  6. return3,nil

  7. }

  8. func main(){

  9. vardata info

  10. data.result,err:=work()// error: non-name data.result on left side of :=

  11. fmt.Printf("info: %+vn",data)

  12. }

  13. // 正确示例

  14. func main(){

  15. vardata info

  16. varerr error// err 需要预声明

  17. data.result,err=work()

  18. iferr!=nil{

  19. fmt.Println(err)

  20. return

  21. }

  22. fmt.Printf("info: %+vn",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:Shadowingvariable`x`

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

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

  1. // 错误示例

  2. func main(){

  3. varx=nil// error: use of untyped nil

  4. _=x

  5. }

  6. // 正确示例

  7. func main(){

  8. varxinterface{}=nil

  9. _=x

  10. }

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

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

  1. // map 错误示例

  2. func main(){

  3. varm 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. vars[]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. varsstring=nil// cannot use nil as type string in assignment

  4. ifs==nil{// invalid operation: s == nil (mismatched types string and nil)

  5. s="default"

  6. }

  7. }

  8. // 正确示例

  9. func main(){

  10. varsstring// 字符串类型的零值是空串 ""

  11. ifs==""{

  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、直接传递指向这个数组的指针类型

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

2、直接使用 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-inforeach遍历语句不同,Go 中的range在遍历时会生成 2 个值,第一个是元素索引,第二个是元素的值:

  1. // 错误示例

  2. func main(){

  3. x:=[]string{"a","b","c"}

  4. forv:=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. fori:=range table{

  7. table[i]=make([]int,y)

  8. }

  9. }

3、使用共享底层数组的切片

  • 创建一个存放原始数据的容器 slice

  • 创建其他的 slice

  • 切割原始 slice 来初始化其他的 slice

  1. func main(){

  2. h,w:=2,4

  3. raw:=make([]int,h*w)

  4. fori:=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. fori:=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 则会返回元素对应数据类型的零值,比如nilfalse和 0,取值操作总有值返回,故不能通过取出来的值来判断 key 是不是在 map 中。

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

  1. // 错误的 key 检测方式

  2. func main(){

  3. x:=map[string]string{"one":"2","two":"","three":"3"}

  4. ifv:=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)]的内存分配

  • 使用forrange迭代 string 转换为 []byte 的迭代:fori,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("%Tn",x[0])// uint8

  5. }

如果需要使用forrange迭代访问字符串中的字符(unicode code point / rune),标准库中有"unicode/utf8"包来做 UTF8 的相关解码编码。另外 utf8string 也有像func(s*String)At(iint)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:="AxfeC"

  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(strstring)(nint)

  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("cafeu0301")// café // 法文的 cafe,实际上是两个 rune 的组合

  6. }

参考:normalization

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.Fatallog.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:="Axfex02xffx04"

  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. fork,v:=range m{

  4. fmt.Println(k,v)

  5. }

  6. }

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

Golang新手可能会踩的50个坑(初级篇)插图1

26. switch 中的 fallthrough 语句

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

  1. func main(){

  2. isSpace:=func(charbyte)bool{

  3. switchchar{

  4. case:// 空格符会直接 break,返回 false // 和其他语言不一样

  5. // fallthrough  // 返回 true

  6. caset:

  7. returntrue

  8. }

  9. returnfalse

  10. }

  11. fmt.Println(isSpace(t))// true

  12. fmt.Println(isSpace())// false

  13. }

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

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

  1. func main(){

  2. isSpace:=func(charbyte)bool{

  3. switchchar{

  4. case,t:

  5. returntrue

  6. }

  7. returnfalse

  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. vard uint8=2

  8. fmt.Printf("%08bn",d)// 00000010

  9. fmt.Printf("%08bn",^d)// 11111101

  10. }

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

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

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

  1. func main(){

  2. vara uint8=0x82

  3. varb 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 XOR0xff]

  5. 10000010^00000010=10000000[A XOR B]

  6. 10000010&00000010=00000010[A AND B]

  7. 10000010&^00000010=10000000[AAND NOTB]

  8. 10000010&(^00000010)=10000000[A AND(NOT B)]

29. 运算符的优先级

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

  1. func main(){

  2. fmt.Printf("0x2 & 0x2 + 0x4 -> %xn",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 -> %xn",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 -> %xn",0xf|0x2^0x2)// | 优先 ^

  11. //prints: 0xf | 0x2 ^ 0x2 -> 0xd

  12. //Go:    (0xf | 0x2) ^ 0x2

  13. //C++:    0xf | (0x2 ^ 0x2) -> 0xf

  14. }

优先级列表:

  1. PrecedenceOperator

  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("%vn",in)// main.MyData{One:1, two:"two"}

  4. encoded,_:=json.Marshal(in)

  5. fmt.Println(string(encoded))// {"One":1}    // 私有字段 two 被忽略了

  6. varoutMyData

  7. json.Unmarshal(encoded,&out)

  8. fmt.Printf("%vn",out)// main.MyData{One:1, two:""}

  9. }

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

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

  1. // 主程序会直接退出

  2. func main(){

  3. workerCount:=2

  4. fori:=0;i<workerCount;i++{

  5. go doIt(i)

  6. }

  7. time.Sleep(1*time.Second)

  8. fmt.Println("all done!")

  9. }

  10. func doIt(workerIDint){

  11. fmt.Printf("[%v] is runningn",workerID)

  12. time.Sleep(3*time.Second)// 模拟 goroutine 正在执行

  13. fmt.Printf("[%v] is donen",workerID)

  14. }

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

Golang新手可能会踩的50个坑(初级篇)插图3

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

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

  1. // 等待所有 goroutine 执行完毕

  2. // 进入死锁

  3. func main(){

  4. varwg sync.WaitGroup

  5. done:=make(chanstruct{})

  6. workerCount:=2

  7. fori:=0;i<workerCount;i++{

  8. wg.Add(1)

  9. go doIt(i,done,wg)

  10. }

  11. close(done)

  12. wg.Wait()

  13. fmt.Println("all done!")

  14. }

  15. func doIt(workerIDint,done<-chanstruct{},wg sync.WaitGroup){

  16. fmt.Printf("[%v] is runningn",workerID)

  17. defer wg.Done()

  18. <-done

  19. fmt.Printf("[%v] is donen",workerID)

  20. }

执行结果:

Golang新手可能会踩的50个坑(初级篇)插图5

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

fatal error: all goroutines are asleep – deadlock!

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

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

  1. // 等待所有 goroutine 执行完毕

  2. // 使用传址方式为 WaitGroup 变量传参

  3. // 使用 channel 关闭 goroutine

  4. func main(){

  5. varwg sync.WaitGroup

  6. done:=make(chanstruct{})

  7. ch:=make(chaninterface{})

  8. workerCount:=2

  9. fori:=0;i<workerCount;i++{

  10. wg.Add(1)

  11. go doIt(i,ch,done,&wg)// wg 传指针,doIt() 内部会改变 wg 的值

  12. }

  13. fori:=0;i<workerCount;i++{// 向 ch 中发送数据,关闭 goroutine

  14. ch<-i

  15. }

  16. close(done)

  17. wg.Wait()

  18. close(ch)

  19. fmt.Println("all done!")

  20. }

  21. func doIt(workerIDint,ch<-chaninterface{},done<-chanstruct{},wg*sync.WaitGroup){

  22. fmt.Printf("[%v] is runningn",workerID)

  23. defer wg.Done()

  24. for{

  25. select{

  26. casem:=<-ch:

  27. fmt.Printf("[%v] m => %vn",workerID,m)

  28. case<-done:

  29. fmt.Printf("[%v] is donen",workerID)

  30. return

  31. }

  32. }

  33. }

运行效果:

Golang新手可能会踩的50个坑(初级篇)插图7

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

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

  1. func main(){

  2. ch:=make(chanstring)

  3. go func(){

  4. form:=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新手可能会踩的50个坑(初级篇)插图9

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

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

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

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

  1. func main(){

  2. ch:=make(chanint)

  3. fori:=0;i<3;i++{

  4. go func(idxint){

  5. ch<-idx

  6. }(i)

  7. }

  8. fmt.Println(<-ch)// 输出第一个发送的值

  9. close(ch)// 不能关闭,还有其他的 sender

  10. time.Sleep(2*time.Second)// 模拟做其他的操作

  11. }

运行结果:

Golang新手可能会踩的50个坑(初级篇)插图11

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

  1. func main(){

  2. ch:=make(chanint)

  3. done:=make(chanstruct{})

  4. fori:=0;i<3;i++{

  5. go func(idxint){

  6. select{

  7. casech<-(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新手可能会踩的50个坑(初级篇)插图13

34. 使用了值为nil的 channel

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

  1. func main(){

  2. varch chanint// 未初始化,值为 nil

  3. fori:=0;i<3;i++{

  4. go func(iint){

  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(chanint)

  3. outCh:=make(chanint)

  4. go func(){

  5. varin<-chanint=inCh

  6. varoutchan<-int

  7. varvalint

  8. for{

  9. select{

  10. caseout<-val:

  11. println("--------")

  12. out=nil

  13. in=inCh

  14. caseval=<-in:

  15. println("++++++++++")

  16. out=outCh

  17. in=nil

  18. }

  19. }

  20. }()

  21. go func(){

  22. forr:=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新手可能会踩的50个坑(初级篇)插图15

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

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

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

  1. type datastruct{

  2. numint

  3. key*string

  4. items map[string]bool

  5. }

  6. func(this*data)pointerFunc(){

  7. this.num=7

  8. }

  9. func(thisdata)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=%vn",d.num,*d.key,d.items)

  18. d.pointerFunc()// 修改 num 的值为 7

  19. fmt.Printf("num=%v  key=%v  items=%vn",d.num,*d.key,d.items)

  20. d.valueFunc()// 修改 key 和 items 的值

  21. fmt.Printf("num=%v  key=%v  items=%vn",d.num,*d.key,d.items)

  22. }

运行结果:

Golang新手可能会踩的50个坑(初级篇)插图17

总结

感谢原作者 kcqon 总结的这篇博客,让我受益匪浅。

由于译者水平有限,不免出现理解失误,望读者在下评论区指出,不胜感激。

后续再更新类似高质量文章的翻译 😍


欢迎关注 SegmentFault 微信公众号 🙂

Golang新手可能会踩的50个坑(初级篇)插图19

原创文章 Golang新手可能会踩的50个坑(初级篇),版权所有
如若转载,请注明出处:https://www.itxiaozhan.cn/202210087.html

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注