通过经常通过调试的方式查找问题的原因,解决问题,尤其是当遇到一个很棘手的问题的时候,就需要知道一段代码在执行的过程中,其上下文的变量对应的数据,以便进行推测出问题的原因。
对于这类调试,我们用的比较多的一个是断点调试,还有是通过打印日志输出。通过日志打印的话,可能一开始常用的就是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可以帮助Golang开发者打印数据的结构,并且以一种比较易读的方式,让开发者,可以看到一个变量的数据结构信息。
go get -u github.com/davecgh/go-spew/spew
package main
import (
"fmt"
"github.com/davecgh/go-spew/spew"
"log"
)
func main() {
i := 0
s := "大大"
fmt.Println(i,s)
log.Println(i,s)
fmt.Println("-----------------")
spew.Dump(i,s)
}
多加了一个map,一个error接口,还有一个自定义的struct,我们同样运行看看打印的输出结果
package main
import (
"errors"
"github.com/davecgh/go-spew/spew"
)
type person struct {
Name string
}
func main() {
i := 0
s := "大大"
//fmt.Println(i,s)
//log.Println(i,s)
m := map[int]string{1:"1",2:"2"}
e := errors.New("错误")
p := person{Name:"张三"}
spew.Dump(i,s,m,e,p)
}
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"
"fmt"
"github.com/davecgh/go-spew/spew"
)
type person struct {
Name string
}
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)
fmt.Println("---------------------")
spew.Dump(s)
fmt.Println("---------------------")
spew.Printf("%v\n", e)
spew.Printf("%+v\n", e)
spew.Printf("%#v\n", e)
spew.Printf("%#+v\n", e)
fmt.Println("---------------------")
spew.Dump(e)
fmt.Println("---------------------")
}
通过上面的例子,演示下Printf系列函数和Dump系列函数的不同。
上面的例子中,我们使用一个字符串s,一个error类型的错误来演示。运行输出看结果。
对于字符串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.Dump(spew.Config)
spew.Config.Indent = "\t"
spew.Dump(spew.Config)
}
运行查看输出结果,可以看到换行的缩进已经被\t
替代.
此外,比较有用的配置还有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
}
可以看到,它提供了很多配置。
package main
import "github.com/davecgh/go-spew/spew"
func main() {
spew.Dump(spew.Config)
spew.Config.Indent = "\t"
spew.Config.MaxDepth = 1
spew.Dump(spew.Config)
}
Demo:
package main
import (
"github.com/davecgh/go-spew/spew"
)
type Person struct {
name string
score Score
}
type Score struct {
chinese int
teach Teacher
}
type Teacher struct {
name string
}
func main() {
person := Person{
name: "小羊",
score: Score{
chinese: 88,
teach: Teacher{name: "老师"},
},
}
spew.Dump(person)
spew.Config.Indent = "\t"
spew.Config.MaxDepth = 0
spew.Dump(person)
spew.Config.MaxDepth = 1
spew.Dump(person)
spew.Config.MaxDepth = 2
spew.Dump(person)
spew.Config.MaxDepth = 3
spew.Dump(person)
}