Files
workspace/code/allapp/allapp-go/logx/option.go
T
2026-01-13 22:18:01 +08:00

116 lines
2.4 KiB
Go

package logx
import (
"os"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
type Option interface {
apply(cfg *config)
}
type ExtraKey string
type option func(cfg *config)
func (fn option) apply(cfg *config) {
fn(cfg)
}
type CoreConfig struct {
Enc zapcore.Encoder
Ws zapcore.WriteSyncer
Lvl zapcore.LevelEnabler
}
type config struct {
extraKeys []ExtraKey
coreConfigs []CoreConfig
zapOpts []zap.Option
extraKeyAsStr bool
}
// defaultCoreConfig default zapcore config: json encoder, atomic level, stdout write syncer
func defaultCoreConfig() *CoreConfig {
// default log encoder
enc := zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
// default log level
lvl := zap.NewAtomicLevelAt(zap.InfoLevel)
// default write syncer stdout
ws := zapcore.AddSync(os.Stdout)
return &CoreConfig{
Enc: enc,
Ws: ws,
Lvl: lvl,
}
}
// defaultConfig default config
func defaultConfig() *config {
return &config{
coreConfigs: []CoreConfig{*defaultCoreConfig()},
zapOpts: []zap.Option{},
extraKeyAsStr: false,
}
}
// WithCoreEnc zapcore encoder
func WithCoreEnc(enc zapcore.Encoder) Option {
return option(func(cfg *config) {
cfg.coreConfigs[0].Enc = enc
})
}
// WithCoreWs zapcore write syncer
func WithCoreWs(ws zapcore.WriteSyncer) Option {
return option(func(cfg *config) {
cfg.coreConfigs[0].Ws = ws
})
}
// WithCoreLevel zapcore log level
func WithCoreLevel(lvl zap.AtomicLevel) Option {
return option(func(cfg *config) {
cfg.coreConfigs[0].Lvl = lvl
})
}
// WithCores zapcore
func WithCores(coreConfigs ...CoreConfig) Option {
return option(func(cfg *config) {
cfg.coreConfigs = coreConfigs
})
}
// WithZapOptions add origin zap option
func WithZapOptions(opts ...zap.Option) Option {
return option(func(cfg *config) {
cfg.zapOpts = append(cfg.zapOpts, opts...)
})
}
// WithExtraKeys allow you log extra values from context
func WithExtraKeys(keys []ExtraKey) Option {
return option(func(cfg *config) {
for _, k := range keys {
if !InArray(k, cfg.extraKeys) {
cfg.extraKeys = append(cfg.extraKeys, k)
}
}
})
}
// WithExtraKeyAsStr convert extraKey to a string type when retrieving value from context
// Not recommended for use, only for compatibility with certain situations
//
// For more information, refer to the documentation at
// `https://pkg.go.dev/context#WithValue`
func WithExtraKeyAsStr() Option {
return option(func(cfg *config) {
cfg.extraKeyAsStr = true
})
}