contextx

Documentation

Overview

Package contextx 提供了对上下文（context）的扩展功能，允许在 context 中存储和提取用户相关的信息，如用户ID、用户名和访问令牌。

使用后缀 x 表示扩展或变体，使得包名简洁且易于记忆。本包中的函数方便了在上下文中传递和管理用户信息，适用于需要上下文传递数据的场景。

功能描述： - NewUserID 函数：将用户ID放入上下文中。 - FromUserID 函数：从上下文中提取用户ID。 - NewUser 函数：将用户名放入上下文中。 - FromUser 函数：从上下文中提取用户名。 - NewAccessToken 函数：将访问令牌放入上下文中。 - FromAccessToken 函数：从上下文中提取访问令牌。

典型用法： 在处理 HTTP 请求的中间件或服务函数中，可以使用这些方法将用户信息存储到上下文中，以便在整个请求生命周期内安全地共享，避免使用全局变量和参数传参。

示例：

// 创建新的上下文
ctx := context.Background()

// 将用户ID和用户名存放到上下文中
ctx = contextx.NewUserID(ctx, "12345")
ctx = contextx.NewUser(ctx, "sampleUser")

// 从上下文中提取用户信息
userID := contextx.FromUserID(ctx)
username := contextx.FromUser(ctx)

Index

• func AccessToken(ctx context.Context) string
• func UserID(ctx context.Context) string
• func Username(ctx context.Context) string
• func WithAccessToken(ctx context.Context, accessToken string) context.Context
• func WithUserID(ctx context.Context, userID string) context.Context
• func WithUsername(ctx context.Context, username string) context.Context

Functions

func AccessToken

func AccessToken(ctx context.Context) string

AccessToken 从上下文中提取访问令牌.

func UserID

func UserID(ctx context.Context) string

UserID 从上下文中提取用户 ID.

func Username

func Username(ctx context.Context) string

User 从上下文中提取用户名.

func WithAccessToken

func WithAccessToken(ctx context.Context, accessToken string) context.Context

WithAccessToken 将访问令牌存放到上下文中.

func WithUserID

func WithUserID(ctx context.Context, userID string) context.Context

WithUserID 将用户 ID 存放到上下文中.

func WithUsername

func WithUsername(ctx context.Context, username string) context.Context

WithUsername 将用户名存放到上下文中.