Golang 打印结构体完整值：fmt 占位符与 JSON 转换详解

原生 fmt 格式化的局限性

Golang 提供了原生的 fmt 包来处理数据的格式化输出。对于普通的结构体，我们可以利用以下几种常见的占位符：

• %v：只打印字段的值，以空格分隔。
  
• %+v：打印字段的名称以及对应的值。
  
• %#v：打印完整的变量类型声明及对应的值。

对于简单的结构体，它们工作得非常好：

type User struct {
    Name string
    Age  int
}

func main() {
    user := User{Name: "张三", Age: 95}
    fmt.Printf("%v\n", user)\t// {张三 95}
    fmt.Printf("%+v\n", user)	// {Name:张三 Age:95}
    fmt.Printf("%#v\n", user)\t// main.User{Name:"张三", Age:95}

第1步：引入指针类型时的异常表现

当结构体中包含另一个结构体的指针类型时，直接使用上述占位符会导致内嵌结构体的数据无法被正确解析展示，取而代之的是其内存地址。

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.Printf("%+v\n", user) 	// {Name:张三 Age:95 Dog:0xc0000140a0}
    fmt.Printf("%#v\n", user)	// ... Dog:(*main.Dog)(0xc0000140a0)

可以看到，Dog 字段仅输出了像 0xc0000140a0 这样的十六进制内存地址。这在编写日志或调试代码时是非常不友好的，因为我们需要知道的是该狗的具体名字和年龄。

方案一：实现 Stringer 与 GoStringer 接口

为了解决指针类型的自动格式化问题，Golang 的 fmt 包引入了两个关键接口：fmt.Stringer 和 fmt.GoStringer。任何实现了这些接口的类型，都会在特定的占位符下触发对应方法的调用。

第2步：实现 Stringer 接口解决 %v 和 %+v

fmt.Stringer 接口定义了一个 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() + "}"
}

此时再次运行代码：

fmt.Printf("%v\n", user)   // {张三 95 {...}} - Dog显示为字符串化结果

但值得注意的是，这并不会改变 %#v 的行为，因为 %#v 走的是另一条逻辑路径，仍然会显示内存地址。

第3步：实现 GoStringer 接口完善 %#v 补全

为了让所有占位符都能显示内部真实数据，我们需要给结构体实现 fmt.GoStringer 接口中的 GoString() 方法：

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.GoString() + "}"
}

这样一来，无论是 %v、%+v 还是 %#v，都会按照我们自定义的字符串格式进行输出，彻底解决了地址值干扰的问题。

方案二：转义为 JSON 字符串输出

如果觉得手动逐个为每个嵌套结构体编写 String() 和 GoString() 太繁琐，尤其是在大型项目中维护成本过高，可以使用一种更加简洁且通用的办法：将其序列化为 JSON。

第4步：使用标准库 json 获取结构体明文

利用 encoding/json 包中的 Marshal 函数，可以直接将内存中的对象转为字节切片，随后转换为字符串打印：

byteUser, _ := json.Marshal(&user)
fmt.Println(string(byteUser))

最终输出的结果为：

{"Name":"张三","Age":95,"Dog":{"Name":"旺财","Age":2}}

这种方式的优点在于无需修改原结构体定义，也不受指针指向的影响，它能递归地将整个嵌套树状结构展开并呈现出具体的字段值。同时，它生成的内容是标准的 JSON 格式，非常适合在日志系统或 API 响应中进行直接查看。

简要总结

以上两种方法可以分别应对不同场景下的需求。如果追求控制底层细节或者需要对个别复杂类型做特殊展示，推荐使用实现 Stringer 接口的方案一；而如果是为了快速调试或在宏观层面查看整个对象状态，通过 json.Marshal 生成字符串的方案二往往更加省时省力且不易出错。

以上就是Golang打印复杂结构体的详细内容，更多关于Go结构体格式化打印的资料请关注本站其它相关文章！