#在Golang中，获取goroutineID可以为日志添加上下文信息
在Golang中，获取goroutine ID可以为日志添加更多的上下文信息，尤其在调试并发问题时非常有用。标准库并没有直接提供获取goroutine ID的功能，因此我们可以通过第三方库或者解析堆栈信息的方法实现这个功能。
方法 1: 通过第三方库 goid
最简单的方式是使用第三方库 goid，该库直接提供获取goroutine ID的功能。
安装 goid 库
go get github.com/petermattis/goid
使用示例
package main
import (
"log"
"os"
"github.com/petermattis/goid"
)
func main() {
// 设置日志输出格式
log.SetFlags(0) // 禁用时间戳
log.SetOutput(os.Stdout)
// 在不同的 goroutine 中打印日志
go func() {
log.Printf("goroutine[%d]: Hello from goroutine 1", goid.Get())
}()
go func() {
log.Printf("goroutine[%d]: Hello from goroutine 2", goid.Get())
}()
// 主 goroutine
log.Printf("goroutine[%d]: Hello from main goroutine", goid.Get())
// 防止程序过快退出
select {}
}
输出示例
goroutine[1]: Hello from main goroutine
goroutine[6]: Hello from goroutine 1
goroutine[7]: Hello from goroutine 2
方法 2: 自行封装日志函数，解析堆栈
如果你不想依赖第三方库，可以通过解析运行时堆栈来获取当前的 goroutine ID。这种方法利用 runtime.Stack 函数获取当前 goroutine 的调用栈信息，从中提取出 goroutine 的 ID。
代码实现
package main
import (
"bytes"
"log"
"os"
"runtime"
"strconv"
)
func getGoroutineID() uint64 {
// 分配 64 字节的缓冲区读取调用栈
b := make([]byte, 64)
b = b[:runtime.Stack(b, false)] // 获取调用栈信息
b = bytes.TrimPrefix(b, []byte("goroutine "))
b = b[:bytes.IndexByte(b, ' ')] // 提取 goroutine ID
n, _ := strconv.ParseUint(string(b), 10, 64)
return n
}
func logWithGoroutineID(message string) {
gid := getGoroutineID()
log.Printf("goroutine[%d]: %s", gid, message)
}
func main() {
// 设置日志输出格式
log.SetFlags(0) // 禁用时间戳
log.SetOutput(os.Stdout)
// 在不同的 goroutine 中打印日志
go func() {
logWithGoroutineID("Hello from goroutine 1")
}()
go func() {
logWithGoroutineID("Hello from goroutine 2")
}()
// 主 goroutine
logWithGoroutineID("Hello from main goroutine")
// 防止程序过快退出
select {}
}
输出示例
goroutine[1]: Hello from main goroutine
goroutine[6]: Hello from goroutine 1
goroutine[7]: Hello from goroutine 2
注意事项
- 性能问题: 解析调用栈会带来一定的性能开销，尤其在高并发场景下。因此，如果性能是首要考虑，建议使用效率较高的第三方库。
- 兼容性: 通过解析堆栈的方式获取 goroutine ID 依赖于 Go 运行时的实现细节，未来 Go 的版本可能会改变其内部堆栈的格式，导致此方法失效。
- 日志格式: 在实际项目中，可以根据需求将 goroutine ID 整合到日志系统中，结合 logrus 等日志库进行更灵活的日志处理。
通过这些方式，我们可以在日志中轻松添加 goroutine ID，从而更好地调试并发程序。