我们在使用Golang(Go语言)开发的过程中,会通过经常通过调试的方式查找问题的原因,解决问题,尤其是当遇到一个很棘手的问题的时候,就需要知道一段代码在执行的过程中,其上下文的变量对应的数据,以便进行推测出问题的原因。
对于这类调试,我们用的比较多的一个是断点调试,还有是通过打印日志输出。通过日志打印的话,可能一开始常用的就是fmt.Println
输出,简单,边界。如果我们再想看一些更多信息的话,比如行号,可以通过log
包。
package main import ( "fmt" "log" ) func main() { i := 0 s := "哈哈" fmt.Println(i, s) log.Println(i, s) }
这这两种是比较常用的方式,可以打印变量的值、还有一些附加信息、比如源代码行号、时间等等。
那么如果,我们想知道一个struct
的字段呢?包括字段的名字,类型,值,如果是字段也是一个struct
,如何深度遍历呢?这些信息都是调试时非常有用的信息,尤其是我们调用的第三方库,可以通过这种方式,查看变量的数据结构,以及这些结构对应的值等信息,这对我们开发调试有很大帮助,提高我们开发效率。
go-spew
对于上面的信息,已经有了一款工具帮我们做这些事情,它就是go-spew,go-spew可以帮助Golang开发者打印数据的结构,并且以一种比较易读的方式,让开发者,可以看到一个变量的数据结构信息。
go get -u github.com/davecgh/go-spew/spew
通过以上方式,我们即可下载安装这个go-spew go语言库,然后就可以在你的项目中使用它。还是上面的例子,我们看看效果。
package main import ( "fmt" "log" "github.com/davecgh/go-spew/spew" ) func main() { i := 0 s := "哈哈" fmt.Println(i, s) log.Println(i, s) spew.Dump(i, s) }
输出:
0 哈哈 2019/08/25 09:55:07 0 哈哈 (int) 0 (string) (len=6) "哈哈"
是不是信息比较全,类型、值,对于字符串还有长度,这对于我们调试非常有用。现在我们再试试其他类型。
package main import ( "errors" "github.com/davecgh/go-spew/spew" ) type person struct { Name string } func main() { i := 0 s := "哈哈" m := map[int]string{1: "1", 2: "2"} e := errors.New("嘿嘿,错误") p := person{Name: "张三"} spew.Dump(i, s, m, e, p) }
这里我们多加了一个map
,一个error
接口,还有一个自定义的struct
,我们同样运行看看打印的输出结果
(int) 0 (string) (len=6) "哈哈" (map[int]string) (len=2) { (int) 1: (string) (len=1) "1", (int) 2: (string) (len=1) "2" } (*errors.errorString)(0x1162e158)(嘿嘿,错误) (main.person) { Name: (string) (len=6) "张三" }
map
的数据结构输出,不止有类型,还有map
的长度以及里面每个K-V
的类型、值以及长度。
errors.New
函数返回的是一个error
接口,但是我们通过spew
打印,可以看到具体的实现类型,还有对应的指针地址以及错误信息。
我们自定义的person
也是一样的,也可以详细的打印出具体的数据结构,包含类型、字段、字段类型、字段值等信息。
这些信息,可以方便的为我们在调试中提供帮助。
Dump,Fdump,Sdump 函数
在spew
的时候,dump
系列函数,是最常用的函数,他可以满足我们的大部分需求,而不用自己定制输出的样式。
dump
系列函数输出带有美观的样式、类型、指针、长度等信息。
Dump
函数,是标准的输出到os.Stdout
的,也就是我的控制台标准输出。
Fdump
函数,允许我们自定义一个输出io.Writer
,可以是os.Stdout
,也可以是其他*File
等,只要实现了io.Writer
接口就可以。
func Dump(a ...interface{}) { fdump(&Config, os.Stdout, a...) } func Fdump(w io.Writer, a ...interface{}) { fdump(&Config, w, a...) }
其实看上面的源代码,你会发现Dump
和Fdump(os.Stdout)
是等价的。
Sdump
函数,会把输出的结果作为一个字符串返回,这样你就可以灵活使用它,比如通过API传递给服务器。
func Sdump(a ...interface{}) string { var buf bytes.Buffer fdump(&Config, &buf, a...) return buf.String() }
具体实现,采用了一个bytes.Buffer
存储打印的输出,然后转换为字符串返回。这里的bytes.Buffer
实现了io.Writer
,所以可以直接使用。
Printf, Fprintf,Sprintf 函数
上面的Dump
系列函数,虽然可以满足我们的大部分需求,但是spew
也为我们提供了定制输出风格的函数,他们和fmt
的函数用法非常相似。
package main import ( "errors" "github.com/davecgh/go-spew/spew" ) func main() { s := "哈哈" e := errors.New("嘿嘿,错误") spew.Printf("%v\n", s) spew.Printf("%+v\n", s) spew.Printf("%#v\n", s) spew.Printf("%#+v\n", s) spew.Dump(s) spew.Printf("%v\n", e) spew.Printf("%+v\n", e) spew.Printf("%#v\n", e) spew.Printf("%#+v\n", e) spew.Dump(e) }
我们通过上面的例子,演示下Printf
系列函数和Dump
系列函数的不同。
上面的例子中,我们使用一个字符串s
,一个error
类型的错误来演示。运行输出看结果。
哈哈 哈哈 (string)哈哈 (string)哈哈 (string) (len=6) "哈哈" <*>嘿嘿,错误 <*>(0x11704170)嘿嘿,错误 (*errors.errorString)嘿嘿,错误 (*errors.errorString)(0x11704170)嘿嘿,错误 (*errors.errorString)(0x11704170)(嘿嘿,错误)
对于字符串s
发现不同格式化字符v
、+v
、#v
的输出基本上差不多,而对于实现了error
接口的指针类型就不一样了。从以上例子中我们可以推测出这几个格式化字符串的作用。
v
基本上就是打印值,最少的输出 +v
会添加指针的地址作为输出的一部分 #v
会添加类型作为输出的一部分#+v
输出包含指针、也包含类型,还有值,和Dump
函数差不多
另外两个Fprintf
、Sprintf
函数,使用和Printf
差不多,Fprintf
是可以把内容格式化到一个io.Writer
中,Sprintf
返回格式化后的字符串,以供使用
自定义配置
spew
的默认配置已经够我们使用了,如果无法满足,可以通过spew
提供的自定义配置来达到我们的目的。比如spew
输出格式的缩进是使用空格的方式,我们可以通过自定义的方式,换成\t
。
package main import ( "github.com/davecgh/go-spew/spew" ) func main() { spew.Config.Indent = "\t" spew.Dump(spew.Config) }
运行查看输出结果,可以看到换行的缩进已经被\t
替代.
(spew.ConfigState) { Indent: (string) (len=1) "\t", MaxDepth: (int) 0, DisableMethods: (bool) false, DisablePointerMethods: (bool) false, DisablePointerAddresses: (bool) false, DisableCapacities: (bool) false, ContinueOnMethod: (bool) false, SortKeys: (bool) false, SpewKeys: (bool) false }
此外,比较有用的配置还有MaxDepth
,这个代表默认输出的结构体的最大深度,比如有些结构的字段也是结构体,这样层层嵌套,是有很多层的,有时候我们不需要输出太多层,那么就可以通过MaxDepth
来定义,它的值默认是0,代表不限制,层级全部输出。
从上面的输出可以看到,spew.Config
其实是一个 spew.ConfigState
,它是一个结构体。
type ConfigState struct { Indent string MaxDepth int
DisableMethods bool DisablePointerMethods bool DisablePointerAddresses bool DisableCapacities bool ContinueOnMethod bool SortKeys bool SpewKeys bool }
可以看到,它提供了很多配置