Golang for循环遍历小坑

阳光穿透心脏的1/2处 2024-03-22 16:18 75阅读 0赞

### 一、for循环 ###

> 循环:让程序多次执行相同的代码块  
> for循环是Go语言中唯一一个循环结构  
> for循环经典语法  
> 先执行表达式1  
> 执行表达式2判断是否成立,如果成立执行循环体  
> 循环体执行完成后,执行表达式3  
> 再次执行表达式2,判断是否成立.  
> for循环用的最多的地方就是遍历数组或切片等

经典for循环结构中 , for关键字后面有三个表达式,且每个表达式都可以省略。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>for i := 0; i &lt; 5; i++ { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(i)</code> <code>}</code> <code>//等价于</code> <code>j := 0</code> <code>for ; j &lt; 5; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(j)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>j++</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

for关键字后面也可以只有一个表达式,表示如果条件成立执行循环体代码。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>for i := 0; i &lt; 5; i++ { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(i)</code> <code>}</code> <code>//等价于</code> <code>j := 0</code> <code>for j &lt; 5 { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(j)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>j++</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 二、range语句 ###

Golang range类似迭代器操作，可以对 slice、map、数组、字符串等进行迭代循环。在字符串、数组和切片中它返回 (索引, 值) ，在map中返回 (键, 值)，但若当只有一个返回值时，第一个参数是索引或键。

**for循环尤其是range语句，在平时开发过程中频繁使用，但很多开发者经常会在以下场景中踩坑。**

#### 场景一，使用循环迭代器的变量 ####

先来看一个明显的错误：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>func</code>&nbsp;<code>main() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>var</code>&nbsp;<code>out []*int</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>i := 0; i &lt; 3; i++ { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// i := i</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>out = append(out, &amp;i)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(</code><code>"值:"</code><code>, *out[0], *out[1], *out[2])</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(</code><code>"地址:"</code><code>, out[0], out[1], out[2])</code> <code>}</code> <code>// 输出结果</code> <code>// 值: 3 3 3</code> <code>// 地址: 0xc000012090 0xc000012090 0xc000012090</code> </td> 
 </tr> 
 </tbody> 
</table>

> 分析

`out`是一个整型指针数组变量，在for循环中，声明了一个`i`变量，每次循环将`i`的地址追加到`out`切片中，但是每次追加的其实都是`i`变量，因此我们追加的是一个相同的地址，而该地址最终的值是3。

> 正确做法

解开代码中的注释`// i := i`，每次循环时都重新创建一个新的`i`变量。

> 注意，for循环表达式1定义的变量i相当于循环体里面的全局变量，循环体里面定义的变量i相当于循环体里面的局部变量，由于在代码块中同名局部变量会覆盖同名的全局变量，所以此时在循环体逻辑里面，使用的i变量是循环体里面定义的局部变量i。

--------------------

再看一个比较隐秘的错误：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>func</code>&nbsp;<code>main() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>a1 := []int{1, 2, 3}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>a2 := make([]*int, len(a1))</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>i, v :=&nbsp;</code><code>range</code>&nbsp;<code>a1 { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>a2[i] = &amp;v</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(</code><code>"值:"</code><code>, *a2[0], *a2[1], *a2[2])</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(</code><code>"地址:"</code><code>, a2[0], a2[1], a2[2])</code> <code>}</code> <code>// 输出结果</code> <code>// 值: 3 3 3</code> <code>// 地址: 0xc000012090 0xc000012090 0xc000012090</code> </td> 
 </tr> 
 </tbody> 
</table>

> 分析

大多数人就是在`range`这里给变量赋值的时候踩坑，因为比较隐秘，其实情况和上面的一样，`range`在遍历值类型时，其中的`v`是一个局部变量，只会声明初始化一次，之后每次循环时重新赋值覆盖前面的，所以给`a2[i]`赋值的时候其实都是同一个地址`&v`，而`v`最终的值为`a1`最后一个元素的值，也就是3。

> 正确做法

①`a2[i]`赋值时传递原始指针，即`a2[i] = &a1[i]`  
②创建临时变量`t := v`；`a2[i] = &t`  
③闭包(与②原理一样)，`func(v int) { a2[i] = &v }(v)`

--------------------

更为隐秘的还有：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>func</code>&nbsp;<code>main() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>var</code>&nbsp;<code>out [][]int</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>_, i :=&nbsp;</code><code>range</code>&nbsp;<code>[][1]int{ {1}, {2}, {3}} { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>out = append(out, i[:])</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(</code><code>"Values:"</code><code>, out)</code> <code>}</code> <code>// 输出结果</code> <code>// [[3] [3] [3]]</code> </td> 
 </tr> 
 </tbody> 
</table>

原理也是一样的，不论遍历多少次，`i[:]`总是被本次遍历的值所覆盖

#### 场景二，在循环体内使用goroutines ####

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>func</code>&nbsp;<code>main() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>values := []int{1, 2, 3}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg := sync.WaitGroup{}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>_, val :=&nbsp;</code><code>range</code>&nbsp;<code>values { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Add(1)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>go</code>&nbsp;<code>func</code><code>() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(val)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Done()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Wait()</code> <code>}</code> <code>// 输出结果</code> <code>// 3</code> <code>// 3</code> <code>// 3</code> </td> 
 </tr> 
 </tbody> 
</table>

> 分析

对于主协程来讲，循环是很快就跑完的，而这个时候各个协程可能才开始跑，此时`val`的值已经遍历到最后一个了，所以各协程都输出了`3`。（如果遍历数据庞大，主协程遍历耗时较久的话，goroutine的输出会根据当时候的`val`的值，所以每次的输出结果不一定相同的。）

> 解决办法

①使用临时变量

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>for</code>&nbsp;<code>_, val :=&nbsp;</code><code>range</code>&nbsp;<code>values { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Add(1)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>val := val</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>go</code>&nbsp;<code>func</code><code>() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(val)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Done()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}()</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

②使用闭包

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>for</code>&nbsp;<code>_, val :=&nbsp;</code><code>range</code>&nbsp;<code>values { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Add(1)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>go</code>&nbsp;<code>func</code><code>(val int) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Println(val)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>wg.Done()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}(val)</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

#### 三、实战 ####

基于第一、第二小节内容，接下来进行一个Golang for循环实战，代码详情请看注释。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 </td> 
 <td> <code>package</code>&nbsp;<code>main</code> <code>import</code>&nbsp;<code>"fmt"</code> <code>func</code>&nbsp;<code>main() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>slic := []int{1, 2, 3}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// len(cp) = 3, cap(cp) = 3</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cp := make([]*int, len(slic))</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>i, x :=&nbsp;</code><code>range</code>&nbsp;<code>slic { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cp[i] = &amp;slic[i]</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cp = append(cp, &amp;x)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 第一次循环</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// cp[0] = &amp;slic[0]&nbsp; *cp[0] = 1</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 由于len=cap=3,append方法的作用是将元素追加到切片的末尾，即cp(len)位置，此时append便超过切片容量，切片进行扩容，将容量扩容2倍（切片容器&lt;1024时，扩容*2）。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// append后相当于 cp[3] = &amp;x&nbsp; 此时x的值为1，len(cp)=4, cap(cp)=6</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 第二次循环</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// cp[1] = &amp;slic[1]&nbsp; *cp[1] = 2</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 再次append相当于 cp[4] = &amp;x 此时x的值为2，len(cp)=5, cap(cp)=6</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 第三次循环</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// cp[2] = &amp;slic[2]&nbsp; *cp[2] = 3</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 再次append相当于 cp[5] = &amp;x 此时x的值为3，len(cp)=6, cap(cp)=6</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 至此循环完毕，cp中数据为&nbsp; &amp;slic[0]&nbsp; &amp;slic[1] &amp;slic[2] &amp;x&nbsp; &amp;x&nbsp; &amp;x</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>println(</code><code>"len=="</code><code>, len(cp),&nbsp;</code><code>"&nbsp; cap=="</code><code>, cap(cp))</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>_, x :=&nbsp;</code><code>range</code>&nbsp;<code>cp { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>fmt.Print(*x,&nbsp;</code><code>" "</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> <code>/*&nbsp; 输出结果</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>len== 6&nbsp;&nbsp; cap== 6</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>1 2 3 3 3 3</code> <code>*/</code> </td> 
 </tr> 
 </tbody> 
</table>