日志的重要性
当一个程序出了问题时，不同的人会有不同反应。
有的人抓耳挠腮一脸茫然，有的人开始人肉跟踪代码试图找出破绽，还有的人已经开始准备在程序里加 print 了。
Print 是个好东西，它几乎可以让我们像 debugger 那样跟踪查看代码执行到某行时变量的值。
但是当代码跑到生产环境后，这种做法就歇菜了。生产环境要比本地复杂地多，有些问题不可重现，而且我们根本不可能跑到生产环境旁若无人的改代码。
这时候怎么办呢？使用日志。将重要的信息记录下来，调试信息、警告信息和错误信息都很有价值。
Go 语言中的 log 包
日志多被记录到日志文件。写日志文件其实没什么高深的东西，甚至在很多没有内置库支持的场合，很多人只是把写文件操作简单包装一下。
Go 语言为日志功能提供了一个简单的包。这里的“简单”并非出于谦虚，log/log.go 源代码文件只有346行。但由于日志对象使用了 interface 的设计，实现足够灵活。
在分析该文件时，我们依然按照先 struct 后 func 的顺序来一一展开。
Logger 结构体
Log 包支持同时存在多个 logger，这些 logger 可以有不同的输出格式且输出内容互不干扰。
我们来看一下 Logger 的定义：
type Logger struct {
mu sync.Mutex // ensures atomic writes; protects the following fields
prefix string // prefix to write at beginning of each line
flag int // properties
out io.Writer // destination for output
buf []byte // for accumulating text to write
}
我们先重点关注 flag、out 和 buf 这三个字段。
flag 控制日志信息的前缀，比如是否显示时间、是否显示打印日志的文件名和行号等。flag 可取如下一些值。
const (
Ldate = 1 << iota
Ltime
Lmicroseconds
Llongfile
Lshortfile
LUTC
LstdFlags = Ldate | Ltime
)
out 字段是一个 io.Writer，在 io/io.go 包中它是下面这个样子：
type Writer interface {
Write(p []byte) (n int, err error)
}
out 表示我们要把日志写到哪里。它是一个 Writer，即只要实现 Write() 方法即可。这为日志的使用提供了很大的便利。
设想一下，假如我们想通过 log 模块将日志写入数据库该怎么做呢？只需要实现一个如上所示的 Write() 方法，该方法接收一条日志时，将该日志写入数据库，并返回写入字节数和错误信息即可。
buf 被用来操作临时的日志信息。
Log 包提供来一个 New() 函数来实例化一个 Logger。
func New(out io.Writer, prefix string, flag int) *Logger {
return &Logger{out: out, prefix: prefix, flag: flag}
}
写日志方法
log 包里的写日志方法都是对 Logger.Output() 方法的简单包装。下面我们来看一下 Logger.Output() 方法。
func (l *Logger) Output(calldepth int, s string) error {
now := time.Now() // get this early.
var file string
var line int
// ...
_, file, line, ok = runtime.Caller(calldepth)
// ...
l.buf = l.buf[:0]
l.formatHeader(&l.buf, now, file, line)
l.buf = append(l.buf, s...)
if len(s) == 0 || s[len(s)-1] != '\n' {
l.buf = append(l.buf, '\n')
}
_, err := l.out.Write(l.buf)
return err
}
代码还是非常简单的，将调用 log 的时间、文件名、行号及日志信息写入 out 即完成了日志的输出。
其中 runtime.Caller() 用于获取调用者的信息。
其中 // ... 是我们省略的一些在此处不必要的细节。这里我们一会再来讨论。
Log 包使用 demo
下面我们针对之前分析的代码写一个演示代码：
package main
import (
"log"
"os"
)
func main() {
logger := log.New(os.Stderr, "", log.Lshortfile | log.LstdFlags)
logger.Output(1, "hello from demo")
}
我们从标准错误创建一个 logger，并调用 Logger.Output() 将日志打印到标准错误。注意，Logger.Output() 的第一个参数是 1，这样刚好找到我们的调用位置。
执行后系统输出：2017/09/11 22:31:10 demo.go:11: hello from demo。
对调用函数进行封装
直接调用 Logger.Output() 不够友好，特别是还携带了一个充满 hack 意味的 calldepth 参数。
Log 包以 Output() 为基础，提供了很多其它实用工具。实现方式简单且大致相同，下面摘几个出来看一下。
func (l *Logger) Print(v ...interface{}) { l.Output(2, fmt.Sprint(v...)) }
func (l *Logger) Fatal(v ...interface{}) {
l.Output(2, fmt.Sprint(v...))
os.Exit(1)
}
func (l *Logger) Panic(v ...interface{}) {
s := fmt.Sprint(v...)
l.Output(2, s)
panic(s)
}
与 flag 包相同（参见《源码学习 go 语言的 flag 包》），log 包同样实现了一套顶层函数。
var std = New(os.Stderr, "", LstdFlags)
func Print(v ...interface{}) {
std.Output(2, fmt.Sprint(v...))
}
这下简单了，上面的 demo 可以重写为如下格式。
package main
import (
"log"
)
func main() {
log.SetFlags(log.Lshortfile | log.LstdFlags)
log.Print("hello from demo")
}
对于一些简单的程序，这套函数已经足够了。
如果是要写到文件，可以考虑在程序里重定向标准错误，或手动创建一个 Logger。
Next？
log/log.go 里有一个格式化函数 Logger.formatHeader()，里面处理了日志前缀的格式。代码很简单，而且功能相对独立，这里就不分析了。
我们分析了 log 包的 log.go 文件，但实际上，log 包还对 syslog 做了支持，代码在 log/syslog/ 下。有兴趣可以看一下。
