使用log包记录错误

在应用出现异常或意外情况时，日志会显得无比重要。如果提供系统级别的日志，在代码的关键位置记录相关信息，也有助于在开发期间快速调试问题。太多的日志记录会导致很难找到有用的东西，但没有足够的日志记录可能在系统崩溃时无法追寻其根本原因。本节将演示如何使用Go标准库中的log包。

实践

获取第三方库：

go get github.com/pkg/errors/

建立log.go：

package log

import (
    "bytes"
    "fmt"
    "log"
)

// 对日志进行设置
func Log() {
    // logger会写入bytes.Buffer类型的数据
    buf := bytes.Buffer{}

    // 第二个参数是前缀最后一个参数是关于选项
    // 配置选项可以用逻辑或符号组合起来
    logger := log.New(&buf, "logger: ", log.Lshortfile|log.Ldate)

    logger.Println("test")

    logger.SetPrefix("new logger: ")

    logger.Printf("you can also add args(%v) and use Fataln to log and crash", true)

    fmt.Println(buf.String())
}

建立error.go：

package log

import "github.com/pkg/errors"
import "log"

// OriginalError返回错误的原始信息
func OriginalError() error {
    return errors.New("error occurred")
}

// PassThroughError 调用OriginalError并将其封装
func PassThroughError() error {
    err := OriginalError()
    // 无需检查错误，因为使用该库时此操作适用于nil
    return errors.Wrap(err, "in passthrougherror")
}

// FinalDestination处理错误而不传递它
func FinalDestination() {
    err := PassThroughError()
    if err != nil {
        // 将任何产生的意外记录到日志中
        log.Printf("an error occurred: %s\n", err.Error())
        return
    }
}

建立main.go：

package main

import (
    "fmt"

    "github.com/agtorre/go-cookbook/chapter4/log"
)

func main() {
    fmt.Println("basic logging and modification of logger:")
    log.Log()
    fmt.Println("logging 'handled' errors:")
    log.FinalDestination()
}

这会输出：

basic logging and modification of logger:
logger: 2018/07/23 log.go:18: test
new logger: 2018/07/23 log.go:22: you can also add args(true) and use Fataln to log and crash

logging 'handled' errors:
2018/07/23 11:37:07 an error occurred: in passthrougherror: error occurred

说明

你可以使用log.NewLogger()初始化日志并传递它，或直接调用log包记录消息。

这种操作方式并不优雅，因为你需要传递过去一堆变量，这是令人困惑并难以理解的。下一节，我们探讨如何使用更加灵活的方式设置日志。