使用 context.withvalue 时，需注意以下要点：1. 使用私有类型作为 key 避免冲突；2. 传递不可变值，确保线程安全；3. 避免频繁创建 context；4. 不适合存储可变对象、大量数据或替代函数参数。正确做法是在请求开始时构造好 metadata，并通过参数传递 context。
在使用 golang 的
context
时，经常需要传递一些元数据（metadata），比如请求的用户 ID、trace ID 等。
context.WithValue
就是为此设计的。但很多人对它的线程安全性和使用方式存在误解，这篇文章就来讲清楚怎么正确用它。
context.WithValue 的基本用法
context.WithValue
允许我们在上下文中附加键值对。这些信息可以在后续的函数调用链中被访问到，常用于跨多个 goroutine 的请求级数据共享。
它的使用方式很简单：
立即学习“go语言免费学习笔记（深入）”；
ctx := context.WithValue(parentCtx, key, value)
其中
key
可以是任意可比较的类型（比如 String、int、自定义类型），建议使用导出包外不可见的类型，避免 key 冲突。
举个例子：
type keyType string const userIDKey keyType = "user_id" ctx := context.WithValue(context.Background(), userIDKey, "12345")
然后在其他地方通过
ctx.Value(userIDKey)
获取这个值。
WithValue 是线程安全的吗？
这个问题的答案是：只要你不修改上下文对象本身，就是线程安全的。
因为
context
是不可变的。每次调用
WithValue
都会返回一个新的上下文对象，而不会修改原来的。这意味着多个 goroutine 同时读取同一个 context 是安全的。
但是要注意：
- 不要在 context 中放可变对象。例如一个 map 或指针，如果多个 goroutine 修改它，仍然会有并发问题。
- 不要频繁创建 context。虽然每个 WithValue 都是不可变的，但如果频繁嵌套使用，可能会影响性能和调试。
所以正确的做法是：
如何设计 Key 才不会冲突？
为了避免 key 冲突，推荐的做法是：
- 使用私有类型作为 key 的类型，防止外部包误用相同的字符串 key。
- 不要使用
string
类型直接作为 key，即使你写成
"user_id"
这样的形式，也有可能和其他包冲突。
示例：
type keyType int const ( userIDKey keyType = iota traceIDKey ) ctx := context.WithValue(ctx, userIDKey, "123") ctx = context.WithValue(ctx, traceIDKey, "abc")
这样即使两个不同的包都用了
iota
，也不会冲突，因为它们的 keyType 类型不同。
哪些场景适合用 context 传 metadata？
不适合的场景包括：
- 存储大量数据，context 并不是为了存储大数据设计的。
- 替代函数参数。如果某个参数只在局部使用，应该直接传参而不是塞进 context。
- 存放会变化的状态。如前所述，一旦放入的是可变对象，就可能引发并发问题。
基本上就这些。合理使用
context.WithValue
可以让程序更清晰、更容易做上下文追踪，但也要注意别滥用。设计好 key，控制好生命周期，就能避免很多坑。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
