golang zap的使用

栏目: IT技术 · 发布时间: 4年前

内容简介：下载安装这些步骤就不在赘述，讲zap的用法之前，我们先来看一下zap的配置，下面是我常用的配置从上面的例子中我们分几步来看当然本文没有介绍zap的其他基本用法，只是讲解了本人经常用到的方法，其他方法如果有时间，我也会一一列出。谢谢大家观看，比心~~

简介：

日志是我们开发程序必不可少的一部分，go官方的提供的日志包默认功能很简洁，但是满足不了生产环境的全部需求（例如：更精细的日志级别、日志文件分割，以及日志分发等）。虽然 Go 是新兴语言，但是go的生态圈还是很活跃的，目前比较流行的第三方开源log包有seelog，zap，logrus，还有beego中的日志框架部分。今天我们就着重讲一下uber的zap包，本文中难免会有错误的地方，如有请联系本人，本人会及时更正。

zap 是uber开源的Go高性能日志库

Lumberjack 用于将日志写入滚动文件。zap 不支持文件归档，如果要支持文件按大小或者时间归档，需要使用lumberjack，lumberjack也是zap官方推荐的。

怎么使用

下载安装这些步骤就不在赘述，讲zap的用法之前，我们先来看一下zap的配置，下面是我常用的配置

zap.Config{
        Level:             zap.NewAtomicLevelAt(zap.DebugLevel),
        Development:       false,
        DisableCaller:     false,
        DisableStacktrace: false,
        Sampling:          nil,
        Encoding:          "json",
        EncoderConfig: zapcore.EncoderConfig{
            MessageKey:     "msg",
            LevelKey:       "level",
            TimeKey:        "time",
            NameKey:        "logger",
            CallerKey:      "file",
            StacktraceKey:  "stacktrace",
            LineEnding:     zapcore.DefaultLineEnding,
            EncodeLevel:    zapcore.LowercaseLevelEncoder,
            EncodeTime:     zapcore.ISO8601TimeEncoder,
            EncodeDuration: zapcore.SecondsDurationEncoder,
            EncodeCaller:   zapcore.ShortCallerEncoder,
            EncodeName:     zapcore.FullNameEncoder,
        },
        OutputPaths:      []string{"/tmp/zap.log"},
        ErrorOutputPaths: []string{"/tmp/zap.log"},
        InitialFields: map[string]interface{}{
            "app": "test",
        },
    }

    lumberjack.Logger{
            Filename:   logPath, // 日志文件路径
            MaxSize:    128,     // 每个日志文件保存的大小 单位:M
            MaxAge:     7,       // 文件最多保存多少天
            MaxBackups: 30,      // 日志文件最多保存多少个备份
            Compress:   false,   // 是否压缩
        }

zap配置说明

Level ：日志级别,只不过它需要的类型是 AtomicLevel 。所以需要使用 zap.NewAtomicLevelAt 。

func NewAtomicLevelAt(l zapcore.Level) AtomicLevel {
    a := NewAtomicLevel()
    a.SetLevel(l)
    return a
}

DebugLevel Level = iota - 1
// InfoLevel 默认级别
InfoLevel
// WarnLevel
WarnLevel
// 项目运行中，错误的日志
ErrorLevel
// 记录一条消息后，如果是开发环境，则调用panic
DPanicLevel
// 记录一条消息后，则调用panic
PanicLevel
// 记录一条消息后调用 os.Exit(1).
FatalLevel

Development ：是否是开发环境。如果是开发模式，对 DPanicLevel 进行堆栈跟踪

DisableCaller ：不显示调用函数的文件名称和行号。默认情况下，所有日志都显示。

DisableStacktrace ：是否禁用堆栈跟踪捕获。默认对Warn级别以上和生产error级别以上的进行堆栈跟踪。

Sampling ：抽样策略。设置为nil禁用采样。（我自己没用过，有需求的朋友可以研究下）

Encoding ：编码方式，支持 json , console , 也支持自定义（需要通过 RegisterEncoder 注册）

EncoderConfig ：生成格式的一些配置，后面详细介绍

OutputPaths ：是url或文件路径列表，用于写入日志输出。

ErrorOutputPaths ：内部日志程序错误路径列表。默认为标准错误。

InitialFields ：加入一些初始的字段数据，比如项目名

EncoderConfig配置说明:

MessageKey：输入信息的key名  
LevelKey：输出日志级别的key名  
TimeKey：输出时间的key名  
NameKey CallerKey StacktraceKey跟以上类似，看名字就知道  
LineEnding：每行的分隔符。基本zapcore.DefaultLineEnding 即"\\n"  
EncodeLevel：基本zapcore.LowercaseLevelEncoder。将日志级别字符串转化为小写  
EncodeTime：输出的时间格式  
EncodeDuration：一般zapcore.SecondsDurationEncoder,执行消耗的时间转化成浮点型的秒  
EncodeCaller：一般zapcore.ShortCallerEncoder，以包/文件:行号 格式化调用堆栈  
EncodeName：可选值。

真实例子

需求：希望日志文件按照一定的大小分隔，备份，并且希望，在开发的时候，日志可以在文件和控制台上都有输出，只需要通过配置就能控制

package logger

import (
    " xxx/config"
    "os"

    "github.com/natefinch/lumberjack"
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
)

var ZapLogger *zap.Logger

func InitLogger() {
    // 此处的配置是从我的项目配置文件读取的，读者可以根据自己的情况来设置
    logPath := config.Cfg.Section("app").Key("logPath").String()
    name := config.Cfg.Section("app").Key("name").String()
    debug, err := config.Cfg.Section("app").Key("debug").Bool()
    if err != nil {
        debug = false
    }
    hook := lumberjack.Logger{
        Filename:   logPath, // 日志文件路径
        MaxSize:    128,     // 每个日志文件保存的大小 单位:M
        MaxAge:     7,       // 文件最多保存多少天
        MaxBackups: 30,      // 日志文件最多保存多少个备份
        Compress:   false,   // 是否压缩
    }
    encoderConfig := zapcore.EncoderConfig{
        MessageKey:     "msg",
        LevelKey:       "level",
        TimeKey:        "time",
        NameKey:        "logger",
        CallerKey:      "file",
        StacktraceKey:  "stacktrace",
        LineEnding:     zapcore.DefaultLineEnding,
        EncodeLevel:    zapcore.LowercaseLevelEncoder,
        EncodeTime:     zapcore.ISO8601TimeEncoder,
        EncodeDuration: zapcore.SecondsDurationEncoder,
        EncodeCaller:   zapcore.ShortCallerEncoder, // 短路径编码器
        EncodeName:     zapcore.FullNameEncoder,
    }
    // 设置日志级别
    atomicLevel := zap.NewAtomicLevel()
    atomicLevel.SetLevel(zap.DebugLevel)
    var writes = []zapcore.WriteSyncer{zapcore.AddSync(&hook)}
    // 如果是开发环境，同时在控制台上也输出
    if debug {
        writes = append(writes, zapcore.AddSync(os.Stdout))
    }
    core := zapcore.NewCore(
        zapcore.NewJSONEncoder(encoderConfig),
        zapcore.NewMultiWriteSyncer(writes...),
        atomicLevel,
    )

    // 开启开发模式，堆栈跟踪
    caller := zap.AddCaller()
    // 开启文件及行号
    development := zap.Development()

    // 设置初始化字段
    field := zap.Fields(zap.String("appName", name))

    // 构造日志
    ZapLogger = zap.New(core, caller, development, field)
    ZapLogger.Info("log 初始化成功")
}

从上面的例子中我们分几步来看