[Go 入门] 第十五章 调试

Go 入门系列参考于互联网资料与 人民邮电出版社 《Go 语言入门经典》 与 《Effective Go》,编写目的在于学习交流,如有侵权,请联系删除

调试是确定程序为何不像预期那样工作的过程, 本文内容:

日志

日志指的是记录程序执行期间发生的情况。无论程序需不需要调试都会产生日志,这对于理解程序的执行情况很有帮助。很多常见的应用程序都提供了日志功能,这些日志可用来监视应用程序的健康状况、跟踪问题以及发现问题

日志并非为报告 bug 而提供的,而是可供在 bug 发生时使用的基础设施。诸如 Nginx 等 web 服务器在运行期间将日志写入文件,包括访问日志和错误日志。服务器管理员可使用这些日志来调试问题或核实是否一切正常。日志文件为文本文件,能够让您轻松地找到并理解特定的事件或错误。

Go 语言提供了 log 包,让应用程序能够将日志写入终端或者文件。

1
2
3
4
5
6
7
package main

import "log"

func main() {
log.Printf("This is a log message")
}

上面的代码将输出

2020/02/02 16:36:58 This is a log message

注意到消息日志中不包含的日期和时间,这将会很有用。log 包还可以用来记录发生的致命错误。

1
2
3
4
5
6
7
8
9
10
11
package main

import (
"errors"
"log"
)

func main() {
var errFatal = errors.New("crashing")
log.Fatal(errFatal)
}

由于错误会导致程序退出,但是这个程序将一条日志消息写入终端

1
2
3
2020/02/02 16:39:30 crashing

Process finished with exit code 1

日志还可以写入文件,可使用 Go 语言本身提供的功能,也可使用操作系统提供的功能。要将日志写入文件,只需命令 log 包这样做

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package main

import (
"log"
"os"
)

func main() {
f, err := os.OpenFile("test.log", os.O_APPEND|os.O_CREATE|os.O_RDWR, 0666)
if err != nil{
log.Fatal(err)
}
defer f.Close()
log.SetOutput(f)

for i := 1; i <=5; i++ {
log.Printf("Log iteration %d", i)
}
}

还可以在终端使用重定向的功能,可将输出重定向到文件,如

1
2
3
4
func main() {
var errFatal = errors.New("crashing")
log.Fatal(errFatal)
}

终端运行:

go run main.go > test.log 2>&1

通常最好使用操作系统将日志重定向到文件,而不是用 Go 语言代码,因为这种方法更灵活,能够让其他工具在必要时使用日志

打印数据

在很多情况下,Bug 都是由于数据不符合预期导致的。可以使用 fmt.Println() 打印出变量的值来进行检查

使用 fmt 包

为了将值打印到终端,有必要探索一下 fmt 包以及如何将其用于调试。 fmt 包可用来设置格式,因此必要时可使用它来输出数据,以方便调试。通过使用函数 Printf ,可创建要打印的字符串,并使用百分符号在其中引用变量。 fmt包将对变量进行分析,并输出字符串。

1
2
3
func main() {
s := "Hello world!"
fmt.Printf("%v", s)

动词 %v 是类型的默认格式,这是一个占位符

占位符

普通占位符

占位符 说明 举例 输出
%v 相应值的默认格式。 Printf(“%v”, people) {zhangsan}
%+v 打印结构体时,会添加字段名 Printf(“%+v”, people) {Name:zhangsan}
%#v 相应值的Go语法表示 Printf(“#v”, people) main.Human{Name:”zhangsan”}
%T 相应值的类型的Go语法表示 Printf(“%T”, people) main.Human
%% 字面上的百分号,并非值的占位符 Printf(“%%”) %

布尔占位符

占位符 说明 举例 输出
%t true 或 false Printf(“%t”, true) true

整数占位符

占位符 说明 举例 输出
%b 二进制表示 Printf(“%b”, 5) 101
%c 相应Unicode码点所表示的字符 Printf(“%c”, 0x4E2D)
%d 十进制表示 Printf(“%d”, 0x12) 18
%o 八进制表示 Printf(“%d”, 10) 12
%q 单引号围绕的字符字面值,由Go语法安全地转义 Printf(“%q”, 0x4E2D) ‘中’
%x 十六进制表示,字母形式为小写 a-f Printf(“%x”, 13) d
%X 十六进制表示,字母形式为大写 A-F Printf(“%x”, 13) D
%U Unicode格式:U+1234,等同于 “U+%04X” Printf(“%U”, 0x4E2D) U+4E2D

浮点数和复数的组成部分(实部和虚部)

占位符 说明 举例 输出
%b 无小数部分的,指数为二的幂的科学计数法, 与 strconv.FormatFloat 的 ‘b’ 转换格式一致。例如 -123456p-78
%e 科学计数法,例如 -1234.456e+78 Printf(“%e”, 10.2) 1.020000e+01
%E 科学计数法,例如 -1234.456E+78 Printf(“%e”, 10.2) 1.020000E+01
%f 有小数点而无指数,例如 123.456 Printf(“%f”, 10.2) 10.200000
%g 根据情况选择 %e 或 %f 以产生更紧凑的(无末尾的0)输出 Printf(“%g”, 10.20) 10.2
%G 根据情况选择 %E 或 %f 以产生更紧凑的(无末尾的0)输出 Printf(“%G”, 10.20+2i) (10.2+2i)

字符串与字节切片

占位符 说明 举例 输出
%s 输出字符串表示(string类型或[]byte) Printf(“%s”, []byte(“Go语言”)) Go语言
%q 双引号围绕的字符串,由Go语法安全地转义 Printf(“%q”, “Go语言”) “Go语言”
%x 十六进制,小写字母,每字节两个字符 Printf(“%x”, “golang”) 676f6c616e67
%X 十六进制,大写字母,每字节两个字符 Printf(“%X”, “golang”) 676F6C616E67

指针

占位符 说明 举例 输出
%p 十六进制表示,前缀 0x Printf(“%p”, &people) 0x4f57f0

其它标记

占位符 说明 举例 输出
+ 总打印数值的正负号;对于%q(%+q)保证只输出ASCII编码的字符。 Printf(“%+q”, “中文”) “\u4e2d\u6587”
- 在右侧而非左侧填充空格(左对齐该区域)
# 备用格式:为八进制添加前导 0(%#o) 为十六进制添加前导 0x(%#x)或 0X(%#X),为 %p(%#p)去掉前导 0x; 如果可能的话,%q(%#q)会打印原始 (即反引号围绕的)字符串; 如果是可打印字符,%U(%#U)会写出该字符的 Unicode 编码形式(如字符 x 会被打印成 U+0078 ‘x’)。 Printf(“%#U”, ‘中’) U+4E2D
‘’ (空格)为数值中省略的正负号留出空白(% d); 以十六进制(% x, % X)打印字符串或切片时,在字节之间用空格隔开
0 填充前导的0而非空格;对于数字,这会将填充移到正负号之后

其他说明:

  • golang没有 ‘%u’ 点位符,若整数为无符号类型,默认就会被打印成无符号的。

  • 宽度与精度的控制格式以Unicode码点为单位。宽度为该数值占用区域的最小宽度;精度为小数点之后的位数。

  • 操作数的类型为int时,宽度与精度都可用字符 ‘*’ 表示。

  • 对于 %g/%G 而言,精度为所有数字的总数,例如:123.45,%.4g 会打印123.5,(而 %6.2f 会打印123.45)。

  • %e 和 %f 的默认精度为6

  • 对大多数的数值类型而言,宽度为输出的最小字符数,如果必要的话会为已格式化的形式填充空格。

  • 而以字符串类型,精度为输出的最大字符数,如果必要的话会直接截断。

调试

Go 语言没有官方的调试器,很多社区项目提供了 Go 语言调试器

Delve 和 unix 系统上的 GNU 调试器 gdb 来进行 Go 语言的调试

但是相对而言,更推荐使用 GoLand IDE 进行调试,如图打上断点,右键进行 Debug,便会在断点处停止,并输出变量

Goland 调试

问题列表

  • 使用 fmt 和 log 包是否会导致代码中充斥调试语句

    确实,这会导致代码中充斥着调试语句,但是可以在完成调试后将它们删除


All articles in this blog adopt the CC BY-SA 4.0 agreement unless otherwise stated. Please indicate the source for reprinting!