Go: http.Server日志处理

在日常写Go代码中，开发者在业务中自己打印日志都很常见，只要创建日志对象并调用相应的Info、Error、Debug或Fatal方法即可。但有时候系统错误或者goroutine里面的错误可能就忘记输出到日志文件中。

在go的http服务开发中，要意识到Go的http.Server可能输出日志消息，这些消息与未捕获的panic或接收http连接、向连接写入数据时发生错误相关。

默认情况下，这些错误会写入内建标准日志中，也就是输出到标准错误流中（而不是输出到我们创建的日志对象定义的文件中）而且输出格式也不是我们定义的。

如果您希望将所有内容以相同的格式记录在一个地方，那么这显然是一个问题。

不幸的是，还不能直接设置http.Server使用我们定义的日志类型。但你可以做到自定义日志类型实现io.Writer接口，然后修改http.Server配制使用我们定义的日志对象即可。

先让自定义日志类型实现io.Writer接口：

type Level int8

const (
    LevelInfo Level = iota
    LevelError
    LevelFatal
    LevelOff
)

func (l Level) String() string {
    switch l {
    case LevelInfo:
        return "INFO"
    case LevelError:
        return "ERROR"
    case LevelFatal:
        return "FATAL"
    default:
        return ""
    }
}

type Logger struct {
    out      io.Writer
    minLevel Level
    mu       sync.Mutex
}

func New(out io.Writer, minLevel Level) *Logger {
    return &Logger{
        out:      out,
        minLevel: minLevel,
    }
}

func (l *Logger) Info(message string, properties map[string]string) {
    l.print(LevelInfo, message, properties)
}

func (l *Logger) Error(err error, properties map[string]string) {
    l.print(LevelError, err.Error(), properties)
}

func (l *Logger) Fatal(err error, properties map[string]string) {
    l.print(LevelFatal, err.Error(), properties)
    os.Exit(1)
}

func (l *Logger) print(level Level, message string, properties map[string]string) (int, error) {
    if level < l.minLevel {
        return 0, nil
    }
    aux := struct {
        Level      string            `json:"level"`
        Time       string            `json:"time"`
        Message    string            `json:"message"`
        Properties map[string]string `json:"properties,omitempty"`
        Trace      string            `json:"trace,omitempty"`
    }{
        Level:      level.String(),
        Time:       time.Now().UTC().Format(time.RFC3339),
        Message:    message,
        Properties: properties,
    }
    if level >= LevelError {
        aux.Trace = string(debug.Stack())
    }
    var line []byte
    line, err := json.Marshal(aux)
    if err != nil {
        line = []byte(LevelError.String() + ": unable to marshal log message:" + err.Error())
    }
    l.mu.Lock()
    defer l.mu.Unlock()
    return l.out.Write(append(line, '\n'))
}

func (l *Logger) Write(message []byte) (n int, err error) {
    return l.print(LevelError, string(message), nil)
}

上面自定义Logger类型通过实现Write方法实现了io.Writer接口。后面就简单多了，只需要将自定义日志对象传入http.Server即可：

func main() { ...
// 初始化自定义logger对象
logger := jsonlog.New(os.Stdout, jsonlog.LevelInfo)
...
  srv := &http.Server{
    Addr: fmt.Sprintf(":%d", cfg.port),
    Handler: app.routes(),
// 使用log.New()函数创建log.logger实例，然后传入我们定义日志对象
//后面空字符串和0，表示日志不带前缀和属性
  ErrorLog: log.New(logger, "", 0),
  IdleTimeout: time.Minute,
  ReadTimeout: 10 * time.Second,
  WriteTimeout: 30 * time.Second,
  }
...
}

有了这种设置，http.Server的任何日志消息将被传递给Logger.Write()方法，该方法将在ERROR级别以JSON格式输出日志。

这里在创建http.Server对象时需要传入一个内建的logger对象，在创建内建logger对象的时候，要传入一个实现了io.Writer的实例，我们这里取巧的是让自定义日志对象也实现该接口，这样就可以将内容输出到我们定义的日志文件中，而且输出格式也是和我们定义的一致。