2022-02-06

Logger

无论是软件开发的调试阶段还是软件上线之后的运行阶段,日志一直都是非常重要的一个环节,我们也应该养成在程序中记录日志的好习惯。

使用Logger

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

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

packagemain

import(

    "log"

)

funcmain() {

    log.Println("这是一条很普通的日志。")

    v:="很普通的"

    log.Printf("这是一条%s日志。\n",v)

    log.Fatalln("这是一条会触发fatal的日志。")

    log.Panicln("这是一条会触发panic的日志。")

}

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

2017/06/1914:04:17 这是一条很普通的日志。

2017/06/1914:04:17 这是一条很普通的日志。

2017/06/1914:04:17 这是一条会触发fatal的日志。

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

配置Logger

标准logger的配置

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

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

funcFlags()int

funcSetFlags(flagint)

flag选项

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

const(

// 控制输出日志信息的细节,不能控制输出的顺序和格式。

// 输出的日志在每一项后会有一个冒号分隔:例如2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message

Ldate=1<<iota// 日期:2009/01/23

Ltime// 时间:01:23:23

Lmicroseconds// 微秒级别的时间:01:23:23.123123(用于增强Ltime位)

Llongfile// 文件全路径名+行号: /a/b/c/d.go:23

Lshortfile// 文件名+行号:d.go:23(会覆盖掉Llongfile)

LUTC// 使用UTC时间

LstdFlags=Ldate|Ltime// 标准logger的初始值

)

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

funcmain() {

    log.SetFlags(log.Llongfile|log.Lmicroseconds|log.Ldate)

    log.Println("这是一条很普通的日志。")

}

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

2017/06/1914:05:17.494943.../log_demo/main.go:11:这是一条很普通的日志。

配置日志输出位置

funcSetOutput(wio.Writer)

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

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

funcmain() {

    logFile,err:=os.OpenFile("./xx.log",os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)

    iferr!=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("[小王子]")

    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, "<New>", log.Lshortfile|log.Ldate|log.Ltime)

logger.Println("这是自定义的logger记录的日志。")

}

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

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

总结

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

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • https://learnku.com/docs/gin-gonic/2018/gin-readme/3819 安...
    程序员的自我修养阅读 5,303评论 0 1
  • 目录 1.go 各种代码运行 2.go 在线编辑代码运行 3.通过 Gob 包序列化二进制数据 4.使用 ...
    杨言锡阅读 4,857评论 0 1
  • 在工程化的Go语言开发项目中,Go语言的源码复用是建立在包(package)基础之上的。本文介绍了Go语言中如何定...
    雪上霜阅读 1,823评论 0 0
  • 在我们开发程序后,如果有一些问题需要对程序进行调试的时候,日志是必不可少的,这是我们分析程序问题常用的手段。 日志...
    豆瓣奶茶阅读 18,450评论 0 22
  • log 日志 log 模块可以自定义log 对象, 也可以使用log默认对象的日志方法 func New 创建lo...
    copyLeft阅读 8,079评论 0 0

友情链接更多精彩内容