1. 日志
日志是指程序执行过程中记录的信息。
- 日志并非专为报告BUG而设,但可作为BUG发生时诊断故障的基础设施。
- 日志通常采用文本文件的形式,便于直接阅读,以查找特定的事件或发生错误的原因
标准库的log包让应用程序能够将日志写入终端或文件
- 日志中包含日期、时间和文本等
- log.Printf("This is a log message")
- 2018/12/28 23:46:13 This is a log message
- log.Printf()与前面我们学过的fmt.Printf()类似,也可以根据需要进行格式化的输出。
- 当致命错误发生时,调用Fatal函数,打印日志并终止程序运行。
- log.Fatal(err)
// 打印日志
// 标准库的log包让应用程序能够将日志写入终端或文件。日志中包含日期、时间和文本
// 等
package main
import "log"
func main() {
log.Printf("This is a log message")
}
// 打印输出:
// 2020/02/05 22:36:13 This is a log message
// 致命错误
// 标准库的log包还可用来记录程序运行过程中发生的致命错误。Fatal函数在打印日志
// 的同时终止程序的运行
package main
import (
"errors"
"fmt"
"log"
)
func foo() error {
return errors.New("We only just started and we are crashing")
}
func main() {
err := foo()
if err != nil {
log.Fatal(err)// 至此,程序已“崩溃”后续程序不再执行
}
fmt.Println(
"We are going to bow out gracefully")
}
// 打印输出:
2018/12/28 23:52:38 We only just started and we are crashing
exit status 1
Process exiting with code: 1
通过终端打印日志信息对于调试能起到一定作用,但想通过日志了解程序运行过程中发生的意外事件,则需要将其写入文件。
- 通过Go语言本身提供的功能将日志写入文件
- f, err := os.OpenFile("./file.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666)
- log.SetOutput(f)
- log.Printf("Log iteration %d", i)
- 借助操作系统提供的I/O重定向功能将日志写入文件
- go run main.go 2>file.log
- 最好通过操作系统将日志重定向到文件,而不要使用Go语言的文件操作,因为前者更加灵活,能够借助管道让其它工具在必要时参与对日志信息的分析。
// 写入日志文件
// 通过Go语言本身提供的功能将日志写入文件
package main
import (
"log"
"os"
)
func main() {
f, err := os.OpenFile("./file.log",
os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666)
// 打开file.log文件,如不存在,则创建;如已存在,则追加新信息;可读可写
if err != nil {
log.Fatal(err)
}
defer f.Close()
log.SetOutput(f)
for i := 1; i <= 5; i++ {
log.Printf("Log iteration %d", i)
}
}
// 2020/02/06 09:21:44 Log iteration 1
// 2020/02/05 09:21:44 Log iteration 2
// 2020/02/05 09:21:44 Log iteration 3
// 2020/02/05 09:21:44 Log iteration 4
// 2020/02/05 09:21:44 Log iteration 5
// I/O重定向
// 借助操作系统提供的I/O重定向功能将日志写入文件
// go run main.go 2>file.log
package main
import (
"log"
)
func main() {
for i := 1; i <= 5; i++ {
log.Printf("Log iteration %d", i)
}
}
// 打印输出:同“写入日志文件”
2. 打印数据
为了调试程序中的BUG,最快捷,最简单的方式就是将数据直接打印出来。
- fmt.Printf("[DEBUG] text is: %q\n", text)
象这样打印数据的做法通常被视为一种快速解决方案,因为只需添加一行打印数据的代码,就可能使BUG立刻现身。
这样做的弊端是久而久之,程序中可能到处充斥着调试代码。
// 打印数据
// 为了调试程序中的BUG,最快捷,最简单的方式就是将数据直接打印出来
package main
import (
"bufio"
"fmt"
"log"
"os"
"strings"
)
func main() {
reader := bufio.NewReader(os.Stdin) // 获取读取器
fmt.Print("Guess the name of my " +
"pet to win a prize: ")
text, err := reader.ReadString('\n')// 获取标准输入的字符串文本
if err != nil {
log.Fatal(err)
}
// 打印调试信息
fmt.Printf("[DEBUG] text is: %q\n", text)
if text == "john" {
fmt.Println("You won! You win chocolate!")
} else {
fmt.Println(
"You didn't win. Better luck next time.")
}
}
// 打印输出:
Guess the name of my pet to win a prize: John // John是我们输入的
[DEBUG] text is: "John\r\n" // 输入字符串包含John,回车,换行,肯定与"john"
// 不相等(大小写和多余字符),所以“猜错了”。
You didn't win. Better luck next time.
// 打印数据
// 为了调试程序中的BUG,最快捷,最
// 简单的方式就是将数据直接打印出来
package main
import (
"bufio"
"fmt"
"log"
"os"
"strings"
)
func main() {
reader := bufio.NewReader(os.Stdin)
fmt.Print("Guess the name of my " +
"pet to win a prize: ")
text, err := reader.ReadString('\n')
if err != nil {
log.Fatal(err)
}
text = strings.ToLower(strings.TrimSpace(text)) // 去掉结尾的空白字符;
// 全小写text
// 打印调试信息
fmt.Printf("[DEBUG] text is: %q\n", text)
if text == "john" {
fmt.Println("You won! You win chocolate!")
} else {
fmt.Println(
"You didn't win. Better luck next time.")
}
}
// 打印输出:
Guess the name of my pet to win a prize: John
[DEBUG] text is: "john"
You won! You win chocolate!