📝 完善readme

.gitignore

@@ -2,4 +2,3 @@
 vendor
 logs
 cache
-log

config.go

@@ -2,16 +2,16 @@ package logger
 
 import "fmt"
 
-type mode int
+type mode string
 
-var (
+const (
-	Dev  mode = 0
+	Dev  mode = "development"
-	Prod mode = 1
+	Prod mode = "production"
 )
 
 // LogConfig 日志配置
 type LogConfig struct {
-	Mode       mode   `env:"LOG_MODE"`             // dev, prod
+	Mode       mode   `env:"LOG_MODE" envDefault:"production"` // dev, prod
 	LokiEnable bool   `env:"LOG_LOKI_ENABLE"`                  // 是否启用Loki
 	FileEnable bool   `env:"LOG_FILE_ENABLE"`                  // 是否输出到文件
 	LokiHost   string `env:"LOG_LOKI_HOST"`                    // Loki地址

gorm.go

@@ -4,10 +4,13 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"go.uber.org/zap"
 	gl "gorm.io/gorm/logger"
 	"time"
 )
 
+var gormZap *zap.SugaredLogger
+
 // 基于Gorm的日志实现
 type gormLogger struct {
 	gl.Config
@@ -25,7 +28,7 @@ func (l gormLogger) Info(ctx context.Context, msg string, data ...interface{}) {
 	if l.LogLevel >= gl.Info {
 		//	// 去掉第一行
 		//	msg = strings.Join(strings.Split(msg, "\n")[1:], " ")
-		//	Say.Info(msg)
+		//	gormZap.Info(msg)
 		//
 		//	l.Printf(msg, append([]interface{}{utils.FileWithLineNum()}, data...)...)
 	}
@@ -60,12 +63,12 @@ func (l gormLogger) Trace(ctx context.Context, begin time.Time, fc func() (strin
 
 	switch {
 	case err != nil && l.LogLevel >= gl.Error && (!errors.Is(err, gl.ErrRecordNotFound) || !l.IgnoreRecordNotFoundError):
-		Say.Errorf("%s -> %s", err.Error(), sql)
+		gormZap.Errorf("%s -> %s", err.Error(), sql)
 	case elapsed > l.SlowThreshold && l.SlowThreshold != 0 && l.LogLevel >= gl.Warn:
 		slowLog := fmt.Sprintf("SLOW SQL >= %v", l.SlowThreshold)
-		Say.Warnf("%v -> %v", slowLog, sql)
+		gormZap.Warnf("%v -> %v", slowLog, sql)
 	case l.LogLevel == gl.Info:
-		Say.Info(msg)
+		gormZap.Info(msg)
 	}
 }
 

log/say.go

@@ -0,0 +1,75 @@
+package log
+
+import "go.uber.org/zap"
+
+// Debug uses fmt.Sprint to construct and log a message.
+func Debug(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Debug(args...)
+}
+
+// Info uses fmt.Sprint to construct and log a message.
+func Info(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Info(args...)
+}
+
+// Warn uses fmt.Sprint to construct and log a message.
+func Warn(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Warn(args...)
+}
+
+// Error uses fmt.Sprint to construct and log a message.
+func Error(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Error(args...)
+}
+
+// Panic uses fmt.Sprint to construct and log a message, then panics.
+func Panic(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Panic(args...)
+}
+
+// Fatal uses fmt.Sprint to construct and log a message, then calls os.Exit.
+func Fatal(args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Fatal(args...)
+}
+
+// Debugf uses fmt.Sprintf to log a templated message.
+func Debugf(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Debugf(template, args...)
+}
+
+// Infof uses fmt.Sprintf to log a templated message.
+func Infof(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Infof(template, args...)
+}
+
+// Warnf uses fmt.Sprintf to log a templated message.
+func Warnf(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Warnf(template, args...)
+}
+
+// Errorf uses fmt.Sprintf to log a templated message.
+func Errorf(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Errorf(template, args...)
+}
+
+// Panicf uses fmt.Sprintf to log a templated message, then panics.
+func Panicf(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Panicf(template, args...)
+}
+
+// Fatalf uses fmt.Sprintf to log a templated message, then calls os.Exit.
+func Fatalf(template string, args ...interface{}) {
+	defer zap.S().Sync()
+	zap.S().Fatalf(template, args...)
+}

logger.go

@@ -19,6 +19,10 @@ func init() {
 			fmt.Println("日志配置解析错误: " + err.Error())
 			c = LogConfig{Mode: Dev, LokiEnable: false, FileEnable: false}
 		}
+		// 如果值错了，直接默认为Prod
+		if c.Mode != Dev && c.Mode != Prod {
+			c.Mode = Prod
+		}
 		InitLogger(c)
 	}
 }
@@ -45,5 +49,7 @@ func InitLogger(c LogConfig) {
 	// AddCallerSkip 输出的文件名和行号是调用封装函数的位置，而不是调用日志函数的位置
 	logger := zap.New(zapcore.NewTee(cores...), zap.AddCaller(), zap.AddCallerSkip(1))
 	Say = logger.Sugar()
+	// 给GORM单独生成一个
+	gormZap = zap.New(zapcore.NewTee(cores...), zap.AddCaller(), zap.AddCallerSkip(3)).Sugar()
 	zap.ReplaceGlobals(logger)
 }

logger_test.go

@@ -1,7 +1,7 @@
 package logger
 
 import (
-	"go.uber.org/zap"
+	"gitee.ltd/lxh/logger/log"
 	"testing"
 	"time"
 )
@@ -18,6 +18,6 @@ func TestLogger1(t *testing.T) {
 
 func TestLogger2(t *testing.T) {
 	InitLogger(LogConfig{Mode: Dev, LokiEnable: false, FileEnable: true})
-	zap.S().Info("我是测试消息")
+	log.Info("我是测试消息")
-	time.Sleep(5 * time.Second)
+	//time.Sleep(5 * time.Second)
 }

readme.md

@@ -5,17 +5,20 @@
 ```go
 package main
 
-import "gitee.ltd/lxh/logger"
+import (
+	"gitee.ltd/lxh/logger"
+	"gitee.ltd/lxh/logger/log"
+)
 
 func main() {
 	logger.InitLogger(logger.LogConfig{Mode: logger.Dev, LokiEnable: false, FileEnable: true})
-	logger.Say.Debug("芜湖")
+	log.Debug("芜湖")
 }
 ```
 
 ### 环境变量
 ```shell
-export LOG_MODE=0 # 0: dev, 1: prod
+export LOG_MODE=0 # development | production
 export LOG_LOKI_ENABLE=1 # 是否启用Loki 0: disable, 1: enable
 export LOG_FILE_ENABLE=0 # 是否启用输出到文件 0: disable, 1: enable
 export LOG_LOKI_HOST=10.0.0.31 # Loki地址