golang_daily_QA.md

问题描述

在golang里，如何规范context类型key的使用

Q1: "should not use built-in type string as key for value; define your own type to avoid collisions"

A!: 现代软件都是团队开发的，多人协作的成果。

一个ctx对象在整个生命周期中，可能经过多个模块使用，每一个模块都可能使用 ctx 来存储相应信息。

为了避免key的覆盖冲突，key的使用自定义类型。对于相同的value值，Go也会作为完全不同的key进行处理。

假设一种情况：

每个模块是由不同的开发人员负责，user模块，使用ctx类型缓存了用户的openid 字段。group模块也使用了 "openid" 这个 key，来存储群主的openid。

结果绕了一圈会发现：群主的 openid 总是变成别人的 openid？这群主轮流做的？

解决方法

上策：使用自定义struct{}类型，作为key。(如果你并不需要使用同一个key类型，存储多个不同 value)

好处是：首先，这个类型在 Go 中原则上是不占内存空间和 gc 开销的，可以提升性能；其次，这少了开发者额外 “写一个 key” 的时间

中策：使用type自定义类型，底层类型相同（都是 string 类型），但是经过 type 定义之后，Go 是作为完全不同的 key 来处理的。针对具体类型自定义 key 类型之后，很好地解决了同名 key 冲突的问题。

下策：把 key 的定义统一收集起来规定。（软件工程主打一个分而治之，在没有必要的情况下，尽可能避免集中式的管理）

典型例子

在 ctx 中存入一个 trace ID，用于跟踪整个调用链

// Package traceid 用于在 context 中维护 trace ID
package traceid

import "context"

// WithTraceID 往 context 中存入 trace ID
func WithTraceID(ctx context.Context, traceID string) context.Context {
    return context.WithValue(ctx, traceIDKey{}, traceID)
}

// TraceID 从 context 中提取 trace ID
func TraceID(ctx context.Context) string {
    v := context.Value(ctx, traceIDKey{})
    id, _ := v.(string)
    return id
}

type traceIDKey struct{}