共计 3017 个字符,预计需要花费 8 分钟才能阅读完成。
导读 | 在 Golang 语言开发中,我们经常会使用结构体类型,如果我们使用的结构体类型的变量包含指针类型的字段,我们在记录日志的时候,指针类型的字段的值是指针地址,将会给我们 debug 代码造成不便 |
在 Golang 中有原生的 fmt 格式化工具去打印结构体,可以通过占位符 %v、%+v、%#v 去实现,这 3 种的区别如下所示:
type User struct {
Name string
Age int
}
func main() {
user := User{
Name: "张三",
Age: 95,
}
fmt.Printf("%v\n", user)
fmt.Printf("%+v\n", user)
fmt.Printf("%#v\n", user)
}
打印结果如下所示:
{张三 95}
{Name: 张三 Age:95}
main.User{Name:"张三", Age:95}
其中的区别:
当结构体中的字段是指针类型时,用占位符直接打印出来的是怎样的呢?
还是以前面的例子为基础,我们给“张三”加一条狗,其中 User 结构体中引入的 Dog 是指针类型,代码如下:
type Dog struct {
Name string
Age int
}
type User struct {
Name string
Age int
Dog *Dog
}
func main() {
dog := Dog{
Name: "旺财",
Age: 2,
}
user := User{
Name: "张三",
Age: 95,
Dog: &dog,
}
fmt.Println(user)
fmt.Printf("%v\n", user)
fmt.Printf("%+v\n", user)
fmt.Printf("%#v\n", user)
}
这时还能把所有值打印出来吗?
{张三 95 0xc000004078}
{Name: 张三 Age:95 Dog:0xc000004078}
main.User{Name:"张三", Age:95, Dog:(*main.Dog)(0xc000004078)}
这时可以看到 Dog 字段打印的不是 Dog 结构体内部的值,而是一个地址值。很显然,这个不是我们需要在日志中看到的,我们需要看的是结构体具体的值,那这个值又怎么打印呢?
实现 String() 或 GoString() 方法
Golang 中的 fmt 包中有一个 Stringer 接口,接口中只有一个 String() 方法
// Stringer is implemented by any value that has a String method,
// which defines the ``native'' format for that value.
// The String method is used to print values passed as an operand
// to any format that accepts a string or to an unformatted printer
// such as Print.
type Stringer interface {String() string
}
我们可以让 User 和 Dog 结构体分别实现 String() 方法,这种方法类似于 Java 中的 toString() 方法。基于前面的代码,我们增加如下 String() 方法实现:
func (d *Dog) String() string {return "{\"name"+"\": \"" + d.Name + "\","+"\""+"age\": \"" + strconv.Itoa(d.Age) + "\"}"
}
func (u *User) String() string {return "{\"name"+"\": \"" + u.Name + "\", \""+"age\": \"" + strconv.Itoa(u.Age) + "\", \"dog\": "+ u.Dog.String() +"}"
}
运行后,打印的结果如下所示:
{张三 95 {"name": "旺财","age": "2"}}
{Name: 张三 Age:95 Dog:{"name": "旺财","age": "2"}}
main.User{Name:"张三", Age:95, Dog:(*main.Dog)(0xc000004078)}
发现,实现 String() 方法只对 %v 和 %+v 占位符有效,对于 %#v 占位符,其打印的结构体指针类型还是一个地址值。
其实在 fmt 包中,Stringer 接口 下面,我们还可以看到另外一个 GoStringer 接口:
// GoStringer is implemented by any value that has a GoString method,
// which defines the Go syntax for that value.
// The GoString method is used to print values passed as an operand
// to a %#v format.
type GoStringer interface {GoString() string
}
The GoString method is used to print values passed as an operand to a %#v format. (GoString 方法用于打印作为操作数传递给 %#v 格式的值)
找到了,我们再实现 GoString() 方法,就可以用 %#v 占位符打印结构体指针类型中的值了。
基于之前代码增加如下代码:
func (d *Dog) GoString() string {return "{\"name"+"\": \"" + d.Name + "\","+"\""+"age\": \"" + strconv.Itoa(d.Age) + "\"}"
}
func (u *User) GoString() string {return "{\"name"+"\": \"" + u.Name + "\", \""+"age\": \"" + strconv.Itoa(u.Age) + "\", \"dog\": "+ u.Dog.String() +"}"
}
运行后,打印结果如下所示,这下子就都可以打印了:
{张三 95 {"name": "旺财","age": "2"}}
{Name: 张三 Age:95 Dog:{"name": "旺财","age": "2"}}
main.User{Name:"张三", Age:95, Dog:{"name": "旺财","age": "2"}}
到这里,我感觉这种方案有点麻烦呢,还有没有其他不用维护 String() 或 GoString() 的方法呢?
转换成 json 格式
func main() {
dog := Dog{
Name: "旺财",
Age: 2,
}
user := User{
Name: "张三",
Age: 95,
Dog: &dog,
}
byteUser, _ := json.Marshal(&user)
fmt.Println(string(byteUser))
}
打印结果如下所示,如果使用 json 库的话,是可以直接把结构体指针类型的具体值都打印出来的,比较方便:
{"Name":"张三","Age":95,"Dog":{"Name":"旺财","Age":2}}
到此这篇关于 Golang 打印复杂结构体两种方法详解的文章就介绍到这了
![post-qrcode](https://www.xgss.net/wp-content/uploads/2023/07/二维码-微信公众号256x256.jpg)