日志不使用全局变量控制，调整日志相关代码

reggiepy · reggiepy · commit cb3c0d6bf492 · 2024-08-15T10:55:53.000+08:00
diff --git a/boot/boot.go b/boot/boot.go
@@ -16,7 +16,7 @@ func Boot() {
 	}
 	go func() {
 		if err := server.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
-			zap.L().Info(fmt.Sprintf("start http server error: %v\n", err))
+			global.LbLogger.Info(fmt.Sprintf("start http server error: %v\n", err))
 		}
 	}()
 	logo(addr)
diff --git a/boot/log.go b/boot/log.go
@@ -5,20 +5,22 @@ import (
 	"fmt"
 	"github.com/reggiepy/LogBeetle/global"
 	"github.com/reggiepy/LogBeetle/goutils/logUtils"
+	"go.uber.org/zap"
 	"os"
 )
 
-func Log() {
-	logConfig := &logUtils.Config{}
+func Log() *zap.Logger {
+	logConfig := logUtils.NewDefaultConfig()
 	jsonBytes, _ := json.Marshal(global.LbConfig.LogConfig)
 	err := json.Unmarshal(jsonBytes, logConfig)
 	if err != nil {
-		fmt.Println(err.Error())
+		fmt.Printf("Error marshalling log config: %v\n", err)
 		os.Exit(1)
 	}
-	err = logUtils.InitLogger(*logConfig)
+	logger, err := logConfig.NewLogger()
 	if err != nil {
-		fmt.Println(err.Error())
+		fmt.Printf("Error creating logger: %v\n", err)
 		os.Exit(1)
 	}
+	return logger
 }
diff --git a/cmd/LogBeetle/sub/config.go b/cmd/LogBeetle/sub/config.go
@@ -16,16 +16,13 @@ import (
 
 func init() {
 	rootCmd.AddCommand(configCmd)
+
+	// show config
 	configCmd.AddCommand(configShowCmd)
 	configShowCmd.Flags().Var(configFormat, "format", "humanReadable | simple")
-	configCmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return []string{"json", "simple"}, cobra.ShellCompDirectiveNoFileComp
-	}
 
+	// generate config
 	configCmd.AddCommand(configGenerateCmd)
-	configCmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return []string{"json", "simple"}, cobra.ShellCompDirectiveNoFileComp
-	}
 }
 
 var configCmd = &cobra.Command{
@@ -40,6 +37,9 @@ var configCmd = &cobra.Command{
 var configShowCmd = &cobra.Command{
 	Use:   "show",
 	Short: "show config",
+	ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return []string{"json", "simple"}, cobra.ShellCompDirectiveNoFileComp
+	},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		global.LbViper = boot.Viper()
 		data, err := jsonUtils.AnyToJson(global.LbConfig, configFormat.String())
diff --git a/cmd/LogBeetle/sub/root.go b/cmd/LogBeetle/sub/root.go
@@ -5,7 +5,8 @@ import (
 	"fmt"
 	"github.com/reggiepy/LogBeetle/boot"
 	"github.com/reggiepy/LogBeetle/global"
-	"go.uber.org/zap"
+	"github.com/reggiepy/LogBeetle/goutils/enumUtils"
+	"github.com/reggiepy/LogBeetle/version"
 	"os"
 	"os/signal"
 	"sync"
@@ -21,7 +22,7 @@ import (
 
 var (
 	showVersion  bool
-	configFormat = NewEnum([]string{"humanReadable", "simple"}, "humanReadable")
+	configFormat = enumUtils.NewEnum([]string{"humanReadable", "simple"}, "humanReadable")
 )
 
 func init() {
@@ -45,18 +46,22 @@ func init() {
 }
 
 var rootCmd = cobra.Command{
-	Use:     "LogBeetle",
-	Short:   "LogBeetle help",
-	Long:    `LogBeetle help`,
-	Version: "",
+	Use:   "LogBeetle",
+	Short: "LogBeetle help",
+	Long:  `LogBeetle help`,
 	Args: func(cmd *cobra.Command, args []string) error {
 		return nil
 	},
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if showVersion {
+			fmt.Println(version.Full())
+			return nil
+		}
 		global.LbViper = boot.Viper()
-		boot.Log()
+		global.LbLogger = boot.Log()
 		boot.Boot()
 		StartServer()
+		return nil
 	},
 }
 
@@ -119,7 +124,7 @@ func StartServer() {
 				} else {
 					consumerManager.Add(c)
 					fmt.Printf("consumer %s added\n", "test")
-					zap.L().Info(fmt.Sprintf("consumer %s added\n", "test"))
+					global.LbLogger.Info(fmt.Sprintf("consumer %s added\n", "test"))
 				}
 
 				// 添加其他消费者
diff --git a/global/global.go b/global/global.go
@@ -3,9 +3,11 @@ package global
 import (
 	"github.com/reggiepy/LogBeetle/config"
 	"github.com/spf13/viper"
+	"go.uber.org/zap"
 )
 
 var (
 	LbConfig config.Config
 	LbViper  *viper.Viper
+	LbLogger *zap.Logger
 )
diff --git a/goutils/arrayUtils/set.go b/goutils/arrayUtils/set.go
@@ -0,0 +1,24 @@
+package arrayUtils
+
+type Set map[string]struct{}
+
+func NewSet(item ...string) Set {
+	s := make(Set, len(item))
+	for _, v := range item {
+		s.Add(v)
+	}
+	return s
+}
+
+func (s Set) Has(key string) bool {
+	_, ok := s[key]
+	return ok
+}
+
+func (s Set) Add(key string) {
+	s[key] = struct{}{}
+}
+
+func (s Set) Delete(key string) {
+	delete(s, key)
+}
diff --git a/goutils/enumUtils/enumUtils.go b/goutils/enumUtils/enumUtils.go
@@ -1,4 +1,4 @@
-package sub
+package enumUtils
 
 import (
 	"fmt"
diff --git a/goutils/logUtils/logUtils.go b/goutils/logUtils/logUtils.go
@@ -1,15 +1,12 @@
 package logUtils
 
 import (
-	"reflect"
-
 	"github.com/natefinch/lumberjack"
+	"github.com/reggiepy/LogBeetle/goutils/arrayUtils"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
 
-var Logger *zap.Logger
-
 type Config struct {
 	LogFile    string `json:"LogFile" yaml:"LogFile"`       // 日志文件名
 	MaxSize    int    `json:"MaxSize" yaml:"MaxSize"`       // 日志文件大小限制，单位为 MB
@@ -20,64 +17,6 @@ type Config struct {
 	LogFormat  string `json:"LogFormat" yaml:"LogFormat"`   // 日志等级
 }
 
-type ConfigOption func(loggerConfig *Config) error
-
-// WithLogFile 设置日志文件名
-func WithLogFile(logFile string) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.LogFile = logFile
-		return nil
-	}
-}
-
-// WithMaxSize 设置日志文件大小限制，单位为 MB
-func WithMaxSize(maxSize int) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.MaxSize = maxSize
-		return nil
-	}
-}
-
-// WithMaxBackups 设置最大保留的旧日志文件数量
-func WithMaxBackups(maxBackups int) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.MaxBackups = maxBackups
-		return nil
-	}
-}
-
-// WithMaxAge 设置旧日志文件保留天数
-func WithMaxAge(maxAge int) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.MaxAge = maxAge
-		return nil
-	}
-}
-
-// WithCompress 设置是否压缩旧日志文件
-func WithCompress(compress bool) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.Compress = compress
-		return nil
-	}
-}
-
-// WithLogLevel 设置日志等级
-func WithLogLevel(logLevel string) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.LogLevel = logLevel
-		return nil
-	}
-}
-
-// WithLogFormat 设置日志格式
-func WithLogFormat(logFormat string) ConfigOption {
-	return func(loggerConfig *Config) error {
-		loggerConfig.LogFormat = logFormat
-		return nil
-	}
-}
-
 // NewDefaultConfig 创建默认配置
 func NewDefaultConfig() *Config {
 	return &Config{
@@ -91,62 +30,49 @@ func NewDefaultConfig() *Config {
 	}
 }
 
-// InitLogger 初始化Logger
-func InitLogger(logConfig Config, options ...ConfigOption) error {
-	if reflect.DeepEqual(logConfig, Config{}) {
-		logConfig = *NewDefaultConfig()
-	}
-	for _, option := range options {
-		err := option(&logConfig)
-		if err != nil {
-			return err
-		}
-	}
-	logLevel := map[string]zapcore.Level{
-		"debug": zapcore.DebugLevel,
-		"info":  zapcore.InfoLevel,
-		"warn":  zapcore.WarnLevel,
-		"error": zapcore.ErrorLevel,
+// NewLogger 初始化Logger
+func (c *Config) NewLogger(opts ...Option) (*zap.Logger, error) {
+	var (
+		logger     *zap.Logger
+		logFormats = arrayUtils.NewSet("json", "logfmt")
+	)
+	for _, opt := range opts {
+		opt.apply(c)
 	}
 
 	lumberJackLogger := &lumberjack.Logger{
-		Filename:   logConfig.LogFile,
-		MaxSize:    logConfig.MaxSize,
-		MaxBackups: logConfig.MaxBackups,
-		MaxAge:     logConfig.MaxAge,
-		Compress:   logConfig.Compress,
+		Filename:   c.LogFile,
+		MaxSize:    c.MaxSize,
+		MaxBackups: c.MaxBackups,
+		MaxAge:     c.MaxAge,
+		Compress:   c.Compress,
 	}
 	writeSyncer := zapcore.AddSync(lumberJackLogger)
 
-	logFormats := []string{"json", "logfmt"}
 	logFormat := "json"
-	for _, format := range logFormats {
-		if format == logConfig.LogFormat {
-			logFormat = format
-		}
+	for logFormats.Has(c.LogFormat) {
+		logFormat = c.LogFormat
 	}
-	encoder := getEncoder(logFormat)
-	l, ok := logLevel[logConfig.LogLevel] // 日志打印级别
-	if !ok {
-		l = logLevel["info"]
+	encoder := NewEncoder(logFormat)
+
+	// 日志打印级别
+	l, err := zapcore.ParseLevel(c.LogLevel)
+	if err != nil {
+		l = zapcore.InfoLevel
 	}
-	//l, err := zapcore.ParseLevel(logConfig.LogLevel)
-	//if err != nil {
-	//	l = zapcore.InfoLevel
-	//}
 	core := zapcore.NewCore(encoder, writeSyncer, l)
 
-	Logger = zap.New(core, zap.AddCaller()) // zap.Addcaller() 输出日志打印文件和行数如： logger/logger_test.go:33
+	logger = zap.New(core, zap.AddCaller()) // zap.Addcaller() 输出日志打印文件和行数如： logger/logger_test.go:33
 	// 1. zap.ReplaceGlobals 函数将当前初始化的 logger 替换到全局的 logger,
 	// 2. 使用 logger 的时候 直接通过 zap.S().Debugf("xxx") or zap.L().Debug("xxx")
 	// 3. 使用 zap.S() 和 zap.L() 提供全局锁，保证一个全局的安全访问logger的方式
-	zap.ReplaceGlobals(Logger) // 替换zap包中全局的logger实例，后续在其他包中只需使用zap.L()调用即可
+	//zap.ReplaceGlobals(logger) // 替换zap包中全局的logger实例，后续在其他包中只需使用zap.L()调用即可
 	// zap.L().Debug("")
 	// zap.S().Debugf("")
-	return nil
+	return logger, nil
 }
 
-func getEncoder(logFormat string) zapcore.Encoder {
+func NewEncoder(logFormat string) zapcore.Encoder {
 	encoderConfig := zap.NewProductionEncoderConfig()
 	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
 	encoderConfig.TimeKey = "time"
diff --git a/goutils/logUtils/options.go b/goutils/logUtils/options.go
@@ -0,0 +1,61 @@
+package logUtils
+
+type Option interface {
+	apply(config *Config)
+}
+
+type optionFunc func(config *Config)
+
+func (o optionFunc) apply(config *Config) {
+	o(config)
+}
+
+// WithLogFile 设置日志文件名
+func WithLogFile(logFile string) Option {
+	return optionFunc(func(config *Config) {
+		config.LogFile = logFile
+		return
+	})
+}
+
+// WithMaxSize 设置日志文件大小限制，单位为 MB
+func WithMaxSize(maxSize int) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.MaxSize = maxSize
+	})
+}
+
+// WithMaxBackups 设置最大保留的旧日志文件数量
+func WithMaxBackups(maxBackups int) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.MaxBackups = maxBackups
+	})
+}
+
+// WithMaxAge 设置旧日志文件保留天数
+func WithMaxAge(maxAge int) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.MaxAge = maxAge
+	})
+}
+
+// WithCompress 设置是否压缩旧日志文件
+func WithCompress(compress bool) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.Compress = compress
+	})
+}
+
+// WithLogLevel 设置日志等级
+func WithLogLevel(logLevel string) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.LogLevel = logLevel
+	})
+}
+
+// WithLogFormat 设置日志格式
+func WithLogFormat(logFormat string) Option {
+	return optionFunc(func(loggerConfig *Config) {
+		loggerConfig.LogFormat = logFormat
+	})
+}
diff --git a/goutils/versionUtils/versionUtils.go b/goutils/versionUtils/versionUtils.go
diff --git a/goutils/versionUtils/versionUtils_test.go b/goutils/versionUtils/versionUtils_test.go
diff --git a/service/public/message.go b/service/public/message.go
diff --git a/version/version.go b/version/version.go

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ func Boot() {`
`16`	`16`	`}`
`17`	`17`	`go func() {`
`18`	`18`	`if err := server.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {`
`19`		`- zap.L().Info(fmt.Sprintf("start http server error: %v\n", err))`
	`19`	`+ global.LbLogger.Info(fmt.Sprintf("start http server error: %v\n", err))`
`20`	`20`	`}`
`21`	`21`	`}()`
`22`	`22`	`logo(addr)`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,11 @@ package global`
`3`	`3`	`import (`
`4`	`4`	`"github.com/reggiepy/LogBeetle/config"`
`5`	`5`	`"github.com/spf13/viper"`
	`6`	`+ "go.uber.org/zap"`
`6`	`7`	`)`
`7`	`8`
`8`	`9`	`var (`
`9`	`10`	`LbConfig config.Config`
`10`	`11`	`LbViper *viper.Viper`
	`12`	`+ LbLogger *zap.Logger`
`11`	`13`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package sub`
	`1`	`+package enumUtils`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`