From c64e328ea49d3b78b9e64a2c4d73df4ace2f74ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=99=BD=E8=8C=B6=E6=B8=85=E6=AC=A2?= Date: Sun, 12 Oct 2025 17:32:04 +0800 Subject: [PATCH] feat: migrate logger impl --- go.sum | 20 +---- logger/gorm_v2.go | 176 +++++++++++++++++++++++++++++++++++++++++++ wrapper_db_client.go | 53 ++----------- 3 files changed, 185 insertions(+), 64 deletions(-) create mode 100644 logger/gorm_v2.go diff --git a/go.sum b/go.sum index 27de240..578d659 100644 --- a/go.sum +++ b/go.sum @@ -42,8 +42,6 @@ github.com/gabriel-vasile/mimetype v1.4.10 h1:zyueNbySn/z8mJZHLt6IPw0KoZsiQNszIp github.com/gabriel-vasile/mimetype v1.4.10/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= github.com/gin-contrib/sse v1.1.0/go.mod h1:hxRZ5gVpWMT7Z0B0gSNYqqsSCNIJMjzvm6fqCz9vjwM= -github.com/gin-gonic/gin v1.10.1 h1:T0ujvqyCSqRopADpgPgiTT63DUQVSfojyME59Ei63pQ= -github.com/gin-gonic/gin v1.10.1/go.mod h1:4PMNQiOhvDRa013RKVbsiNwoyezlm2rm0uX/T7kzp5Y= github.com/gin-gonic/gin v1.11.0 h1:OW/6PLjyusp2PPXtyxKHU0RbX6I/l28FTdDlae5ueWk= github.com/gin-gonic/gin v1.11.0/go.mod h1:+iq/FyxlGzII0KHiBGjuNn4UNENUlKbGlNmc+W50Dls= github.com/go-ini/ini v1.67.0 h1:z6ZrTEZqSWOTyH2FlglNbNgARyHG8oLW9gMELqKr06A= @@ -54,8 +52,6 @@ github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/o github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= -github.com/go-playground/validator/v10 v10.27.0 h1:w8+XrWVMhGkxOaaowyKH35gFydVHOvC0/uWoy2Fzwn4= -github.com/go-playground/validator/v10 v10.27.0/go.mod h1:I5QpIEbmr8On7W0TktmJAumgzX4CA1XNl4ZmDuVHKKo= github.com/go-playground/validator/v10 v10.28.0 h1:Q7ibns33JjyW48gHkuFT91qX48KG0ktULL6FgHdG688= github.com/go-playground/validator/v10 v10.28.0/go.mod h1:GoI6I1SjPBh9p7ykNE/yj3fFYbyDOpwMn5KXd+m2hUU= github.com/go-sql-driver/mysql v1.9.3 h1:U/N249h2WzJ3Ukj8SowVFjdtZKfu9vlLZxjPXV1aweo= @@ -137,8 +133,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= @@ -161,29 +157,19 @@ go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= -golang.org/x/arch v0.21.0 h1:iTC9o7+wP6cPWpDWkivCvQFGAHDQ59SrSxsLPcnkArw= -golang.org/x/arch v0.21.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= golang.org/x/arch v0.22.0 h1:c/Zle32i5ttqRXjdLyyHZESLD/bB90DCU1g9l/0YBDI= golang.org/x/arch v0.22.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= -golang.org/x/crypto v0.42.0 h1:chiH31gIWm57EkTXpwnqf8qeuMUi0yekh6mT2AvFlqI= -golang.org/x/crypto v0.42.0/go.mod h1:4+rDnOTJhQCx2q7/j6rAN5XDw8kPjeaXEUR2eL94ix8= golang.org/x/crypto v0.43.0 h1:dduJYIi3A3KOfdGOHX8AVZ/jGiyPa3IbBozJ5kNuE04= golang.org/x/crypto v0.43.0/go.mod h1:BFbav4mRNlXJL4wNeejLpWxB7wMbc79PdRGhWKncxR0= golang.org/x/mod v0.29.0 h1:HV8lRxZC4l2cr3Zq1LvtOsi/ThTgWnUk/y64QSs8GwA= golang.org/x/mod v0.29.0/go.mod h1:NyhrlYXJ2H4eJiRy/WDBO6HMqZQ6q9nk4JzS3NuCK+w= -golang.org/x/net v0.44.0 h1:evd8IRDyfNBMBTTY5XRF1vaZlD+EmWx6x8PkhR04H/I= -golang.org/x/net v0.44.0/go.mod h1:ECOoLqd5U3Lhyeyo/QDCEVQ4sNgYsqvCZ722XogGieY= golang.org/x/net v0.46.0 h1:giFlY12I07fugqwPuWJi68oOnpfqFnJIJzaIIm2JVV4= golang.org/x/net v0.46.0/go.mod h1:Q9BGdFy1y4nkUwiLvT5qtyhAnEHgnQ/zd8PfU6nc210= golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug= golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.36.0 h1:KVRy2GtZBrk1cBYA7MKu5bEZFxQk4NIDV6RLVcC8o0k= -golang.org/x/sys v0.36.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= golang.org/x/sys v0.37.0 h1:fdNQudmxPjkdUTPnLn5mdQv7Zwvbvpaxqs831goi9kQ= golang.org/x/sys v0.37.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= -golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk= -golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4= golang.org/x/text v0.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k= golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM= golang.org/x/tools v0.38.0 h1:Hx2Xv8hISq8Lm16jvBZ2VQf+RLmbd7wVUsALibYI/IQ= @@ -191,8 +177,6 @@ golang.org/x/tools v0.38.0/go.mod h1:yEsQ/d/YK8cjh0L6rZlY8tgtlKiBNTL14pGDJPJpYQs golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 h1:+cNy6SZtPcJQH3LJVLOSmiC7MMxXNOb3PU/VUEz+EhU= golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90= -google.golang.org/protobuf v1.36.9 h1:w2gp2mA27hUeUzj9Ex9FBjsBm40zfaDtEWow293U7Iw= -google.golang.org/protobuf v1.36.9/go.mod h1:fuxRtAxBytpl4zzqUh6/eyUujkJdNiuEkXntxiD/uRU= google.golang.org/protobuf v1.36.10 h1:AYd7cD/uASjIL6Q9LiTjz8JLcrh/88q5UObnmY3aOOE= google.golang.org/protobuf v1.36.10/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/logger/gorm_v2.go b/logger/gorm_v2.go new file mode 100644 index 0000000..1e44445 --- /dev/null +++ b/logger/gorm_v2.go @@ -0,0 +1,176 @@ +// Package logger ... +// +// Description : logger ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2025-10-12 17:23 +package logger + +import ( + "context" + "fmt" + "strings" + "time" + + "git.zhangdeman.cn/zhangdeman/consts" + + "gorm.io/gorm" + + "go.uber.org/zap/zapcore" + + "go.uber.org/zap" + + loggerPkg "git.zhangdeman.cn/zhangdeman/logger" + "gorm.io/gorm/logger" +) + +// NewGormV2 获取日志实例 +func NewGormV2(loggerLevel consts.LogLevel, consoleOutput bool, encoder zapcore.Encoder, splitConfig *loggerPkg.RotateLogConfig, traceIDField string, skip int) (logger.Interface, error) { + logConfList := []loggerPkg.SetLoggerOptionFunc{loggerPkg.WithEncoder(encoder), loggerPkg.WithCallerSkip(skip), loggerPkg.WithCaller()} + if consoleOutput { + logConfList = append(logConfList, loggerPkg.WithConsoleOutput()) + } + + logInstance, err := loggerPkg.NewLogger(loggerLevel, splitConfig, logConfList...) + if nil != err { + return nil, err + } + if len(traceIDField) == 0 { + traceIDField = "trace_id" + } + + return &Gorm{ + instance: logInstance, + traceIDField: traceIDField, + }, nil +} + +// NewGormLoggerWithInstance 获取gorm日志实现 +func NewGormLoggerWithInstance(outCtx context.Context, dbClient *gorm.DB, instance *zap.Logger, node string, extraCtxFieldList []string) logger.Interface { + nodeArr := strings.Split(node, "|") + i := &Gorm{ + dbClient: dbClient, + instance: instance, + traceIDField: consts.GinTraceIDField, + extraCtxFieldList: extraCtxFieldList, + flag: "", + node: node, + outCtx: outCtx, + } + if len(nodeArr) >= 2 { + i.node = nodeArr[1] + i.flag = nodeArr[0] + } + return i +} + +// Gorm v2 版本库日志实现 +type Gorm struct { + dbClient *gorm.DB + instance *zap.Logger // 日志实例 + traceIDField string // 串联请求上下文的的ID + extraCtxFieldList []string // 从请求上线问提取的字段 + flag string // 数据库标识 + node string // 数据库节点 master / slave + outCtx context.Context +} + +// LogMode ... +func (g *Gorm) LogMode(level logger.LogLevel) logger.Interface { + return g +} + +// Info 日志 +func (g *Gorm) Info(ctx context.Context, s string, i ...any) { + g.write(ctx, s, consts.LogLevelInfo, map[string]any{ + "log_data": i, + }) +} + +// Warn ... +func (g *Gorm) Warn(ctx context.Context, s string, i ...any) { + g.write(ctx, s, consts.LogLevelWarn, map[string]any{ + "log_data": i, + }) +} + +// Error 日志 +func (g *Gorm) Error(ctx context.Context, s string, i ...any) { + g.write(ctx, s, consts.LogLevelError, map[string]any{ + "log_data": i, + }) +} + +// Trace Trace 记录 +func (g *Gorm) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error) { + start := begin.UnixNano() + end := time.Now().UnixNano() + sql := "" + affectRows := int64(0) + if nil != fc { + sql, affectRows = fc() + } + + logData := map[string]any{ + "db_flag": g.flag, + "db_node": g.node, + "begin_time": start, + "finish_time": end, + "used_time": (end - start) / 1e6, + "sql": sql, + "affect_rows": affectRows, + "err": "", + } + if nil != err { + logData["err"] = err.Error() + } + g.write(ctx, "SQL执行记录", consts.LogLevelInfo, logData) +} + +// write ... +func (g *Gorm) write(ctx context.Context, message string, level consts.LogLevel, data map[string]any) { + if len(message) == 0 { + message = "SQL执行记录" + } + if nil == g.instance { + // 未设置日志实例 + return + } + if nil == data { + data = make(map[string]any) + } + if nil != data["sql"] { + sqlStr := strings.TrimSpace(fmt.Sprintf("%v", data["sql"])) + sqlArr := strings.Split(sqlStr, " ") + if len(sqlArr) > 0 { + data["sql_type"] = strings.ToUpper(sqlArr[0]) + } + } + if nil == g.outCtx { + g.outCtx = context.Background() + } + + dataList := loggerPkg.ZapLogDataList(loggerPkg.NewLogData(g.outCtx, consts.LogTypeDatabase, "", data)) + switch level { + case consts.LogLevelDebug: + g.instance.Debug(message, dataList...) + case consts.LogLevelInfo: + g.instance.Info(message, dataList...) + case consts.LogLevelWarn: + g.instance.Warn(message, dataList...) + case consts.LogLevelError: + g.instance.Error(message, dataList...) + case consts.LogLevelPanic: + g.instance.Panic(message, dataList...) + default: + g.instance.Info(message, dataList...) + } +} + +// GetGormSQL 获取trace fn +func GetGormSQL(dbClient *gorm.DB) func() (string, int64) { + return func() (string, int64) { + return dbClient.Dialector.Explain(dbClient.Statement.SQL.String(), dbClient.Statement.Vars...), dbClient.RowsAffected + } +} diff --git a/wrapper_db_client.go b/wrapper_db_client.go index 70298e1..d9786d5 100644 --- a/wrapper_db_client.go +++ b/wrapper_db_client.go @@ -11,24 +11,21 @@ import ( "context" "errors" "fmt" + "strings" + "sync" + "time" + "git.zhangdeman.cn/zhangdeman/consts" "git.zhangdeman.cn/zhangdeman/database/define" - "git.zhangdeman.cn/zhangdeman/logger/wrapper" + "git.zhangdeman.cn/zhangdeman/database/logger" "go.uber.org/zap" "gorm.io/driver/mysql" "gorm.io/driver/sqlite" "gorm.io/gorm" gormLogger "gorm.io/gorm/logger" - "strings" - "sync" - "time" ) // DBClient 包装日志实例 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 3:09 PM 2021/12/24 type DBClient struct { DbFlag string // 数据库标识 LoggerInstance *zap.Logger // 日志实例 @@ -42,10 +39,6 @@ type DBClient struct { } // Init 初始化客户端 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:44 2024/8/20 func (dc *DBClient) Init(databaseConfig *define.Database, cacheTableStructureConfig *define.CacheTableStructureConfig) error { dc.lock = &sync.RWMutex{} dc.cacheTableStructureConfig = cacheTableStructureConfig @@ -76,10 +69,6 @@ func (dc *DBClient) Init(databaseConfig *define.Database, cacheTableStructureCon } // GetMaster 获取主库连接 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 3:28 PM 2021/12/24 func (dc *DBClient) GetMaster(ctx context.Context) *gorm.DB { session := dc.master.Session(&gorm.Session{}) session.Logger = dc.getLogger(ctx, session, "master") @@ -87,10 +76,6 @@ func (dc *DBClient) GetMaster(ctx context.Context) *gorm.DB { } // GetSlave 获取从库链接 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 3:29 PM 2021/12/24 func (dc *DBClient) GetSlave(ctx context.Context) *gorm.DB { session := dc.slave.Session(&gorm.Session{}) session.Logger = dc.getLogger(ctx, session, "slave") @@ -98,12 +83,8 @@ func (dc *DBClient) GetSlave(ctx context.Context) *gorm.DB { } // getLogger 获取日志实例 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 3:45 PM 2021/12/24 func (dc *DBClient) getLogger(ctx context.Context, dbClient *gorm.DB, node string) gormLogger.Interface { - return wrapper.NewGormLoggerWithInstance(ctx, dbClient, dc.LoggerInstance, dc.DbFlag+"|"+node, dc.ExtraFieldList) + return logger.NewGormLoggerWithInstance(ctx, dbClient, dc.LoggerInstance, dc.DbFlag+"|"+node, dc.ExtraFieldList) } // GetDatabaseClient 获取数据库连接 @@ -142,16 +123,12 @@ func (dc *DBClient) GetDatabaseClient(conf *define.Driver, logInstance *zap.Logg } dbInstance.SetMaxIdleConns(conf.Connection.MaxIdle) dbInstance.SetMaxOpenConns(conf.Connection.MaxOpen) - instance.Logger = wrapper.NewGormLoggerWithInstance(nil, instance, logInstance, "", nil) + instance.Logger = logger.NewGormLoggerWithInstance(nil, instance, logInstance, "", nil) return instance, nil } // buildConnectionDSN 构建连接信息 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 18:42 2022/6/11 func (dc *DBClient) buildConnectionDSN(conf *define.Driver) string { if conf.DBType == consts.DatabaseDriverSqlite3 { // 兼容sqlite3 @@ -170,10 +147,6 @@ func (dc *DBClient) buildConnectionDSN(conf *define.Driver) string { } // CacheDataTableStructureConfig ... -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 15:03 2024/8/21 func (dc *DBClient) CacheDataTableStructureConfig() *define.CacheTableStructureConfig { if nil == dc.cacheTableStructureConfig { return &define.CacheTableStructureConfig{Enable: false, SyncTimeInterval: 3600} @@ -185,10 +158,6 @@ func (dc *DBClient) CacheDataTableStructureConfig() *define.CacheTableStructureC } // GetTableFieldList 获取表结构配置 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 15:07 2024/8/21 func (dc *DBClient) GetTableFieldList(tableName string) ([]*define.ColumnConfig, error) { if !dc.CacheDataTableStructureConfig().Enable { // 未启用缓存, 返回空list @@ -203,10 +172,6 @@ func (dc *DBClient) GetTableFieldList(tableName string) ([]*define.ColumnConfig, } // syncDbTableStructure 缓存表结构 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 15:17 2024/8/21 func (dc *DBClient) syncDbTableStructure(ignoreErr bool) error { if !dc.CacheDataTableStructureConfig().Enable { // 自动同步不可用 @@ -256,10 +221,6 @@ func (dc *DBClient) syncDbTableStructure(ignoreErr bool) error { } // SetTableStructure 设置表结构, 一旦调用人工设置, 则将终止自动同步 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:06 2024/8/23 func (dc *DBClient) SetTableStructure(tableConfigTable map[string][]*define.ColumnConfig) { if nil != dc.cacheTableStructureConfig { // 关闭自动同步