簡單介紹Golang列印複雜結構體的兩種方法

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

其中的區別：

• %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列印複雜結構體兩種方法詳解的文章就介紹到這了

原文來自：