本文旨在阐明Go语言中打印`sync.WaitGroup`指针地址时常见的混淆点，特别是当一个函数返回`*sync.WaitGroup`类型时。我们将通过代码示例详细解析`&wg`和`wg`在不同作用域中的含义，帮助开发者区分变量本身的地址与变量所存储的指针值，从而避免因误解而产生的地址不一致现象。
理解Go语言中指针地址的打印行为
在Go语言中，理解变量、指针以及它们在不同作用域中的行为至关重要，尤其是在处理并发原语如sync.WaitGroup时。开发者有时会发现，当一个函数返回*sync.WaitGroup后，在调用方打印该指针的地址与在函数内部打印的地址不一致，这通常是由于对Go语言中&操作符和变量本身含义的混淆所致。
初始问题场景
考虑以下Go语言代码片段，它尝试使用sync.WaitGroup来协调主协程与一个子协程的执行，并打印WaitGroup的内存地址：
package main
import (
"fmt"
"runtime"
"sync"
"time"
)
func Run() *sync.WaitGroup {
var wg sync.WaitGroup // 声明一个 WaitGroup 实例
wg.Add(1)
go func() {
defer wg.Done()
fmt.Printf("goroutine %p\n", &wg) // 打印 wg 实例的地址
time.Sleep(5 * time.Second)
fmt.Println("wokeup")
}()
fmt.Printf("returning %p\n", &wg) // 打印 wg 实例的地址
return &wg // 返回 wg 实例的地址
}
func main() {
runtime.GOMAXPROCS(3)
wg := Run() // 接收 Run 函数返回的 *sync.WaitGroup
fmt.Printf(" main %p\n", &wg) // 打印 wg 变量的地址
wg.Wait()
}运行上述代码，可能会得到类似以下的输出：
立即学习“go语言免费学习笔记（深入）”；
returning 0xc00000e000
main 0xc000006020
goroutine 0xc00000e000
wokeup从输出中可以看到，Run函数内部和goroutine中打印的地址（0xc00000e000）是一致的，但main函数中打印的地址（0xc000006020）却不同。这似乎与预期不符，因为我们期望在main函数中得到的WaitGroup指针地址应该与Run函数中返回的地址相同。
问题分析：&操作符的含义
问题的核心在于对&操作符的理解以及变量在不同作用域中的表示。
-
在Run函数内部 (Run和goroutine)：
- var wg sync.WaitGroup：这里声明了一个sync.WaitGroup类型的变量wg。它是一个具体的结构体实例，存储在内存中的某个位置。
- &wg：这个表达式获取的是wg这个结构体实例本身的内存地址。无论是在Run函数的主体中还是在它启动的goroutine中，wg都指向同一个内存中的WaitGroup实例。因此，returning %p和goroutine %p打印的地址是相同的，因为它们都指向同一个WaitGroup对象的物理地址。
- return &wg：Run函数返回的正是这个WaitGroup实例的内存地址，即一个*sync.WaitGroup类型的值。
-
在main函数内部：
- wg := Run()：main函数声明了一个新的局部变量，也命名为wg。这个wg变量的类型是*sync.WaitGroup，它存储了Run函数返回的那个WaitGroup实例的内存地址。
- fmt.Printf(" main %p\n", &wg)：这里的&wg不再是WaitGroup实例的地址。相反，它获取的是main函数中局部变量wg本身的内存地址。由于main函数中的wg是一个局部变量，它在main函数的栈帧中分配内存，用于存储从Run函数返回的指针值。因此，&wg打印的是这个存储指针值的变量的地址，而不是它所指向的WaitGroup实例的地址。
简单来说，Run函数返回的是一个门牌号（WaitGroup实例的地址），而main函数中的wg变量是一个信箱，里面存放着这个门牌号。&wg在main函数中打印的是信箱本身的地址，而不是信箱里存放的门牌号。
解决方案
要使main函数中打印的地址与Run函数中返回的WaitGroup实例地址一致，我们应该打印main函数中wg变量所存储的值，而不是wg变量本身的地址。由于wg在main函数中已经是一个*sync.WaitGroup类型的指针，其值就是WaitGroup实例的地址。
因此，只需将main函数中的打印语句从fmt.Printf(" main %p\n", &wg)修改为fmt.Printf(" main %p\n", wg)。
修正后的代码示例
package main
import (
"fmt"
"runtime"
"sync"
"time"
)
func Run() *sync.WaitGroup {
var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
fmt.Printf("goroutine %p\n", &wg) // 打印 wg 实例的地址
fmt.Println("sleep for 5s")
time.Sleep(5 * time.Second)
fmt.Println("wokeup")
}()
fmt.Printf("returning %p\n", &wg) // 打印 wg 实例的地址
return &wg // 返回 wg 实例的地址
}
func main() {
runtime.GOMAXPROCS(3)
wg := Run()
fmt.Printf(" main %p\n", wg) // **修正点：打印 wg 变量存储的指针值**
wg.Wait()
}修正后的代码运行输出如下：
returning 0x1052e2c0
main 0x1052e2c0
goroutine 0x1052e2c0
sleep for 5s现在，所有打印的地址都一致了，它们都指向了同一个sync.WaitGroup实例的内存地址。
总结与注意事项
-
&variable vs. variable (当variable是指针时):
- &variable：总是获取variable这个变量本身在内存中的地址。
- variable (当variable是指针类型时)：表示variable所存储的值，这个值就是一个内存地址（即它所指向的对象的地址）。
- 在Go语言中，当一个函数返回一个指针（如*sync.WaitGroup）时，接收这个返回值的变量（如main函数中的wg）其类型就是指针类型。此时，直接打印该变量（fmt.Printf("%p", wg)）会显示它所指向的对象的地址。
- 如果想打印存储这个指针的变量本身的地址，才需要使用&操作符（fmt.Printf("%p", &wg)）。
- 理解这一区别对于调试内存问题、理解并发原语的工作方式以及编写健壮的Go程序至关重要。
通过区分变量本身的地址和变量所存储的指针值，我们可以准确地追踪Go程序中对象的内存位置，从而避免常见的混淆和错误。
