Merge pull request #1 from sunjunnan79/fix_gin

feat:gin部分拆分

Author: sunjunnan79

example/logger/logger.go

@@ -2,9 +2,9 @@ package main
 
 import (
 	"errors"
+	"github.com/muxi-Infra/muxi-micro/pkg/1"
+	"github.com/muxi-Infra/muxi-micro/pkg/1/zapx"
 	"github.com/muxi-Infra/muxi-micro/pkg/errs"
-	"github.com/muxi-Infra/muxi-micro/pkg/logger"
-	"github.com/muxi-Infra/muxi-micro/pkg/logger/zapx"
 )
 
 var DBNOData = errs.NewErr("db_no_data", "db has no data")

pkg/logger/logger.go

@@ -10,59 +10,4 @@ type Logger interface {
 	Sync() error
 }
 
-type Field struct {
-	Key string
-	Val any
-}
-
-func Any(key string, val any) Field {
-	return Field{
-		Key: key,
-		Val: val,
-	}
-}
-
-func Error(err error) Field {
-	return Field{
-		Key: "error",
-		Val: err,
-	}
-}
-
-func Int64(key string, val int64) Field {
-	return Field{
-		Key: key,
-		Val: val,
-	}
-}
-
-func Int(key string, val int) Field {
-	return Field{
-		Key: key,
-		Val: val,
-	}
-}
-
-func String(key string, val string) Field {
-	return Field{
-		Key: key,
-		Val: val,
-	}
-}
-
-func Int32(key string, val int32) Field {
-	return Field{
-		Key: key,
-		Val: val,
-	}
-}
-
-// ---------- 环境枚举 ----------
-type Env int8
-
-const (
-	EnvUnknown Env = iota
-	EnvDev         // 开发：彩色多行栈，仅控制台
-	EnvTest        // 测试：彩色多行栈到控制台 + JSON 到文件
-	EnvProd        // 生产：全 JSON 单行
-)
+type Field map[string]interface{}

pkg/logger/zapx/zapx.go

@@ -3,13 +3,13 @@ package zapx
 import (
 	"fmt"
 	"github.com/muxi-Infra/muxi-micro/pkg/logger"
+	"github.com/muxi-Infra/muxi-micro/static"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 	"gopkg.in/natefinch/lumberjack.v2"
 	"log"
 	"os"
 	"path/filepath"
-	"strings"
 )
 
 type ZapLogger struct{ l *zap.Logger }
@@ -21,7 +21,7 @@ type ZapCfg struct {
 	options []zap.Option
 }
 
-func NewDefaultZapLogger(logDir string, env logger.Env) logger.Logger {
+func NewDefaultZapLogger(logDir string, env static.Env) logger.Logger {
 	return NewZapLogger(
 		WithDefaultZapCore(
 			WithLogDir(logDir),
@@ -45,23 +45,16 @@ func NewZapLogger(opts ...ZapOption) logger.Logger {
 type CoreOption func(*coreCfg)
 
 type coreCfg struct {
-	env          logger.Env
-	splitByLevel bool
-	logDir       string
+	env    static.Env
+	logDir string
 }
 
-func WithCoreEnv(env logger.Env) CoreOption {
+func WithCoreEnv(env static.Env) CoreOption {
 	return func(cfg *coreCfg) {
 		cfg.env = env
 	}
 }
 
-func WithCoreSplit(splitByLevel bool) CoreOption {
-	return func(cfg *coreCfg) {
-		cfg.splitByLevel = splitByLevel
-	}
-}
-
 func WithLogDir(logDir string) CoreOption {
 	return func(cfg *coreCfg) {
 		cfg.logDir = logDir
@@ -71,16 +64,15 @@ func WithLogDir(logDir string) CoreOption {
 func WithDefaultZapCore(opts ...CoreOption) ZapOption {
 	return func(cfg *ZapCfg) {
 		var corecfg = coreCfg{
-			splitByLevel: false,
-			logDir:       "./logs",
-			env:          logger.EnvProd,
+			logDir: "./logs",
+			env:    static.EnvProd,
 		}
 
 		for _, opt := range opts {
 			opt(&corecfg)
 		}
 		// dev 只需要 stdout，不强制创建 logDir
-		if corecfg.env != logger.EnvDev {
+		if corecfg.env != static.EnvDev {
 			corecfg.logDir = filepath.Clean(corecfg.logDir)
 			if err := os.MkdirAll(corecfg.logDir, 0755); err != nil {
 				log.Panicf("无法创建日志目录: %v", err)
@@ -92,20 +84,20 @@ func WithDefaultZapCore(opts ...CoreOption) ZapOption {
 
 		switch corecfg.env {
 		// ======== DEV：彩色到控制台 ========
-		case logger.EnvDev:
+		case static.EnvDev:
 			cfg.core = zapcore.NewCore(consoleEnc, zapcore.AddSync(os.Stdout), zapcore.DebugLevel)
 			return
 
 		// ======== TEST：控制台彩色 + 文件 JSON ========
-		case logger.EnvTest:
+		case static.EnvTest:
 			consoleCore := zapcore.NewCore(consoleEnc, zapcore.AddSync(os.Stdout), zapcore.DebugLevel)
-			fileCore := buildFileCores(jsonEnc, corecfg.splitByLevel, corecfg.logDir, false) // 仅文件
+			fileCore := buildFileCores(jsonEnc, corecfg.logDir, false) // 仅文件
 			cfg.core = zapcore.NewTee(append([]zapcore.Core{consoleCore}, fileCore...)...)
 			return
 
 		// ======== PROD(默认)：全 JSON 单行 ========
-		case logger.EnvProd:
-			cores := buildFileCores(jsonEnc, corecfg.splitByLevel, corecfg.logDir, true) // stdout+file 共写
+		case static.EnvProd:
+			cores := buildFileCores(jsonEnc, corecfg.logDir, true) // stdout+file 共写
 			cfg.core = zapcore.NewTee(cores...)
 
 		default:
@@ -137,36 +129,17 @@ func WithZapCore(core zapcore.Core) ZapOption {
 }
 
 // 构造文件相关 core；如果 withStdout=true，则 stdout 也走同 encoder（生产）
-func buildFileCores(enc zapcore.Encoder, split bool, dir string, withStdout bool) []zapcore.Core {
+func buildFileCores(enc zapcore.Encoder, dir string, withStdout bool) []zapcore.Core {
 	var cores []zapcore.Core
 	stdout := zapcore.AddSync(os.Stdout)
 
-	if !split {
-		var ws zapcore.WriteSyncer
-		if withStdout {
-			ws = zapcore.NewMultiWriteSyncer(stdout, zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir))))
-		} else {
-			ws = zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir)))
-		}
-		cores = append(cores, zapcore.NewCore(enc, ws, zapcore.DebugLevel))
-		return cores
-	}
-
-	levels := []zapcore.Level{
-		zapcore.DebugLevel, zapcore.InfoLevel, zapcore.WarnLevel,
-		zapcore.ErrorLevel, zapcore.DPanicLevel, zapcore.PanicLevel, zapcore.FatalLevel,
-	}
-	for _, lv := range levels {
-		fileWS := zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/%s.log", dir, strings.ToLower(lv.String()))))
-		var ws zapcore.WriteSyncer
-		if withStdout {
-			ws = zapcore.NewMultiWriteSyncer(stdout, fileWS)
-		} else {
-			ws = fileWS
-		}
-		core := zapcore.NewCore(enc, ws, zap.LevelEnablerFunc(func(l zapcore.Level) bool { return l == lv }))
-		cores = append(cores, core)
+	var ws zapcore.WriteSyncer
+	if withStdout {
+		ws = zapcore.NewMultiWriteSyncer(stdout, zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir))))
+	} else {
+		ws = zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir)))
 	}
+	cores = append(cores, zapcore.NewCore(enc, ws, zapcore.DebugLevel))
 	return cores
 }
 
@@ -220,8 +193,10 @@ func (z *ZapLogger) Sync() error { return z.l.Sync() }
 
 func convert(fields []logger.Field) []zap.Field {
 	var res []zap.Field
-	for _, arg := range fields {
-		res = append(res, zap.Any(arg.Key, arg.Val))
+	for _, f := range fields {
+		for k, v := range f {
+			res = append(res, zap.Any(k, v))
+		}
 	}
 	return res
 }

pkg/logger/zapx/zapx_test.go

@@ -1,19 +1,18 @@
 package zapx
 
 import (
-	"errors"
 	"fmt"
-	"os"
-	"path/filepath"
-	"testing"
-
 	"github.com/muxi-Infra/muxi-micro/pkg/logger"
+	"github.com/muxi-Infra/muxi-micro/static"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
+	"os"
+	"path/filepath"
+	"testing"
 )
 
 func TestNewDefaultZapLogger_AllEnv(t *testing.T) {
-	envs := []logger.Env{logger.EnvDev, logger.EnvTest, logger.EnvProd}
+	envs := []static.Env{static.EnvDev, static.EnvTest, static.EnvProd}
 	for _, env := range envs {
 		t.Run(fmt.Sprintf("%v", env), func(t *testing.T) {
 			l := NewDefaultZapLogger("./logs/test_default", env)
@@ -74,8 +73,7 @@ func TestWithDefaultZapCore_CreatesLogDir(t *testing.T) {
 	_ = os.RemoveAll(dir)
 
 	opt := WithDefaultZapCore(
-		WithCoreEnv(logger.EnvTest),
-		WithCoreSplit(false),
+		WithCoreEnv(static.EnvTest),
 		WithLogDir(dir),
 	)
 	cfg := &ZapCfg{}
@@ -93,7 +91,7 @@ func TestWithDefaultZapCore_IllegalEnv(t *testing.T) {
 		}
 	}()
 
-	opt := WithDefaultZapCore(WithCoreSplit(true), WithLogDir("./logs/illegal"), WithCoreEnv(logger.Env(99)))
+	opt := WithDefaultZapCore(WithLogDir("./logs/illegal"), WithCoreEnv(static.Env(99)))
 	cfg := &ZapCfg{}
 	opt(cfg)
 }
@@ -126,7 +124,7 @@ func TestWithZapOptions_AppendsOptions(t *testing.T) {
 func TestLogDirClean(t *testing.T) {
 	// 测试 logDir clean 是否去除末尾斜杠
 	logDir := "./logs/clean-test////"
-	opt := WithDefaultZapCore(WithCoreSplit(true), WithLogDir(logDir), WithCoreEnv(logger.EnvTest))
+	opt := WithDefaultZapCore(WithLogDir(logDir), WithCoreEnv(static.EnvTest))
 	cfg := &ZapCfg{}
 	opt(cfg)
 
@@ -138,17 +136,20 @@ func TestLogDirClean(t *testing.T) {
 
 func logAll(l logger.Logger) {
 
-	l.With(logger.String("all", "everyLog"))
+	l.With(logger.Field{
+		"string": "string",
+		"int":    1,
+	})
+
 	l.Info("test",
-		logger.Int("1", 1),
-		logger.Int32("1", 1),
-		logger.Int64("1", 1),
-		logger.Any("1", 1),
-		logger.Error(errors.New("1234")),
+		logger.Field{
+			"string": "string",
+			"int":    1,
+		},
 	)
 
-	l.Debug("test", logger.Int("1", 1))
-	l.Warn("test", logger.Int("1", 1))
-	l.Error("test", logger.Int("1", 1))
+	l.Debug("test")
+	l.Warn("test")
+	l.Error("test")
 	l.Sync()
 }

pkg/transport/http/ginx/engine.go

@@ -0,0 +1,80 @@
+package ginx
+
+import (
+	"github.com/gin-contrib/pprof"
+	"github.com/gin-gonic/gin"
+	"github.com/muxi-Infra/muxi-micro/pkg/logger"
+	"github.com/muxi-Infra/muxi-micro/pkg/logger/zapx"
+	"github.com/muxi-Infra/muxi-micro/pkg/transport/http/ginx/middleware/cors"
+	"github.com/muxi-Infra/muxi-micro/pkg/transport/http/ginx/middleware/limiter"
+	"github.com/muxi-Infra/muxi-micro/pkg/transport/http/ginx/middleware/timeout"
+	"github.com/muxi-Infra/muxi-micro/static"
+)
+
+type engineConfig struct {
+	env  static.Env
+	g    *gin.Engine
+	l    logger.Logger
+	name string
+}
+
+type EngineOption func(*engineConfig)
+
+// 设置服务名称
+func WithEnv(env static.Env) EngineOption {
+	return func(cfg *engineConfig) {
+		cfg.env = env
+	}
+}
+
+// 手动控制gin的Engine
+func WithEngine(g *gin.Engine) EngineOption {
+	return func(cfg *engineConfig) {
+		cfg.g = g
+	}
+}
+
+func WithName(name string) EngineOption {
+	return func(cfg *engineConfig) {
+		cfg.name = name
+	}
+}
+func WithLogger(l logger.Logger) EngineOption {
+	return func(cfg *engineConfig) {
+		cfg.l = l
+	}
+}
+
+// 创建默认引擎，附带常用中间件和可选配置
+func NewDefaultEngine(opts ...EngineOption) *gin.Engine {
+	cfg := &engineConfig{
+		env:  static.EnvProd,
+		g:    gin.Default(),
+		name: DefaultName,
+		l:    zapx.NewZapLogger(zapx.WithDefaultZapCore()), //如果不配置logger的话就默认使用zap
+	}
+
+	for _, opt := range opts {
+		opt(cfg)
+	}
+
+	// 非生产环境注册 pprof
+	if cfg.env != static.EnvProd {
+		pprof.Register(cfg.g)
+	}
+
+	cfg.g.Use(
+		GlobalLoggerMiddleware(cfg.l),
+		GlobalNameMiddleware(cfg.name),
+	)
+
+	return cfg.g
+}
+
+func UseDefaultMiddleware(g *gin.Engine) {
+	g.Use(
+		cors.Cors(),
+		limiter.Limiter(),
+		timeout.Timeout(),
+	)
+}

pkg/transport/http/ginx/engine_test.go

@@ -0,0 +1 @@
+package ginx