Go学习笔记-Zap日志

Log包

Go语言提供的默认日志包：https://golang.org/pkg/log/

基本用法

log包定义了Logger类型，该类型提供了一些格式化输出的方法。

type Logger struct {
    mu     sync.Mutex // ensures atomic writes; protects the following fields
    prefix string     // prefix on each line to identify the logger (but see                            Lmsgprefix)
    flag   int        // properties
    out    io.Writer  // destination for output
    buf    []byte     // for accumulating text to write
}

mu属性主要是为了确保原子操作，prefix设置每一行的前缀，flag设置输出的各种属性，比如时间、行号、文件路径等。out输出的方向，用于把日志存储文件。

本包也提供了一个预定义的“标准”logger，可以通过调用函数Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）来使用，比自行创建一个logger对象更容易使用。

例如，我们可以像下面的代码一样直接通过log包来调用上面提到的方法，默认它们会将日志信息打印到终端界面：

log.Println("这是一条优雅的日志。")
v := "优雅的"
log.Printf("这是一个%s日志\n", v)
//fatal系列函数会在写入日志信息后调用os.Exit(1)
log.Fatalln("这是一天会触发fatal的日志") 
//Panic系列函数会在写入日志信息后panic
log.Panicln("这是一个会触发panic的日志。") //执行后会自动触发一个异常

flag属性

默认情况下的logger只会提供日志的时间信息，但是很多情况下我们希望得到更多信息，比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。

log标准库中的Flags函数会返回标准logger的输出配置，而SetFlags函数用来设置标准logger的输出配置。下面是flag属性对应的常量

const (
    Ldate    = 1 << iota     // the date in the local time zone: 2009/01/23
    Ltime                    // the time in the local time zone: 01:23:23
    Lmicroseconds           // microsecond resolution: 01:23:23.123123.  assumes Ltime.
    Llongfile               // full file name and line number: /a/b/c/d.go:23
    Lshortfile   // final file name element and line number: d.go:23. overrides Llongfile
    LUTC         // if Ldate or Ltime is set, use UTC rather than the local time zone
    Lmsgprefix  // move the "prefix" from the beginning of the line to before the message
    LstdFlags = Ldate | Ltime // initial values for the standard logger
)

设置输出属性的代码如下：

func main() {
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条优雅的日志。")
}

编译输出：

2020/07/14 22:51:06.079594 D:/xxx/test_log.go:24: 这是一条优雅的日志。

prefix属性

log标准库中还提供了关于日志信息前缀的两个方法：其中Prefix函数用来查看标准logger的输出前缀，SetPrefix函数用来设置输出前缀。

func Prefix() string
 func SetPrefix(prefix string)

设置日志输出前缀的代码如下：

func main() {
    log.SetPrefix("[PS]")
    log.Println("这是一条很普通的日志。")
}

编译输出：

[PS]2020/07/14 22:56:15.652555 D:/xxx/test_log.go:26: 这是一个普通的日志

out属性

out属性是一个io.Writer输出流，使用它可以把日志输出为文件。

需要用的方法为：设置标准logger的输出目的地，默认是标准错误输出。

func SetOutput(w io.Writer)

例如，下面的代码会把日志输出到同目录下的xx.log文件中。

func main() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条很普通的日志。")
    log.SetPrefix("[PS]")
    log.Println("这是一条很普通的日志。")
}

如果你要使用标准的logger，我们通常会把上面的配置操作写到init函数中。

func init() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
}

创建新的Logger

log标准库中还提供了一个创建新logger对象的构造函数 New，支持我们创建自己的logger示例。New函数的签名如下：

func New(out io.Writer, prefix string, flag int) *Logger

New创建一个Logger对象。其中，参数out设置日志信息写入的目的地。参数prefix会添加到生成的每一条日志前面。参数flag定义日志的属性（时间、文件等等）。

举个例子：

func main() {
    logger := log.New(os.Stdout, "", log.Lshortfile|log.Ldate|log.Ltime)
    logger.Println("这是自定义的logger记录的日志。")
}

编译输出：

2020/07/14 23:02:59 test_log.go:43: 这是自定义的logger记录的日志

自定义Go Logger

可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志

设置

func SetupLogger() {
    logFileLocation, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
    log.SetOutput(logFileLocation)
}

使用

func test(){
   log.Printf("Test log: %s %s", "Hello", "World")
}

运行

func main() {
    SetupLogger()
  test()
}

Zap

Zap是非常快的、结构化的，分日志级别的Go日志库。

安装

go get -u go.uber.org/zap

配置Zap Logger

Zap提供了两种类型的日志记录器—Sugared Logger和Logger。

• Logger更快，但只支持强类型的结构化日志记录。
• Sugared Logger支持结构化和printf风格的日志记录。