1. Log

Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用。

1.1.1. 使用Logger

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

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

  1. package main
  3. import (
  4.     "log"
  5. )
  7. func main() {
  8.     log.Println("这是一条很普通的日志。")
  9.     v := "很普通的"
  10.     log.Printf("这是一条%s日志。\n", v)
  11.     log.Fatalln("这是一条会触发fatal的日志。")
  12.     log.Panicln("这是一条会触发panic的日志。")
  13. }

编译并执行上面的代码会得到如下输出：

  1.     2019/10/11 14:04:17 这是一条很普通的日志。
  2.     2019/10/11 14:04:17 这是一条很普通的日志。
  3.     2019/10/11 14:04:17 这是一条会触发fatal的日志。

logger会打印每条日志信息的日期、时间，默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。

1.1.2. 配置logger

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

log标准库中的Flags函数会返回标准logger的输出配置，而SetFlags函数用来设置标准logger的输出配置。

  1.     func Flags() int
  2.     func SetFlags(flag int)

1.1.3. flag选项

log标准库提供了如下的flag选项，它们是一系列定义好的常量。

  1. const (
  2.     // 控制输出日志信息的细节，不能控制输出的顺序和格式。
  3.     // 输出的日志在每一项后会有一个冒号分隔：例如2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
  4.     Ldate         = 1 << iota     // 日期：2009/01/23
  5.     Ltime                         // 时间：01:23:23
  6.     Lmicroseconds                 // 微秒级别的时间：01:23:23.123123（用于增强Ltime位）
  7.     Llongfile                     // 文件全路径名+行号： /a/b/c/d.go:23
  8.     Lshortfile                    // 文件名+行号：d.go:23（会覆盖掉Llongfile）
  9.     LUTC                          // 使用UTC时间
  10.     LstdFlags     = Ldate | Ltime // 标准logger的初始值
  11. )

下面我们在记录日志之前先设置一下标准logger的输出选项如下：

  1. func main() {
  2.     log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
  3.     log.Println("这是一条很普通的日志。")
  4. }

编译执行后得到的输出结果如下：

  1.     2019/10/11 14:05:17.494943 .../log_demo/main.go:11: 这是一条很普通的日志。

1.1.4. 配置日志前缀

log标准库中还提供了关于日志信息前缀的两个方法：

  1.     func Prefix() string
  2.     func SetPrefix(prefix string)

其中Prefix函数用来查看标准logger的输出前缀，SetPrefix函数用来设置输出前缀。

  1. func main() {
  2.     log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
  3.     log.Println("这是一条很普通的日志。")
  4.     log.SetPrefix("[pprof]")
  5.     log.Println("这是一条很普通的日志。")
  6. }

上面的代码输出如下：

  1.     [pprof]2019/10/11 14:05:57.940542 .../log_demo/main.go:13: 这是一条很普通的日志。

这样我们就能够在代码中为我们的日志信息添加指定的前缀，方便之后对日志信息进行检索和处理。

1.1.5. 配置日志输出位置

  1.     func SetOutput(w io.Writer)

SetOutput函数用来设置标准logger的输出目的地，默认是标准错误输出。

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

  1. func main() {
  2.     logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
  3.     if err != nil {
  4.         fmt.Println("open log file failed, err:", err)
  5.         return
  6.     }
  7.     log.SetOutput(logFile)
  8.     log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
  9.     log.Println("这是一条很普通的日志。")
  10.     log.SetPrefix("[小王子]")
  11.     log.Println("这是一条很普通的日志。")
  12. }

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

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

1.1.6. 创建logger

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

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

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

举个例子：

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

将上面的代码编译执行之后，得到结果如下：

  1.     <New>2019/10/11 14:06:51 main.go:34: 这是自定义的logger记录的日志。

总结 : Go内置的log库功能有限，例如无法满足记录不同级别日志的情况，我们在实际的项目中根据自己的需要选择使用第三方的日志库，如logrus、zap等。