|
| 1 | +package zapx |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "github.com/muxi-Infra/muxi-micro/pkg/logger" |
| 6 | + "go.uber.org/zap" |
| 7 | + "go.uber.org/zap/zapcore" |
| 8 | + "gopkg.in/natefinch/lumberjack.v2" |
| 9 | + "log" |
| 10 | + "os" |
| 11 | + "strings" |
| 12 | +) |
| 13 | + |
| 14 | +type ZapLogger struct{ l *zap.Logger } |
| 15 | + |
| 16 | +type ZapOption func(*ZapCfg) |
| 17 | + |
| 18 | +type ZapCfg struct { |
| 19 | + core zapcore.Core |
| 20 | + options []zap.Option |
| 21 | +} |
| 22 | + |
| 23 | +func NewDefaultZapLogger(env logger.Env, splitByLevel bool, logDir string) logger.Logger { |
| 24 | + return NewZapLogger( |
| 25 | + WithDefaultZapCore(env, splitByLevel, logDir), |
| 26 | + WithDefaultZapOptions(), |
| 27 | + ) |
| 28 | +} |
| 29 | + |
| 30 | +func NewZapLogger(opts ...ZapOption) logger.Logger { |
| 31 | + cfg := &ZapCfg{} |
| 32 | + for _, opt := range opts { |
| 33 | + opt(cfg) |
| 34 | + } |
| 35 | + if cfg.core == nil { |
| 36 | + log.Panic("缺少 zap-core 核心配置") |
| 37 | + } |
| 38 | + return &ZapLogger{l: zap.New(cfg.core, cfg.options...)} |
| 39 | +} |
| 40 | + |
| 41 | +func WithDefaultZapCore(env logger.Env, splitByLevel bool, logDir string) ZapOption { |
| 42 | + return func(cfg *ZapCfg) { |
| 43 | + // dev 只需要 stdout，不强制创建 logDir |
| 44 | + if env != logger.EnvDev { |
| 45 | + if err := os.MkdirAll(logDir, 0755); err != nil { |
| 46 | + log.Panicf("无法创建日志目录: %v", err) |
| 47 | + } |
| 48 | + } |
| 49 | + |
| 50 | + jsonEnc := zapcore.NewJSONEncoder(prodEncoderConfig()) |
| 51 | + consoleEnc := zapcore.NewConsoleEncoder(devEncoderConfig()) |
| 52 | + |
| 53 | + switch env { |
| 54 | + // ======== DEV：彩色到控制台 ======== |
| 55 | + case logger.EnvDev: |
| 56 | + cfg.core = zapcore.NewCore(consoleEnc, zapcore.AddSync(os.Stdout), zapcore.DebugLevel) |
| 57 | + return |
| 58 | + |
| 59 | + // ======== TEST：控制台彩色 + 文件 JSON ======== |
| 60 | + case logger.EnvTest: |
| 61 | + consoleCore := zapcore.NewCore(consoleEnc, zapcore.AddSync(os.Stdout), zapcore.DebugLevel) |
| 62 | + fileCore := buildFileCores(jsonEnc, splitByLevel, logDir, false) // 仅文件 |
| 63 | + cfg.core = zapcore.NewTee(append([]zapcore.Core{consoleCore}, fileCore...)...) |
| 64 | + return |
| 65 | + |
| 66 | + // ======== PROD(默认)：全 JSON 单行 ======== |
| 67 | + case logger.EnvProd: |
| 68 | + cores := buildFileCores(jsonEnc, splitByLevel, logDir, true) // stdout+file 共写 |
| 69 | + cfg.core = zapcore.NewTee(cores...) |
| 70 | + |
| 71 | + default: |
| 72 | + log.Panic("非法的环境") |
| 73 | + return |
| 74 | + } |
| 75 | + } |
| 76 | +} |
| 77 | + |
| 78 | +// 允许替换 Option |
| 79 | +func WithZapOptions(opts ...zap.Option) ZapOption { |
| 80 | + return func(cfg *ZapCfg) { cfg.options = opts } |
| 81 | +} |
| 82 | + |
| 83 | +// 默认 Option |
| 84 | +func WithDefaultZapOptions() ZapOption { |
| 85 | + return func(cfg *ZapCfg) { |
| 86 | + cfg.options = []zap.Option{ |
| 87 | + zap.AddCaller(), |
| 88 | + zap.AddStacktrace(zapcore.WarnLevel), |
| 89 | + zap.AddCallerSkip(1), |
| 90 | + } |
| 91 | + } |
| 92 | +} |
| 93 | + |
| 94 | +// 允许自定义 core |
| 95 | +func WithZapCore(core zapcore.Core) ZapOption { |
| 96 | + return func(cfg *ZapCfg) { cfg.core = core } |
| 97 | +} |
| 98 | + |
| 99 | +// 构造文件相关 core；如果 withStdout=true，则 stdout 也走同 encoder（生产） |
| 100 | +func buildFileCores(enc zapcore.Encoder, split bool, dir string, withStdout bool) []zapcore.Core { |
| 101 | + var cores []zapcore.Core |
| 102 | + stdout := zapcore.AddSync(os.Stdout) |
| 103 | + |
| 104 | + if !split { |
| 105 | + var ws zapcore.WriteSyncer |
| 106 | + if withStdout { |
| 107 | + ws = zapcore.NewMultiWriteSyncer(stdout, zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir)))) |
| 108 | + } else { |
| 109 | + ws = zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/app.log", dir))) |
| 110 | + } |
| 111 | + cores = append(cores, zapcore.NewCore(enc, ws, zapcore.DebugLevel)) |
| 112 | + return cores |
| 113 | + } |
| 114 | + |
| 115 | + levels := []zapcore.Level{ |
| 116 | + zapcore.DebugLevel, zapcore.InfoLevel, zapcore.WarnLevel, |
| 117 | + zapcore.ErrorLevel, zapcore.DPanicLevel, zapcore.PanicLevel, zapcore.FatalLevel, |
| 118 | + } |
| 119 | + for _, lv := range levels { |
| 120 | + fileWS := zapcore.AddSync(newRotateLogger(fmt.Sprintf("%s/%s.log", dir, strings.ToLower(lv.String())))) |
| 121 | + var ws zapcore.WriteSyncer |
| 122 | + if withStdout { |
| 123 | + ws = zapcore.NewMultiWriteSyncer(stdout, fileWS) |
| 124 | + } else { |
| 125 | + ws = fileWS |
| 126 | + } |
| 127 | + core := zapcore.NewCore(enc, ws, zap.LevelEnablerFunc(func(l zapcore.Level) bool { return l == lv })) |
| 128 | + cores = append(cores, core) |
| 129 | + } |
| 130 | + return cores |
| 131 | +} |
| 132 | + |
| 133 | +// 生产 JSON encoder |
| 134 | +func prodEncoderConfig() zapcore.EncoderConfig { |
| 135 | + return zapcore.EncoderConfig{ |
| 136 | + TimeKey: "@timestamp", |
| 137 | + LevelKey: "level", |
| 138 | + MessageKey: "msg", |
| 139 | + CallerKey: "caller", |
| 140 | + StacktraceKey: "stacktrace", |
| 141 | + EncodeLevel: zapcore.CapitalLevelEncoder, |
| 142 | + EncodeTime: zapcore.ISO8601TimeEncoder, |
| 143 | + EncodeCaller: zapcore.ShortCallerEncoder, |
| 144 | + } |
| 145 | +} |
| 146 | + |
| 147 | +// 开发 / 测试 彩色 console encoder |
| 148 | +func devEncoderConfig() zapcore.EncoderConfig { |
| 149 | + c := prodEncoderConfig() |
| 150 | + c.EncodeLevel = zapcore.CapitalColorLevelEncoder |
| 151 | + return c |
| 152 | +} |
| 153 | + |
| 154 | +// 滚动文件 |
| 155 | +func newRotateLogger(filename string) *lumberjack.Logger { |
| 156 | + return &lumberjack.Logger{ |
| 157 | + Filename: filename, |
| 158 | + MaxSize: 20, |
| 159 | + MaxBackups: 5, |
| 160 | + MaxAge: 30, |
| 161 | + Compress: true, |
| 162 | + } |
| 163 | +} |
| 164 | + |
| 165 | +func (z *ZapLogger) Info(msg string, fields ...logger.Field) { z.l.Info(msg, convert(fields)...) } |
| 166 | + |
| 167 | +func (z *ZapLogger) Error(msg string, fields ...logger.Field) { z.l.Error(msg, convert(fields)...) } |
| 168 | + |
| 169 | +func (z *ZapLogger) Debug(msg string, fields ...logger.Field) { z.l.Debug(msg, convert(fields)...) } |
| 170 | + |
| 171 | +func (z *ZapLogger) Warn(msg string, fields ...logger.Field) { z.l.Warn(msg, convert(fields)...) } |
| 172 | + |
| 173 | +func (z *ZapLogger) Fatal(msg string, fields ...logger.Field) { z.l.Fatal(msg, convert(fields)...) } |
| 174 | + |
| 175 | +func (z *ZapLogger) With(fields ...logger.Field) logger.Logger { |
| 176 | + return &ZapLogger{l: z.l.With(convert(fields)...)} |
| 177 | +} |
| 178 | + |
| 179 | +func (z *ZapLogger) Sync() error { return z.l.Sync() } |
| 180 | + |
| 181 | +func convert(fields []logger.Field) []zap.Field { |
| 182 | + var res []zap.Field |
| 183 | + for _, f := range fields { |
| 184 | + if ff, ok := f.(zap.Field); ok { |
| 185 | + res = append(res, ff) |
| 186 | + } |
| 187 | + } |
| 188 | + return res |
| 189 | +} |
0 commit comments