zhangdeman/gin
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

优化 GinContext 定义

Browse Source
This commit is contained in:
白茶清欢 2025-03-10 14:07:51 +08:00
parent 13d1ab6607
commit 28da213bb8
3 changed files with 49 additions and 55 deletions

4
go.mod

@ -11,7 +11,9 @@ require (
git.zhangdeman.cn/zhangdeman/logger v0.0.0-20241125083316-eab7bab9d7ad
git.zhangdeman.cn/zhangdeman/network v0.0.0-20230925112156-f0eb86dd2442
git.zhangdeman.cn/zhangdeman/serialize v0.0.0-20241223084948-de2e49144fcd
git.zhangdeman.cn/zhangdeman/trace v0.0.0-20231220041950-807f3d74a6fa
git.zhangdeman.cn/zhangdeman/wrapper v0.0.0-20250124091620-c757e551a8c9
github.com/gin-contrib/pprof v1.5.2
github.com/gin-gonic/gin v1.10.0
github.com/go-playground/validator/v10 v10.25.0
github.com/mcuadros/go-defaults v1.2.0
@ -23,7 +25,6 @@ require (
git.zhangdeman.cn/zhangdeman/easylock v0.0.0-20230731062340-983985c12eda // indirect
git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20241101082529-28a6c68e38a4 // indirect
git.zhangdeman.cn/zhangdeman/op_type v0.0.0-20240122104027-4928421213c0 // indirect
git.zhangdeman.cn/zhangdeman/trace v0.0.0-20231220041950-807f3d74a6fa // indirect
git.zhangdeman.cn/zhangdeman/util v0.0.0-20240618042405-6ee2c904644e // indirect
git.zhangdeman.cn/zhangdeman/websocket v0.0.0-20241125101541-c5ea194c9c1e // indirect
github.com/BurntSushi/toml v1.4.0 // indirect
@ -34,7 +35,6 @@ require (
github.com/cloudwego/base64x v0.1.5 // indirect
github.com/dgrijalva/jwt-go/v4 v4.0.0-preview1 // indirect
github.com/gabriel-vasile/mimetype v1.4.8 // indirect
github.com/gin-contrib/pprof v1.5.2 // indirect
github.com/gin-contrib/sse v1.0.0 // indirect
github.com/go-ini/ini v1.67.0 // indirect
github.com/go-openapi/jsonpointer v0.21.0 // indirect

12
go.sum

@ -1,13 +1,5 @@
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250219142545-bd7f6d2cfd99 h1:VYwbWsMcgQ7yWAGHB2v8Zbhh/5NIcQUq3yxay09zjkY=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250219142545-bd7f6d2cfd99/go.mod h1:oNTwnepzW09RNfIQCpgmbiayTKLvGx2XP92esfkxv98=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220082250-6987b4829bf6 h1:C8otP/n4SPc8hQQxd9jOnPxb24l0KMhTNpxWtwz20js=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220082250-6987b4829bf6/go.mod h1:oNTwnepzW09RNfIQCpgmbiayTKLvGx2XP92esfkxv98=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220095851-22d937a4b1cb h1:E+KXP29m18dNfyVU8zBIBAEqE7aspLqFHa1bOnIMdq4=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220095851-22d937a4b1cb/go.mod h1:oNTwnepzW09RNfIQCpgmbiayTKLvGx2XP92esfkxv98=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220105101-71d6db967dc5 h1:UV2+nD9HQLbRt+vY98gwPtkd+M8fbfffl7nb4Mkymmc=
git.zhangdeman.cn/gateway/api-doc v0.0.0-20250220105101-71d6db967dc5/go.mod h1:oNTwnepzW09RNfIQCpgmbiayTKLvGx2XP92esfkxv98=
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20250215141718-8232f587a6ea h1:6b9bfq44ewsXGVOkyZ+DQ4dNaKtmNsdHOFQxHUdEQrY=
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20250215141718-8232f587a6ea/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k=
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20250227040546-863c03f34bb8 h1:VEifPc+vkpEQoX9rj7zxmT1m+IA81XjOxe7+Z1aqWNM=
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20250227040546-863c03f34bb8/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k=
git.zhangdeman.cn/zhangdeman/easylock v0.0.0-20230731062340-983985c12eda h1:bMD6r9gjRy7cO+T4zRQVYAesgIblBdTnhzT1vN5wjvI=
@ -97,8 +89,6 @@ github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFF
github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
github.com/klauspost/cpuid/v2 v2.2.9 h1:66ze0taIn2H33fBvCkXuv9BmCwDfafmiIVpKV9kKGuY=
github.com/klauspost/cpuid/v2 v2.2.9/go.mod h1:rqkxqrZ1EhYM9G+hXH7YdowN5R5RGN6NK4QwQ3WMXF8=
github.com/klauspost/cpuid/v2 v2.2.10 h1:tBs3QSyvjDyFTq3uoc/9xFpCuOsJQFNPiAhYdw2skhE=
github.com/klauspost/cpuid/v2 v2.2.10/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0=
github.com/knz/go-libedit v1.10.1/go.mod h1:MZTVkCWyz0oBc7JOWP3wNAzd002ZbM/5hgShxwh4x8M=
@ -188,8 +178,6 @@ golang.org/x/arch v0.14.0 h1:z9JUEZWr8x4rR0OU6c4/4t6E6jOZ8/QBS2bBYBm4tx4=
golang.org/x/arch v0.14.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus=
golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs=
golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=

88
request/context.go

@ -10,9 +10,9 @@ package request
import (
"fmt"
networkUtil "git.zhangdeman.cn/zhangdeman/network/util"
"git.zhangdeman.cn/zhangdeman/trace"
"git.zhangdeman.cn/zhangdeman/wrapper"
"github.com/gin-gonic/gin"
"git.zhangdeman.cn/zhangdeman/trace"
"os"
"strings"
"sync"
@ -63,13 +63,16 @@ func getRequestID(ctx *gin.Context, traceID string) string {
func NewContext(ginContext *gin.Context) *Context {
// 生成traceID
traceID := getRequestID(ginContext, "")
hostname, _ := os.Hostname()
return &Context{
Context: ginContext,
StartRequestTime: time.Now(),
FinishRequestTime: time.Time(int64(0)),
HandlerAfterResponse: make([]gin.HandlerFunc, 0),
CustomData: make(map[string]any),
lock: &sync.RWMutex{},
customData: make(map[string]any),
Hostname: hostname,
HostIp: networkUtil.IP.GetHostIP(),
customLock: &sync.RWMutex{},
TraceID: traceID,
Trace: trace.NewRuntime(traceID, 0),
}
@ -82,14 +85,16 @@ func NewContext(ginContext *gin.Context) *Context {
// Date : 11:45 2025/2/28
type Context struct {
*gin.Context `json:"-"`
StartRequestTime time.Time // 开始请求时间(全局)
FinishRequestTime time.Time // 结束请求时间(全局)
TraceID string `json:"trace_id"` // 请求trace_id
ParentAppName string `json:"parent_app_name"` // 父级应用名称
HandlerAfterResponse []gin.HandlerFunc `json:"-"` // 响应数据之后需要执行的逻辑
CustomData map[string]any // 业务上下文自定义数据, 可以合 ginCtx.Value 作区分
lock *sync.RWMutex
Trace *trace.Runtime `json:"-"` // 追踪实例
StartRequestTime time.Time `json:"start_request_time"` // 开始请求时间(全局)
FinishRequestTime time.Time `json:"finish_request_time"` // 结束请求时间(全局)
TraceID string `json:"trace_id"` // 请求trace_id
ParentAppName string `json:"parent_app_name"` // 父级应用名称
HandlerAfterResponse []gin.HandlerFunc `json:"-"` // 响应数据之后需要执行的逻辑
Hostname string `json:"hostname"` // 服务器名称
HostIp string `json:"host_ip"` // 服务器IP
customData map[string]any `json:"-"` // 业务上下文自定义数据, 可以合 ginCtx.Value 作区分
customLock *sync.RWMutex `json:"-"` // 数据锁
Trace *trace.Runtime `json:"-"` // 追踪实例
}
// SetCustom 设置数据
@ -98,79 +103,80 @@ type Context struct {
//
// Date : 11:58 2025/2/28
func (ctx *Context) SetCustom(key string, val any) {
ctx.lock.Lock()
defer ctx.lock.Unlock()
if nil == ctx.CustomData {
ctx.CustomData = make(map[string]any)
ctx.customLock.Lock()
defer ctx.customLock.Unlock()
if nil == ctx.customData {
ctx.customData = make(map[string]any)
}
ctx.CustomData[key] = val
ctx.Set(key, val)
ctx.customData[key] = val
}
// CustomDataValue 获取customData
// customDataValue 获取customData
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 12:03 2025/2/28
func (ctx *Context) CustomDataValue(key string) any {
ctx.lock.RLock()
defer ctx.lock.RUnlock()
if val, exist := ctx.CustomData[key]; exist {
func (ctx *Context) customDataValue(key string) any {
ctx.customLock.RLock()
defer ctx.customLock.RUnlock()
if val, exist := ctx.customData[key]; exist {
return val
} else {
return nil
return ctx.Value(key)
}
}
// CustomDataExist 判断
// customDataExist 判断
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 12:04 2025/2/28
func (ctx *Context) CustomDataExist(key string) any {
ctx.lock.RLock()
defer ctx.lock.RUnlock()
_, exist := ctx.CustomData[key]
func (ctx *Context) customDataExist(key string) any {
ctx.customLock.RLock()
defer ctx.customLock.RUnlock()
_, exist := ctx.customData[key]
return exist
}
// CustomDataAppend 向数组数据中追加元素
// customDataAppend 向数组数据中追加元素
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 12:07 2025/2/28
func (ctx *Context) CustomDataAppend(key string, appendValue any) {
ctx.lock.Lock()
defer ctx.lock.Unlock()
val, exist := ctx.CustomData[key]
func (ctx *Context) customDataAppend(key string, appendValue any) {
ctx.customLock.Lock()
defer ctx.customLock.Unlock()
val, exist := ctx.customData[key]
if !exist || nil == val {
ctx.CustomData[key] = []any{appendValue}
ctx.customData[key] = []any{appendValue}
return
}
if valArr, ok := val.([]any); ok {
valArr = append(valArr, appendValue)
ctx.CustomData[key] = valArr
ctx.customData[key] = valArr
}
// 非数组, 忽略追加行为
}
// CustomDataAppendProperty 向一个map中追加/更新属性
// customDataAppendProperty 向一个map中追加/更新属性
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 12:11 2025/2/28
func (ctx *Context) CustomDataAppendProperty(key string, appendKey string, appendValue any) {
ctx.lock.Lock()
defer ctx.lock.Unlock()
val, exist := ctx.CustomData[key]
func (ctx *Context) customDataAppendProperty(key string, appendKey string, appendValue any) {
ctx.customLock.Lock()
defer ctx.customLock.Unlock()
val, exist := ctx.customData[key]
if !exist || nil == val {
ctx.CustomData[key] = map[string]any{
ctx.customData[key] = map[string]any{
appendKey: appendValue,
}
return
}
if valMap, ok := val.(map[string]any); ok {
valMap[appendKey] = appendValue
ctx.CustomData[key] = valMap
ctx.customData[key] = valMap
}
// 非map, 忽略追加行为
}