Golang打印复杂结构体两种方法详解

更新时间：2022年10月25日 10:13:57 作者：焦糖星冰乐吧

在 Golang 语言开发中，我们经常会使用结构体类型，如果我们使用的结构体类型的变量包含指针类型的字段，我们在记录日志的时候，指针类型的字段的值是指针地址，将会给我们 debug 代码造成不便

fmt结构体占位符

在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}

其中的区别：

%v占位符是不会打印结构体字段名称的，字段之间以空格隔开；
%+v占位符会打印字段名称，字段之间也是以空格隔开；
%#v占位符则会打印结构体类型和字段名称，字段之间以逗号分隔

打印复杂结构体

当结构体中的字段是指针类型时，用占位符直接打印出来的是怎样的呢？

还是以前面的例子为基础，我们给“张三”加一条狗，其中 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打印复杂结构体两种方法详解的文章就介绍到这了,更多相关Go打印复杂结构体内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Golang Gorm实现自定义多态模型关联查询
GORM 是一个流行的开源 ORM (Object-Relational Mapping) 库,专为 Go 语言设计,它简化了与 SQL 数据库的交互,GORM 封装了数据库操作,使得开发者能够通过简单的链式调用来执行 CRUD,本文给大家介绍了Golang Gorm实现自定义多态模型关联查询,需要的朋友可以参考下
2024-11-11
Go每日一库之quicktemplate的使用
quicktemplate快速、功能强大、易于使用的Go模板引擎。比html/模板快20倍，本文我们就详细的介绍一下quicktemplate的具体使用，感兴趣的可以了解一下
2021-07-07
Linux环境下编译并运行go项目的全过程
Go语言是Google的开源编程语言,广泛应用于云计算、分布式系统开发等领域,在Linux上也有大量的应用场景,这篇文章主要给大家介绍了关于Linux环境下编译并运行go项目的相关资料,需要的朋友可以参考下
2023-11-11
go程序测试CPU占用率统计ps vs top两种不同方式对比
这篇文章主要为大家介绍了go程序测试CPU占用率统计ps vs top两种不同方式对比，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
Go语言集成mysql驱动、调用数据库、查询数据操作示例
这篇文章主要介绍了Go语言集成mysql驱动、调用数据库、查询数据操作,结合实例形式分析了Go语言安装mysql驱动包、连接mysql数据库及查询等相关操作技巧,需要的朋友可以参考下
2019-06-06
Go语言interface 与 nil 的比较
在golang中，nil只能赋值给指针、channel、func、interface、map或slice类型的变量。如果未遵循这个规则，则会引发panic。
2017-08-08
golang gorm 操作mysql及gorm基本用法
golang 官方的那个操作mysql的有点麻烦所以就使用了gorm，下面就gorm的使用做下简单介绍，感兴趣的朋友跟随小编一起看看吧
2018-11-11
Go mod包管理工具详解
Go mod作为Go语言的官方包管理工具，可以帮助开发者更好地管理包和依赖，提高开发效率和项目可维护性，本文将介绍Go语言的包和依赖管理，以及Go mod的作用和优势，需要的朋友可以参考下
2023-05-05
Go获取与设置环境变量的方法详解
go环境变量的配置其实说真的说难也难,说不难也不难,只要配置成功过一次以后后面都很简单,但是最好是要做好笔记,这篇文章主要给大家介绍了关于Go获取与设置环境变量的相关资料,需要的朋友可以参考下
2021-11-11
Mac下Vs code配置Go语言环境的详细过程
这篇文章给大家介绍Mac下Vs code配置Go语言环境的详细过程，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧
2021-07-07