feat(gerror): error包实现

morehao · Jun 26, 2024 · 1356bfc · 1356bfc
1 parent c1bb966
commit 1356bfc
Show file tree

Hide file tree

Showing 6 changed files with 138 additions and 37 deletions.
diff --git a/dbClient/orm_logger.go b/dbClient/orm_logger.go
@@ -79,20 +79,20 @@ func (l *ormLogger) Trace(ctx context.Context, begin time.Time, fc func() (strin
 		ralCode = -1
 	}
 	sql, rows := fc()
-	if len(sql) > l.MaxSqlLen {
+	if len(sql) > l.MaxSqlLen && l.MaxSqlLen > 0 {
 		sql = sql[:l.MaxSqlLen]
 	}
 
 	fileLineNum := utils.FileWithLineNum()
 	fields := l.commonFields(ctx)
 	fields = append(fields,
-		"affectedRow", rows,
-		"requestStartTime", glog.FormatRequestTime(begin),
-		"requestEndTime", glog.FormatRequestTime(end),
-		"file", fileLineNum,
-		"cost", cost,
-		"ralCode", ralCode,
-		"sql", sql,
+		glog.KeyAffectedRows, rows,
+		glog.KeyRequestStartTime, glog.FormatRequestTime(begin),
+		glog.KeyRequestEndTime, glog.FormatRequestTime(end),
+		glog.KeyFile, fileLineNum,
+		glog.KeyCost, cost,
+		glog.KeyRalCode, ralCode,
+		glog.KeySql, sql,
 	)
 
 	if l.SlowThreshold > 0 && cost >= float64(l.SlowThreshold/time.Millisecond) {
@@ -105,10 +105,10 @@ func (l *ormLogger) Trace(ctx context.Context, begin time.Time, fc func() (strin
 
 func (l *ormLogger) commonFields(ctx context.Context) []interface{} {
 	fields := []interface{}{
-		glog.KeyProto, "mysql",
-		"service", l.Service,
-		"addr", l.Addr,
-		"database", l.Database,
+		glog.KeyProto, glog.ValueProtoMysql,
+		glog.KeyService, l.Service,
+		glog.KeyAddr, l.Addr,
+		glog.KeyDatabase, l.Database,
 	}
 	return fields
 }
diff --git a/dbClient/redis.go b/dbClient/redis.go
@@ -76,7 +76,7 @@ func (l redisLogger) ProcessHook(next redis.ProcessHook) redis.ProcessHook {
 		begin := time.Now()
 		fields := l.commonFields(ctx)
 		fields = append(fields,
-			"cmd", cmd.FullName(),
+			glog.KeyCmd, cmd.FullName(),
 		)
 		var ralCode int
 		if err := cmd.Err(); err != nil {
@@ -85,11 +85,11 @@ func (l redisLogger) ProcessHook(next redis.ProcessHook) redis.ProcessHook {
 			end := time.Now()
 			cost := glog.GetRequestCost(begin, end)
 			fields = append(fields,
-				"cmdContent", cmd.String(),
-				"ralCode", ralCode,
-				"requestStartTime", glog.FormatRequestTime(begin),
-				"requestEndTime", glog.FormatRequestTime(end),
-				"cost", cost,
+				glog.KeyCmdContent, cmd.String(),
+				glog.KeyRalCode, ralCode,
+				glog.KeyRequestStartTime, glog.FormatRequestTime(begin),
+				glog.KeyRequestEndTime, glog.FormatRequestTime(end),
+				glog.KeyCost, cost,
 			)
 			l.Logger.Errorw(ctx, msg, fields...)
 			return err
@@ -100,11 +100,11 @@ func (l redisLogger) ProcessHook(next redis.ProcessHook) redis.ProcessHook {
 		end := time.Now()
 		cost := glog.GetRequestCost(begin, end)
 		fields = append(fields,
-			"cmdContent", cmd.String(),
-			"ralCode", ralCode,
-			"requestStartTime", glog.FormatRequestTime(begin),
-			"requestEndTime", glog.FormatRequestTime(end),
-			"cost", cost,
+			glog.KeyCmdContent, cmd.String(),
+			glog.KeyRalCode, ralCode,
+			glog.KeyRequestStartTime, glog.FormatRequestTime(begin),
+			glog.KeyRequestEndTime, glog.FormatRequestTime(end),
+			glog.KeyCost, cost,
 		)
 
 		l.Logger.Infow(ctx, "redis execute success", fields...)
@@ -121,10 +121,10 @@ func (l redisLogger) ProcessPipelineHook(next redis.ProcessPipelineHook) redis.P
 
 func (l *redisLogger) commonFields(ctx context.Context) []interface{} {
 	fields := []interface{}{
-		glog.KeyProto, "redis",
-		"service", l.Service,
-		"addr", l.Addr,
-		"database", l.Database,
+		glog.KeyProto, glog.ValueProtoRedis,
+		glog.KeyService, l.Service,
+		glog.KeyAddr, l.Addr,
+		glog.KeyDatabase, l.Database,
 	}
 	return fields
 }
diff --git a/gerror/error.go b/gerror/error.go
@@ -1,10 +1,69 @@
 package gerror
 
+import (
+	"fmt"
+	"github.com/pkg/errors"
+)
+
 type Error struct {
 	Code int
 	Msg  string
 }
 
-func (err Error) Error() string {
-	return err.Msg
+// Error 方法实现了error接口，返回错误信息
+func (e Error) Error() string {
+	return e.Msg
+}
+
+// Wrap 用于包装错误信息
+func (e Error) Wrap(err error) error {
+	if err == nil {
+		return nil
+	}
+
+	// 保存原始错误信息
+	msg := e.Msg
+	// 更新错误信息，方便后续使用
+	e.Msg = err.Error()
+	return errors.Wrap(err, msg)
+}
+
+func (e Error) Wrapf(err error, format string, args ...interface{}) error {
+	if err == nil {
+		return nil
+	}
+
+	// 保存原始错误信息
+	msg := e.Msg
+	formattedMsg := fmt.Sprintf(format, args...)
+	e.Msg = err.Error()
+	return errors.Wrap(err, fmt.Sprintf("%s %s", formattedMsg, msg))
+}
+
+func (e Error) GetCode() int {
+	return e.Code
+}
+
+func (e Error) GetMsg() string {
+	return e.Msg
+}
+
+// ResetMsg 重置错误信息
+func (e Error) ResetMsg(msg string) {
+	e.Msg = msg
+}
+
+// AppendMsg 在既有错误信息的基础上追加新的错误信息
+func (e Error) AppendMsg(args ...interface{}) {
+	e.Msg += fmt.Sprint(args...)
+}
+
+// Is 判断是否为指定错误类型
+func (e Error) Is(targetErr error) bool {
+	return errors.Is(targetErr, e)
+}
+
+// As 判断是否为指定错误类型，并将错误信息赋值给目标变量
+func (e Error) As(targetErr interface{}) bool {
+	return errors.As(e, targetErr)
 }
diff --git a/gerror/error_test.go b/gerror/error_test.go
@@ -0,0 +1,31 @@
+package gerror
+
+import (
+	"testing"
+)
+
+func TestWrap(t *testing.T) {
+	err1 := Error{
+		Code: 1,
+		Msg:  "test1",
+	}
+	err2 := Error{
+		Code: 2,
+		Msg:  "test2",
+	}
+	err := err1.Wrap(err2)
+	t.Log(err)
+}
+
+func TestWrapf(t *testing.T) {
+	err1 := Error{
+		Code: 1,
+		Msg:  "test1",
+	}
+	err2 := Error{
+		Code: 2,
+		Msg:  "test2",
+	}
+	err := err1.Wrapf(err2, "here is errMsg:%s", "123")
+	t.Log(err)
+}
diff --git a/glog/constant.go b/glog/constant.go
@@ -31,9 +31,8 @@ const (
 	KeySpanId     = "spanId"
 
 	MsgFlagNotice = "notice"
-	MsgFlagMysql  = "mysql"
-	MsgFlagRedis  = "redis"
 
+	KeyService          = "service"
 	KeyHost             = "host"
 	KeyClientIp         = "clientIp"
 	KeyHandle           = "handle"
@@ -53,10 +52,22 @@ const (
 	KeyResponseBodySize = "responseBodySize"
 	KeyRequestStartTime = "requestStartTime"
 	KeyRequestEndTime   = "requestEndTime"
-	KeyCostTime         = "cost"
+	KeyCost             = "cost"
 	KeyRequestErr       = "requestErr"
 	KeyErrorCode        = "errorCode"
 	KeyErrorMsg         = "errorMsg"
+	KeyAffectedRows     = "affectedRows"
+	KeyAddr             = "addr"
+	KeyDatabase         = "database"
+	KeySql              = "sql"
+	KeyCmd              = "cmd"
+	KeyCmdContent       = "cmdContent"
+	KeyRalCode          = "ralCode"
+	KeyFile             = "file"
+
+	ValueProtoHttp  = "http"
+	ValueProtoMysql = "mysql"
+	ValueProtoRedis = "redis"
 )
 
 type Level string

diff --git a/glog/zap_logger.go b/glog/zap_logger.go
@@ -257,11 +257,11 @@ func getZapEncoder() zapcore.Encoder {
 
 	// 配置编码器配置
 	encoderCfg := zapcore.EncoderConfig{
-		LevelKey:       "level",                       // 日志级别的键名，例如 "INFO", "ERROR"
-		TimeKey:        "time",                        // 时间戳的键名，记录日志生成的时间
-		StacktraceKey:  "stacktrace",                  // 堆栈跟踪的键名，记录日志产生时的堆栈信息
-		CallerKey:      "file",                        // 调用者的键名，记录日志调用的位置 (文件名和行号)
-		FunctionKey:    "function",                    // 函数名的键名，记录调用函数的名称
+		LevelKey:      "level",      // 日志级别的键名，例如 "INFO", "ERROR"
+		TimeKey:       "time",       // 时间戳的键名，记录日志生成的时间
+		StacktraceKey: "stacktrace", // 堆栈跟踪的键名，记录日志产生时的堆栈信息
+		CallerKey:     "file",       // 调用者的键名，记录日志调用的位置 (文件名和行号)
+		// FunctionKey:    "function",                    // 函数名的键名，记录调用函数的名称
 		MessageKey:     "msg",                         // 日志消息的键名，记录实际的日志内容
 		LineEnding:     zapcore.DefaultLineEnding,     // 日志行的结束符，默认使用换行符
 		EncodeCaller:   zapcore.ShortCallerEncoder,    // 调用者编码器，使用短格式 (文件名:行号)