Go中如何从RPC函数向gRPC服务端拦截器传递自定义信息

核心实现逻辑：利用Context携带指针类型的指标存储结构体，避免Context值拷贝导致的修改不可见问题，拦截器初始化结构体后注入Context，业务逻辑直接修改结构体字段，Handler执行完成后拦截器即可读取到所有指标数据。

1. 定义类型安全的Context Key与指标结构 #

使用自定义私有类型作为Context Key，避免和框架、其他中间件的Key产生冲突，同时定义业务侧需要上报的指标字段：

package main

import "context"

// 自定义Context Key的私有类型，禁止外部包访问，避免键冲突
type rpcMetricsCtxKeyType int
const rpcMetricsCtxKey rpcMetricsCtxKeyType = iota

// RPCMetric 业务执行过程中生成的自定义指标集合，字段可根据实际业务需求增减
type RPCMetric struct {
	CostTimeMs  int64                  // 接口处理耗时
	IsCacheHit  bool                   // 是否命中缓存
	BizErrCode  int                    // 业务错误码
	ExtTags     map[string]string      // 自定义扩展标签
}

2. 改造服务端拦截器逻辑 #

在拦截器调用业务Handler之前，先初始化空的指标结构体指针，将其注入派生Context中传入Handler；defer逻辑直接读取该指针指向的结构体数据即可完成指标上报：

func (mi *metricsInterceptor) doServerUnary(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) {
	// 初始化指标存储载体，使用指针类型保证业务侧修改对拦截器可见
	metric := &RPCMetric{
		ExtTags: make(map[string]string),
	}
	// 将指标指针注入Context
	metricsCtx := context.WithValue(ctx, rpcMetricsCtxKey, metric)

	defer func() {
		// 此处可直接读取metric的所有字段，业务侧的修改会同步到这里
		// 示例：打印指标/上报到监控系统
		// mi.monitor.Report(info.FullMethod, metric.CostTimeMs, metric.IsCacheHit, metric.BizErrCode, metric.ExtTags)
		log.Printf("rpc call %s finished, metric: %+v, err: %v", info.FullMethod, metric, err)
	}()

	// 注意：传入的是注入了指标指针的新Context
	resp, err = handler(metricsCtx, req)
	return
}

// 保持原有拦截器初始化方法不变
func (mi *metricsInterceptor) UnaryServerInterceptor() grpc.UnaryServerInterceptor {
    return mi.doServerUnary
}

3. 改造RPC业务方法逻辑 #

业务方法从传入的Context中提取指标指针，执行完业务逻辑后直接给指标字段赋值即可，不需要额外操作Context：

import "time"

func (s *myServer) Get(ctx context.Context, in *MyRequest) (*MyResponse, error) {
	startAt := time.Now()

	// 从Context中提取指标载体，做类型断言兜底避免空指针
	metric, ok := ctx.Value(rpcMetricsCtxKey).(*RPCMetric)
	if !ok {
		// 兜底：未挂载拦截器时（比如单元测试场景）初始化空指标，避免panic
		metric = &RPCMetric{ExtTags: make(map[string]string)}
	}

	// 执行业务逻辑
	var cacheHit bool
	res, err := s.cache.Get(in.Id)
	if err != nil {
		res, err = s.db.Query(in.Id)
		cacheHit = false
	} else {
		cacheHit = true
	}

	// 给指标字段赋值
	metric.CostTimeMs = time.Since(startAt).Milliseconds()
	metric.IsCacheHit = cacheHit
	metric.ExtTags["request_id"] = in.RequestId
	if err != nil {
		// 业务错误码赋值逻辑根据自身错误实现调整
		// metric.BizErrCode = err.(*BizError).Code()
	}

	return &MyResponse{Data: res}, nil
}

关键注意事项 #

• 禁止将值类型的指标结构体直接存入Context：Context传值是值拷贝，业务侧拿到的是结构体副本，修改后拦截器无法获取更新后的值，必须存入指针类型
• 不要使用公开的string、int等内置类型作为Context Key，避免和其他组件的Key重名导致值覆盖
• 业务侧提取指标时必须做类型断言校验，增加空值兜底逻辑，避免单元测试、调试场景下未挂载拦截器时触发空指针panic
• 若存在多层拦截器，需将指标拦截器放在最外层执行，保证所有内层逻辑、业务方法都能从Context中拿到指标载体

内容的提问来源于stack exchange，提问作者svakili