requestid

package

v0.0.9 Latest Latest Go to latest Published: Sep 5, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package requestid 提供跨 HTTP 和 gRPC 的请求标识生成与透传中间件。

View Source

const DefaultRequestIDHeader = "X-Request-Id"

DefaultRequestIDHeader 是默认的请求标识请求头。

This section is empty.

func Client(opts ...RequestIDOption) middleware.Middleware

Client 创建客户端请求标识中间件。

func FromContext(ctx context.Context) string

FromContext 从上下文读取请求标识，不存在时返回空字符串。

func GetRequestID(ctx context.Context) string

GetRequestID 从上下文读取请求标识。

func NewRequestIDMiddleware(opts ...RequestIDOption) middleware.Middleware

NewRequestIDMiddleware 创建兼容旧调用方式的服务端请求标识中间件。

func Server(opts ...RequestIDOption) middleware.Middleware

Server 创建服务端请求标识中间件。

func StreamClientInterceptor(opts ...RequestIDOption) grpc.StreamClientInterceptor

StreamClientInterceptor 创建将上下文请求标识写入 outgoing metadata 的流式客户端拦截器。

func UnaryClientInterceptor(opts ...RequestIDOption) grpc.UnaryClientInterceptor

UnaryClientInterceptor 创建将上下文请求标识写入 outgoing metadata 的一元客户端拦截器。

func WithRequestID(ctx context.Context, requestID string) context.Context

WithRequestID 将请求标识写入上下文。

type RequestIDOption func(*requestIDOptions)

RequestIDOption 配置请求标识中间件行为。

func WithRequestIDGenerator(generator func() string) RequestIDOption

WithRequestIDGenerator 设置自定义请求标识生成函数。

func WithRequestIDHeader(name string) RequestIDOption

WithRequestIDHeader 设置自定义请求标识头名称。