如何在Golang Zap日志项目的zap.Config中添加zapcore.NewMultiWriteSyncer实现日志轮转

核心思路 #

由于zap.Config默认通过OutputPaths/ErrorOutputPaths指定文件路径，无法直接集成日志轮转，我们需要：

• 保留zap.Config中除输出方式外的所有配置（日志级别、编码器、开发模式等）
• 根据开关决定是否用lumberjack替换默认文件输出，同时保留原配置中的标准输出（stdout/stderr）
• 通过zapcore.NewMultiWriteSyncer组合轮转文件输出与标准输出（如果需要）

具体实现步骤 #

1. 扩展日志配置结构：在原有zap.Config基础上增加轮转开关和lumberjack的配置项
2. 构建自定义WriteSyncer：
   • 启用轮转时，用lumberjack.Logger作为底层写入器，通过zapcore.AddSync转换为WriteSyncer
   • 保留原配置中的stdout/stderr输出，用NewMultiWriteSyncer组合多个输出源
   • 未启用轮转时，使用Zap默认的zap.Open创建标准WriteSyncer
3. 基于核心配置构建Logger：复用zap.Config中的编码器、级别等设置，手动构建Zap Core和Logger

代码示例 #

import (
    "os"

    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "gopkg.in/natefinch/lumberjack.v2"
)

// 扩展的日志配置，包含Zap原生配置和轮转相关设置
type LogConfig struct {
    zap.Config
    EnableRotation bool          `json:"enable_rotation"`
    RotationConfig lumberjack.Logger `json:"rotation_config"`
}

func BuildLogger(cfg LogConfig) (*zap.Logger, error) {
    // 1. 构建编码器（复用Zap配置中的编码设置）
    encoder, err := cfg.EncoderConfig.Build(cfg.Encoding)
    if err != nil {
        return nil, err
    }

    // 2. 构建输出WriteSyncer
    outputSyncer, err := buildWriteSyncer(cfg.OutputPaths, cfg.EnableRotation, &cfg.RotationConfig)
    if err != nil {
        return nil, err
    }

    // 3. 构建错误输出WriteSyncer（可单独配置轮转，这里复用输出配置）
    errorSyncer, err := buildWriteSyncer(cfg.ErrorOutputPaths, cfg.EnableRotation, &cfg.RotationConfig)
    if err != nil {
        return nil, err
    }

    // 4. 构建Zap Core
    core := zapcore.NewCore(
        encoder,
        zapcore.NewMultiWriteSyncer(outputSyncer, errorSyncer), // 合并输出和错误输出
        cfg.Level,
    )

    // 5. 应用Zap配置中的其他选项
    logger := zap.New(core)
    if cfg.Development {
        logger = logger.WithOptions(zap.Development())
    }
    if len(cfg.InitialFields) > 0 {
        logger = logger.With(zap.Fields(cfg.InitialFields))
    }
    if !cfg.DisableCaller {
        logger = logger.WithOptions(zap.AddCaller())
    }
    if !cfg.DisableStacktrace {
        logger = logger.WithOptions(zap.AddStacktrace(cfg.Level))
    }

    return logger, nil
}

// 构建WriteSyncer的辅助函数
func buildWriteSyncer(paths []string, enableRotation bool, rotCfg *lumberjack.Logger) (zapcore.WriteSyncer, error) {
    var syncers []zapcore.WriteSyncer

    if enableRotation {
        // 添加轮转文件输出
        syncers = append(syncers, zapcore.AddSync(rotCfg))
    }

    // 处理原配置中的标准输出/错误输出
    for _, path := range paths {
        switch path {
        case "stdout":
            syncers = append(syncers, zapcore.Lock(os.Stdout))
        case "stderr":
            syncers = append(syncers, zapcore.Lock(os.Stderr))
        default:
            if !enableRotation {
                // 未启用轮转时，打开指定文件
                s, err := zap.Open(path)
                if err != nil {
                    return nil, err
                }
                syncers = append(syncers, s)
            }
            // 启用轮转时忽略原文件路径，用lumberjack配置的路径
        }
    }

    return zapcore.NewMultiWriteSyncer(syncers...), nil
}

关键说明 #

• 轮转配置：RotationConfig包含lumberjack的所有参数（如MaxSize单文件最大大小、MaxBackups保留备份数、MaxAge保留天数、Compress是否压缩备份等）
• 输出组合：如果原OutputPaths包含stdout，启用轮转后会同时输出到轮转文件和标准输出，保留原有配置行为
• 配置兼容：所有Zap原生配置项（如Level、EncoderConfig、Development）都被完整保留，仅替换输出方式

内容的提问来源于stack exchange，提问作者moluzhui