diff --git a/go.mod b/go.mod index 4729958..256712f 100644 --- a/go.mod +++ b/go.mod @@ -27,7 +27,7 @@ require ( gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df gopkg.in/yaml.v2 v2.4.0 gorm.io/driver/mysql v1.2.0 - gorm.io/gorm v1.22.3 + gorm.io/gorm v1.22.4 ) require ( @@ -68,7 +68,7 @@ require ( github.com/jcmturner/gokrb5/v8 v8.4.2 // indirect github.com/jcmturner/rpc/v2 v2.0.3 // indirect github.com/jinzhu/inflection v1.0.0 // indirect - github.com/jinzhu/now v1.1.2 // indirect + github.com/jinzhu/now v1.1.4 // indirect github.com/jonboulle/clockwork v0.2.2 // indirect github.com/json-iterator/go v1.1.11 // indirect github.com/klauspost/compress v1.13.6 // indirect diff --git a/go.sum b/go.sum index 3064fc7..b5ad358 100644 --- a/go.sum +++ b/go.sum @@ -294,6 +294,9 @@ github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc= github.com/jinzhu/now v1.1.2 h1:eVKgfIdy9b6zbWBMgFpfDPoAMifwSZagU9HmEU6zgiI= github.com/jinzhu/now v1.1.2/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= +github.com/jinzhu/now v1.1.3/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= +github.com/jinzhu/now v1.1.4 h1:tHnRBy1i5F2Dh8BAFxqFzxKqqvezXrL2OW1TnX+Mlas= +github.com/jinzhu/now v1.1.4/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= github.com/jonboulle/clockwork v0.2.2 h1:UOGuzwb1PwsrDAObMuhUnj0p5ULPj8V/xJ7Kx9qUBdQ= github.com/jonboulle/clockwork v0.2.2/go.mod h1:Pkfl5aHPm1nk2H9h0bjmnJD/BcgbGXUBGnn1kMkgxc8= github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4= @@ -933,6 +936,8 @@ gorm.io/driver/mysql v1.2.0 h1:l8+9VwjjyzEkw0PNPBOr2JHhLOGVk7XEnl5hk42bcvs= gorm.io/driver/mysql v1.2.0/go.mod h1:4RQmTg4okPghdt+kbe6e1bTXIQp7Ny1NnBn/3Z6ghjk= gorm.io/gorm v1.22.3 h1:/JS6z+GStEQvJNW3t1FTwJwG/gZ+A7crFdRqtvG5ehA= gorm.io/gorm v1.22.3/go.mod h1:F+OptMscr0P2F2qU97WT1WimdH9GaQPoDW7AYd5i2Y0= +gorm.io/gorm v1.22.4 h1:8aPcyEJhY0MAt8aY6Dc524Pn+pO29K+ydu+e/cXSpQM= +gorm.io/gorm v1.22.4/go.mod h1:1aeVC+pe9ZmvKZban/gW4QPra7PRoTEssyc922qCAkk= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= diff --git a/logger/wrapper/gorm_v2.go b/logger/wrapper/gorm_v2.go index 0a767f4..9faae75 100644 --- a/logger/wrapper/gorm_v2.go +++ b/logger/wrapper/gorm_v2.go @@ -10,8 +10,11 @@ package wrapper import ( "context" "fmt" + "strings" "time" + "github.com/gin-gonic/gin" + "gorm.io/gorm" "go.uber.org/zap/zapcore" @@ -47,15 +50,36 @@ func NewGormV2(loggerLevel zapcore.Level, consoleOutput bool, encoder zapcore.En }, nil } +// NewGormLoggerWithInstance 获取gorm日志实现 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:36 PM 2021/12/24 +func NewGormLoggerWithInstance(ctx *gin.Context, dbClient *gorm.DB, instance *zap.Logger, node string, extraCtxFieldList []string) logger.Interface { + return &Gorm{ + dbClient: dbClient, + instance: instance, + traceIDField: "", + extraCtxFieldList: extraCtxFieldList, + flag: "", + node: node, + ctx: ctx, + } +} + // Gorm v2 版本库日志实现 // // Author : go_developer@163.com<白茶清欢> // // Date : 9:55 下午 2021/3/1 type Gorm struct { - instance *zap.Logger // 日志实例 - traceIDField string // 串联请求上下文的的ID - flag string // 数据库标识 + dbClient *gorm.DB + instance *zap.Logger // 日志实例 + traceIDField string // 串联请求上下文的的ID + extraCtxFieldList []string // 从请求上线问提取的字段 + flag string // 数据库标识 + node string // 数据库节点 master / slave + ctx *gin.Context // gin上下文 } // LogMode ... @@ -73,12 +97,7 @@ func (g *Gorm) LogMode(level logger.LogLevel) logger.Interface { // // Date : 10:18 下午 2021/3/1 func (g *Gorm) Info(ctx context.Context, s string, i ...interface{}) { - g.instance.Info( - "Info日志", - zap.String(g.traceIDField, g.getTraceID(ctx)), - zap.String("db_flag", g.flag), - zap.String("message", fmt.Sprintf(s, i...)), - ) + g.write(nil, "info") } // Warn ... @@ -87,12 +106,7 @@ func (g *Gorm) Info(ctx context.Context, s string, i ...interface{}) { // // Date : 10:16 下午 2021/3/1 func (g *Gorm) Warn(ctx context.Context, s string, i ...interface{}) { - g.instance.Warn( - "SQL执行产生Warning", - zap.String(g.traceIDField, g.getTraceID(ctx)), - zap.String("db_flag", g.flag), - zap.String("message", fmt.Sprintf(s, i...)), - ) + g.write(nil, "warn") } // Error 日志 @@ -101,12 +115,7 @@ func (g *Gorm) Warn(ctx context.Context, s string, i ...interface{}) { // // Date : 10:18 下午 2021/3/1 func (g *Gorm) Error(ctx context.Context, s string, i ...interface{}) { - g.instance.Warn( - "SQL执行产生Error", - zap.String(g.traceIDField, g.getTraceID(ctx)), - zap.String("db_flag", g.flag), - zap.String("message", fmt.Sprintf(s, i...)), - ) + g.write(nil, "error") } // Trace Trace 记录 @@ -123,8 +132,7 @@ func (g *Gorm) Trace(ctx context.Context, begin time.Time, fc func() (string, in sql, affectRows = fc() } - g.instance.Info( - "SQL执行记录", + dataList := []zap.Field{ zap.String(g.traceIDField, g.getTraceID(ctx)), zap.String("db_flag", g.flag), zap.Int64("begin_time", start), @@ -133,7 +141,45 @@ func (g *Gorm) Trace(ctx context.Context, begin time.Time, fc func() (string, in zap.String("sql", sql), zap.Int64("affect_rows", affectRows), zap.Error(err), - ) + } + g.write(dataList, "info") + +} + +// write ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 4:11 PM 2021/12/24 +func (g *Gorm) write(dataList []zap.Field, level string) { + if nil == g.instance { + // 未设置日志实例 + return + } + if nil == dataList { + dataList = make([]zap.Field, 0) + } + if nil != g.ctx { + for _, extraField := range g.extraCtxFieldList { + dataList = append(dataList, zap.Any(extraField, g.ctx.Value(extraField))) + } + } + + // 补齐 flag、node + sql := g.dbClient.Dialector.Explain(g.dbClient.Statement.SQL.String(), g.dbClient.Statement.Vars...) + affectRows := g.dbClient.RowsAffected + dataList = append(dataList, zap.String("db_node", g.node), zap.String("db_flag", g.flag), zap.String("execute_sql", sql), zap.Int64("affext_rows", affectRows)) + message := "SQL执行记录" + switch strings.ToLower(level) { + case "info": + g.instance.Info(message, dataList...) + case "warn": + g.instance.Warn(message, dataList...) + case "error": + g.instance.Error(message, dataList...) + default: + g.instance.Info(message, dataList...) + } } // getTraceID 获取traceID @@ -145,7 +191,7 @@ func (g *Gorm) getTraceID(ctx context.Context) string { return fmt.Sprintf("%v", ctx.Value(g.traceIDField)) } -// GetGormSQL 获取tracefn +// GetGormSQL 获取trace fn // // Author : go_developer@163.com<白茶清欢> // diff --git a/middleware/mysql/client.go b/middleware/mysql/client.go index 86ff69d..80a1838 100644 --- a/middleware/mysql/client.go +++ b/middleware/mysql/client.go @@ -10,14 +10,107 @@ package mysql import ( "fmt" - "git.zhangdeman.cn/zhangdeman/gopkg/logger" - "git.zhangdeman.cn/zhangdeman/gopkg/logger/wrapper" + "github.com/gin-gonic/gin" + + "go.uber.org/zap" + + "git.zhangdeman.cn/zhangdeman/gopkg/logger" + gormLogger "gorm.io/gorm/logger" "gorm.io/driver/mysql" "gorm.io/gorm" ) +// NewDBClient ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:09 PM 2021/12/24 +func NewDBClient(masterConf *DBConfig, slaveConf *DBConfig, logConf *LogConfig, loggerInstance *zap.Logger, extraRequestFieldList []string) (*DBClient, error) { + client := &DBClient{ + extraFieldList: extraRequestFieldList, + } + var err error + // 日志初始化失败 + if client.loggerInstance, err = getLogInstance(logConf, loggerInstance); nil != err { + return nil, err + } + if client.master, err = GetDatabaseClient(masterConf, nil); nil != err { + return nil, err + } + if client.slave, err = GetDatabaseClient(slaveConf, nil); nil != err { + return nil, err + } + return client, nil +} + +// DBClient 包装日志实例 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:09 PM 2021/12/24 +type DBClient struct { + loggerInstance *zap.Logger + master *gorm.DB + slave *gorm.DB + extraFieldList []string +} + +// GetMaster 获取主库连接 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:28 PM 2021/12/24 +func (dc *DBClient) GetMaster(ctx *gin.Context) *gorm.DB { + session := dc.master.Session(&gorm.Session{}) + session.Logger = dc.getLogger(ctx, session, "slave") + return session +} + +// GetSlave 获取从库链接 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:29 PM 2021/12/24 +func (dc *DBClient) GetSlave(ctx *gin.Context) *gorm.DB { + session := dc.slave.Session(&gorm.Session{}) + session.Logger = dc.getLogger(ctx, session, "slave") + return session +} + +// getLogger 获取日志实例 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:45 PM 2021/12/24 +func (dc *DBClient) getLogger(ctx *gin.Context, dbClient *gorm.DB, node string) gormLogger.Interface { + return wrapper.NewGormLoggerWithInstance(ctx, dbClient, dc.loggerInstance, node, dc.extraFieldList) +} + +// getLogInstance 获取日志实例 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 3:20 PM 2021/12/24 +func getLogInstance(logConf *LogConfig, loggerInstance *zap.Logger) (*zap.Logger, error) { + if nil != loggerInstance { + return loggerInstance, nil + } + logConfList := []logger.SetLoggerOptionFunc{logger.WithEncoder(logConf.Encoder), logger.WithCallerSkip(logConf.Skip), logger.WithCaller()} + if logConf.ConsoleOutput { + logConfList = append(logConfList, logger.WithConsoleOutput()) + } + + var ( + err error + ) + if loggerInstance, err = logger.NewLogger(logConf.Level, logConf.SplitConfig, logConfList...); nil != err { + return nil, err + } + return loggerInstance, nil +} + // GetDatabaseClient 获取日志实例 // // Author : go_developer@163.com<白茶清欢> @@ -25,35 +118,22 @@ import ( // Date : 10:49 下午 2021/3/1 func GetDatabaseClient(conf *DBConfig, logConf *LogConfig) (*gorm.DB, error) { var ( - instance *gorm.DB - err error + instance *gorm.DB + err error + loggerInstance *zap.Logger ) if instance, err = gorm.Open(mysql.Open(buildConnectionDSN(conf)), &gorm.Config{}); nil != err { return nil, err } - if len(logConf.TraceFieldName) == 0 { - logConf.TraceFieldName = defaultTraceFieldName + if nil != logConf { + if loggerInstance, err = getLogInstance(logConf, nil); nil != err { + return nil, err + } + instance.Logger = wrapper.NewGormLoggerWithInstance(nil, instance, loggerInstance, "", nil) } - splitConfigFuncList := []logger.SetRotateLogConfigFunc{ - logger.WithTimeIntervalType(logConf.SplitConfig.TimeIntervalType), - logger.WithDivisionChar(logConf.SplitConfig.DivisionChar), - logger.WithMaxAge(logConf.SplitConfig.MaxAge), - } - - splitConfig, _ := logger.NewRotateLogConfig(logConf.SplitConfig.LogPath, logConf.SplitConfig.LogFileName, splitConfigFuncList...) - - if instance.Logger, err = wrapper.NewGormV2( - logConf.Level, - logConf.ConsoleOutput, - logConf.Encoder, - splitConfig, - logConf.TraceFieldName, - logConf.Skip); nil != err { - return nil, CreateDBLogError(err) - } return instance, nil } diff --git a/middleware/mysql/define.go b/middleware/mysql/define.go index 8c21092..c45b1b7 100644 --- a/middleware/mysql/define.go +++ b/middleware/mysql/define.go @@ -42,8 +42,3 @@ type LogConfig struct { TraceFieldName string Skip int } - -const ( - // defaultTraceFieldName 默认trace_id字段 - defaultTraceFieldName = "trace_id" -)