go log包

go log包

log包介绍

Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用，更方便强大的日志记录需要借助于其它第三方日志库：zap、logrus等

log包定义了Logger类型，该类型提供了一些格式化输出的方法

type Logger struct {
    mu     sync.Mutex // mu属性主要是为了确保原子操作
    prefix string     // prefix设置每一行的前缀
    flag   int        // flag设置输出的各种属性，比如时间、行号、文件路径等
    out    io.Writer  // out输出的方向，用于把日志存储文件
    buf    []byte     // 缓冲
}

本包也提供了一个预定义的标准logger，可以通过调用函数Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）来使用，比自行创建一个logger对象更容易使用

使用Logger

通过log包来调用上面提到的方法，默认会将日志信息打印到终端界面

func main() {
	log.Println("我是一条普通日志-Println")
	log.Printf("我是一条普通日志：%v-Printf", "lqz")
	log.Fatalln("我是一条致命的日志-Fatalln")
	log.Panicln("这是一条触发错误的日志--Panicln")
}
///fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。

输出结果

2022/07/22 14:58:19 我是一条普通日志-Println
2022/07/22 14:58:19 我是一条普通日志：lqz-Printf
2022/07/22 14:58:19 我是一条致命的日志-Fatalln

logger会打印每条日志信息的日期、时间，默认输出到系统的标准错误。

logger的配置

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

func Flags() int  //返回标准logger的输出配置
func SetFlags(flag int) //来设置标准logger的输出配置

flag参数

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

注意：只能控制输出日志信息的细节，不能控制输出的顺序和格式，输出的日志在每一项后会有一个冒号分隔

const (
    Ldate         = 1 << iota     // 本地日期						 00000001
    Ltime                         // 本地时间						 00000010
    Lmicroseconds                 // 微秒级别的时间,用于增强Ltime位	     00000100
    Llongfile                     // 文件全路径名+行号 			       00001000
    Lshortfile                    // 文件名+行号(会覆盖掉Llongfile)	   00010000  
    LUTC                          // 使用UTC时间					 00100000
    LstdFlags     = Ldate | Ltime // 标准logger的初始值				01000000
)

演示

func main() {
	fmt.Println(log.Flags())  // 打印出3的意思是：Ldate | Ltime 做位运算得到 00000011
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) // 二进制 00001101   十进制 13  SetFlags 可以传入二进制或者十进制数字，但是不推荐，更推荐使用定义好的常量
	log.Println("这是一条带文件路径和日期时间的日志")
}

结果如下：

3
2022/07/22 14:58:58.338318 D:/goproject/day05/s7.go:19: 这是一条带文件路径和日期时间的日志

配置日志前缀

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

func Prefix() string  // 返回前缀
func SetPrefix(prefix string) // 设置前缀

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

func main() {
	log.SetPrefix("订单服务：")
	fmt.Println(log.Prefix())
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.Println("这是一条带前缀的日志")
}

上面的代码输出如下：

订单服务：
订单服务：2022/07/22 14:59:27.719190 D:/goproject/day05/s7.go:25: 这是一条带前缀的日志

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

配置日志输出位置

func SetOutput(w io.Writer) //设置标准logger的输出目的地，默认是标准错误输出

把日志输出到同目录下的log.log文件

func main() {
	log,err:=os.OpenFile("./log.log",os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
	if err != nil {
		fmt.Println("打开文件出错：",err)
		return
	}
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.SetPrefix("订单服务：")
	log.SetOutput(logFile)
	log.Println("这是一条写进文件的日志--Panicln")
}

上面的配置可以写到init函数中

func init() {
	log,err:=os.OpenFile("./log.log",os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
	if err != nil {
		fmt.Println("打开文件出错：",err)
		return
	}
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.SetPrefix("订单服务：")
	log.SetOutput(logFile)
}

创建logger

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

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

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

举个例子：

func main() {
	log,err:=os.OpenFile("./log.log",os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
	if err != nil {
		fmt.Println("打开文件出错：",err)
		return
	}
	logger:=log.New(logFile,"商品服务：",log.Lshortfile|log.Ldate|log.Ltime)
	//logger:=log.New(os.Stdout,"商品服务：",log.Lshortfile|log.Ldate|log.Ltime)
	logger.Println("日志演示案例")

}

结果如下：

商品服务：2022/07/22 14:59:58 s7.go:37: 日志演示案例

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

常规方案

在开发中，通常是把日志配置到init函数中，使用时直接调用log就行，一个包内写一次init即可

func init()  {  // 自动执行，没有参数，没有返回值
	log.SetPrefix("订单服务：")
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	logFile,err:=os.OpenFile("./log.log",os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
	if err != nil {
		fmt.Println("打开文件出错：",err)
		return
	}
	log.SetOutput(logFile)
}

func main() {
	log.Println("输出一条日志")
}