本节通过几个实例来介绍循环遍历时,尤其是使用循环变量时可能遇到的问题,希望通过本节内容的学习, 读者能够在实际项目中加以避免。

该类问题出现的频率超乎你的想像,不仅笔者本人参与的项目,甚至某些著名的开源项目中也普遍存在类似的问题。 所以,我希望在本文中对该类问题做一次总结性的分析。

1. 热身

按照惯例,我们还是从几个小题目开始,权当热身。

1.1. 题目一

func Process1(tasks []string) {
    for _, task := range tasks {
        // 启动协程并发处理任务
        go func() {
            fmt.Printf("Worker start process task: %s\n", task)
        }()
    }
}

函数Process1()用于处理任务,每个任务均启动一个协程进行处理。 请问函数是否有问题?

1.2. 题目二

func Process2(tasks []string) {
    for _, task := range tasks {
        // 启动协程并发处理任务
        go func(t string) {
            fmt.Printf("Worker start process task: %s\n", t)
        }(task)
    }
}

函数Process2()用于处理任务,每个任务均启动一个协程进行处理。 协程匿名函数接收一个任务作为参数,并进行处理。 请问函数是否有问题?

1.3. 题目三

项目中经常需要编写单元测试,而单元测试最常见的是table-driven风格的测试,如下所示: 待测函数很简单,只是计算输入数值的2倍值。

func Double(a int) int {
    return a * 2
}

测试函数如下:

func TestDouble(t *testing.T) {
    var tests = []struct {
        name         string
        input        int
        expectOutput int
    }{
        {
            name:         "double 1 should got 2",
            input:        1,
            expectOutput: 2,
        },
        {
            name:         "double 2 should got 4",
            input:        2,
            expectOutput: 4,
        },
    }

    for _, test := range tests {
        t.Run(test.name, func(t *testing.T) {
            if test.expectOutput != Double(test.input) {
                t.Fatalf("expect: %d, but got: %d", test.input, test.expectOutput)
            }
        })
    }
}

上述测试函数也很简单,通过设计多个测试用例,标记输入输出,使用子测试进行验证。 (注:如果不熟悉单元测试,请查阅相关章节)

请问,上述测试有没有问题?

2. 原理剖析

上述三个问题,有个共同点就是都引用了循环变量。即在for index, value := range xxx语句中, indexvalue便是循环变量。不同点是循环变量的使用方式,有的是直接在协程中引用(题目一),有的作为参数传递(题目二),而题目三则是兼而有之。

回答以上问题,记住以下两点即可。

2.1. 循环变量是易变的

首先,循环变量实际上只是一个普通的变量。

语句for index, value := range xxx中,每次循环index和value都会被重新赋值(并非生成新的变量)。

如果循环体中会启动协程(并且协程会使用循环变量),就需要格外注意了,因为很可能循环结束后协程才开始执行, 此时,所有协程使用的循环变量有可能已被改写。(是否会改写取决于引用循环变量的方式)

2.2. 循环变量需要绑定

在题目一中,协程函数体中引用了循环变量task,协程从被创建到被调度执行期间循环变量极有可能被改写, 这种情况下,我们称之为变量没有绑定。 所以,题目一打印结果是混乱的。很有可能(随机)所有协程执行的task都是列表中的最后一个task。

在题目二中,协程函数体中并没有直接引用循环变量task,而是使用的参数。而在创建协程时,循环变量task 作为函数参数传递给了协程。参数传递的过程实际上也生成了新的变量,也即间接完成了绑定。 所以,题目二实际上是没有问题的。

在题目三中,测试用例名字test.name通过函数参数完成了绑定,而test.input 和 test.expectOutput则没有绑定。 然而题目三实际执行却不会有问题,因为t.Run(...)并不会启动新的协程,也就是循环体并没有并发。 此时,即便循环变量没有绑定也没有问题。 但是风险在于,如果t.Run(...)执行的测试体有可能并发(比如通过t.Parallel()),此时就极有可能引入问题。

对于题目三,建议显式地绑定,例如:

    for _, test := range tests {
        tc := test // 显式绑定,每次循环都会生成一个新的tc变量
        t.Run(tc.name, func(t *testing.T) {
            if tc.expectOutput != Double(tc.input) {
                t.Fatalf("expect: %d, but got: %d", tc.input, tc.expectOutput)
            }
        })
    }

通过tc := test显式地绑定,每次循环会生成一个新的变量。

3. 总结

简单点来说

  • 如果循环体没有并发出现,则引用循环变量一般不会出现问题;
  • 如果循环体有并发,则根据引用循环变量的位置不同而有所区别
    • 通过参数完成绑定,则一般没有问题;
    • 函数体中引用,则需要显式地绑定

赠人玫瑰手留余香,如果觉得不错请给个赞~ 你的鼓励将成为我继续写作的动力!

本篇文章已归档到GitHub项目,求星~ 点我即达

Copyright © Kilvn 2022. all right reserved,powered by Gitbook最后更新时间: 2022-02-16 15:57:37

results matching ""

    No results matching ""