快捷導航

Golang打印復雜結(jié)構(gòu)體兩種方法詳解

更新時間：2022年10月25日 10:13:57 作者：焦糖星冰樂吧

在?Golang?語言開發(fā)中，我們經(jīng)常會使用結(jié)構(gòu)體類型，如果我們使用的結(jié)構(gòu)體類型的變量包含指針類型的字段，我們在記錄日志的時候，指針類型的字段的值是指針地址，將會給我們?debug?代碼造成不便

fmt結(jié)構(gòu)體占位符

在Golang中有原生的 fmt 格式化工具去打印結(jié)構(gòu)體，可以通過占位符%v、%+v、%#v去實現(xiàn)，這3種的區(qū)別如下所示：

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

打印結(jié)果如下所示：

{張三 95}
{Name:張三 Age:95}
main.User{Name:"張三", Age:95}

其中的區(qū)別：

%v占位符是不會打印結(jié)構(gòu)體字段名稱的，字段之間以空格隔開；
%+v占位符會打印字段名稱，字段之間也是以空格隔開；
%#v占位符則會打印結(jié)構(gòu)體類型和字段名稱，字段之間以逗號分隔

打印復雜結(jié)構(gòu)體

當結(jié)構(gòu)體中的字段是指針類型時，用占位符直接打印出來的是怎樣的呢？

還是以前面的例子為基礎(chǔ)，我們給“張三”加一條狗，其中 User 結(jié)構(gòu)體中引入的 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結(jié)構(gòu)體內(nèi)部的值，而是一個地址值。很顯然，這個不是我們需要在日志中看到的，我們需要看的是結(jié)構(gòu)體具體的值，那這個值又怎么打印呢？

方案一

實現(xiàn) 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 結(jié)構(gòu)體分別實現(xiàn) String() 方法，這種方法類似于 Java 中的 toString() 方法。基于前面的代碼，我們增加如下 String() 方法實現(xiàn)：

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

運行后，打印的結(jié)果如下所示：

{張三 95 {"name": "旺財","age": "2"}}
{Name:張三 Age:95 Dog:{"name": "旺財","age": "2"}}
main.User{Name:"張三", Age:95, Dog:(*main.Dog)(0xc000004078)}

發(fā)現(xiàn)，實現(xiàn) String() 方法只對 %v 和 %+v 占位符有效，對于%#v 占位符，其打印的結(jié)構(gòu)體指針類型還是一個地址值。

其實在 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 方法用于打印作為操作數(shù)傳遞給 %#v 格式的值)

找到了，我們再實現(xiàn) GoString() 方法，就可以用 %#v 占位符打印結(jié)構(gòu)體指針類型中的值了。

基于之前代碼增加如下代碼：

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

運行后，打印結(jié)果如下所示，這下子就都可以打印了：

{張三 95 {"name": "旺財","age": "2"}}
{Name:張三 Age:95 Dog:{"name": "旺財","age": "2"}}
main.User{Name:"張三", Age:95, Dog:{"name": "旺財","age": "2"}}

到這里，我感覺這種方案有點麻煩呢，還有沒有其他不用維護 String() 或 GoString() 的方法呢？

方案二

轉(zhuǎn)換成 json 格式

func main() {
	dog := Dog{
		Name: "旺財",
		Age:  2,
	}
	user := User{
		Name: "張三",
		Age:  95,
		Dog:  &dog,
	}
	byteUser, _ := json.Marshal(&user)
	fmt.Println(string(byteUser))
}

打印結(jié)果如下所示，如果使用 json 庫的話，是可以直接把結(jié)構(gòu)體指針類型的具體值都打印出來的，比較方便：