每个Go程序员必犯之错

说起每个程序员必犯的错误，那还得是"循环变量"这个错误了，就连Go的开发者都犯过这个错误，这个错误在Go的FAQ中也有提到What happens with closures running as goroutines?:

func main() {
    var wg sync.WaitGroup
    values := []string{"a", "b", "c"}
    for _, v := range values {
        wg.Add(1)
        go func() {
            fmt.Println(v)
            wg.Done()
        }()
    }
    wg.Wait()
}

你可能期望能输出a、b、c这三个字符(可能顺序不同)，但是实际可能输出的是c、c、c。
这是因为循环变量的作用域是整个循环，而不是单次迭代，所以在循环体中使用的变量是同一个变量，而不是每次迭代都是一个新的变量。

这个错误有时候隐藏很深，即使没有goroutine，也有可能，比如下面的代码，并没有使用额外的goroutine和闭包，也是有问题的:


package main
import (
	"fmt"
)
type Char struct {
	Char *string
}
func main() {
	var chars []Char
	values := []string{"a", "b", "c"}
	for _, v := range values {
		chars = append(chars, Char{Char: &v})
	}
	for _, v := range chars {
		fmt.Println(*v.Char)
	}
}

输出也大概率是c、c、c,因为给每个Char的字段赋值的是v的指针，v在整个循环中都是一个变量，所以最后的结果都是c。

Go团队很早也意识到这个问题了，但是考虑到兼容的问题，大家的容忍程度，那就这样了。每个Go程序员都在这里摔一跤，也就长记性了，所以一直没有改变这个设计。我在这里摔了好多跤，以至于我写for循环的时候都战战兢兢的，和Russ Cox统计的网上的处理一样，不管有无必要，很多时候我都是先把循环变量赋值给一个局部变量，然后再使用，比如下面的代码：

for _, v := range values {
    v := v
    wg.Add(1)
    go func() {
        fmt.Println(v)
        wg.Done()
    }()
}

今年5月份的时候，Russ Cox忍不住了，提了一个提案#60078,提案的内容是在for循环中，如果变量只在循环体中使用，那么就会在每次迭代中创建一个新的变量，而不是使用同一个变量。这个提案引起了很多人的关注，很多人都在讨论这个提案，这个提案被接收了，具体提案内容在文档中Proposal: Less Error-Prone Loop Variable Scoping。

如果你使用Go 1.21，你可以开始这个功能，使用GOEXPERIMENT=loopvar go run main.go运行上面的程序，会输出c、b、a这样的输出，不再是c、c、c了。
这个特性在Go 1.22中会默认开启，不需要设置GOEXPERIMENT了。还有一两个月才能正式发布go 1.22,大家可以使用gotip测试：

$ gotip run main.go
a
b
c

不只是for-range,下面的3-clause也是同样的问题：

func main() {
	var ids []*int
	for i := 0; i < 3; i++ {
		i = 10
	}
	for _, id := range ids {
		fmt.Println(*id)
	}
}

Go 1.22中也会修复这个问题。C#语言就只修改了for-range语句，3-clause语句就没有修改, Go两种都做了修改。

但是，问题就来了哈，像下面的代码，Go 1.22和以前的代码会一样么？

func main() {
	var ids []*int
	for i := 0; i < 3; i++ {
        i = 10
		ids = append(ids, &i)
	}
	for _, id := range ids {
		fmt.Println(*id)
	}
}

如果用Go 1.21,它会输出11。
如果用Go 1.22,它会输出10。
原因还是在于这个提案实现后，每次迭代的时候，都会创建一个新的变量，所以ids中的元素都是指向不同的变量，而不是同一个变量。

看起来打破了向下兼容的承诺，你如果先前就想利用这个corner case的话，Go1.22已经不兼容了。

更进一步，你会发现再执行3-clause的第三条clause的时候，变量已经被重新创建，比如下面的代码：

func main() {
	for i, p := 0, (*int)(nil); i < 3; println("3rd-clause:", &i, p) {
		p = &i
		fmt.Println("loop body:", &i, p)
		i++
	}
}

输出:

$gotip run main.go
loop body: 0x14000120018 0x14000120018
3rd-clause: 0x14000120030 0x14000120018 // &i已经变为0x14000120030
loop body: 0x14000120030 0x14000120030
3rd-clause: 0x14000120038 0x14000120030 // &i已经变为0x14000120038
loop body: 0x14000120038 0x14000120038
3rd-clause: 0x14000120040 0x14000120038 // &i已经变为0x14000120040

这次修改还带来了一个福利，就是range的变量，除了数组、slice、字符串、map、channel外，还可以是一个整数，比如for i := range 10,它相当于for i := 0; i < 10; i++。
range n相当于一个语法糖，如果n > 0，那么它会迭代`0到n-1的值，如果n <= 0, 那么它不会迭代任何值。

鸟窝

《深入理解Go并发编程》新书发售中。一书在手，并发无忧

每个Go程序员必犯之错