golang中json操作的完全指南

2022-07-14 14:00:08

前言

JSON是一種輕量級的資料交換格式。易於閱讀和編寫。 golang 提供了 encoding/json 包來操作JSON資料。

1. 結構體與JSON互轉

（1）使用 json.Marshal() 方法，把結構體轉成 JSON字串

import (
	"encoding/json"
	"fmt"
)

type Student struct {
	Name string
	Age int
	Skill string
}

func main()  {
	stu := Student{"tom", 12, "football"}
	data, err := json.Marshal(&stu)
	if err != nil {
		fmt.Printf("序列化錯誤 err=%vn", err)
		return
	}
	fmt.Println("序列化後: ", string(data))
}

列印：序列化後: {“Name”:“tom”,“Age”:12,“Skill”:“football”}

（2）JSON字串轉結構體，可以使用 json.Unmarshal()方法

func main()  {
	str := `{"Name":"tom","Age":12,"Skill":"football"}`
	var stu2 Student
	err := json.Unmarshal([]byte(str), &stu2)
	if err != nil {
		fmt.Printf("反序列化錯誤 err=%vn", err)
		return
	}
	fmt.Printf("反序列化後: Student=%v, Name=%vn", stu2, stu2.Name)
}

列印: 反序列化後: Student={tom 12 football}, Name=tom

（3）如何實現結構體序列化後key的名稱能自定義

對於自定義key的名稱，可以給 struct變數指定一個tag標籤

type Student struct {
	Name string   `json:"stu_name"`
	Age int       `json:"stu_age"`
	Skill string  // 也可以不指定 tag標籤，預設就是 變數名稱
}

func main()  {
	stu := Student{"tom", 12, "football"}
	data, err := json.Marshal(&stu)
	if err != nil {
		fmt.Printf("序列化錯誤 err=%vn", err)
		return
	}
	fmt.Println("序列化後: ", string(data))
}

列印後，可以看到 key的名稱已經變成了我們指定的 tag標籤的名稱

序列化後: {“stu_name”:“tom”,“stu_age”:12,“Skill”:“football”}

2. map與JSON互轉

func main()  {
	// map 轉 Json字串
	m := make(map[string]interface{})
	m["name"] = "jetty"
	m["age"] = 16

	data, err := json.Marshal(&m)
	if err != nil {
		fmt.Printf("序列化錯誤 err=%vn", err)
		return
	}
	fmt.Println("序列化後: ", string(data))    // 列印: 序列化後:  {"age":16,"name":"jetty"}

	// Json字串 轉 map
	str := `{"age":25,"name":"car"}`
	err = json.Unmarshal([]byte(str), &m)
	if err != nil {
		fmt.Printf("反序列化錯誤 err=%vn", err)
		return
	}
	fmt.Printf("反序列化後: map=%v, name=%vn", m, m["name"])
	// 列印: 反序列化後: map=map[age:25 name:car], name=car
}

3. 結構體的變數不加tag標籤能否正常轉成json資料

如果變數首字母小寫，則為private。因為取不到反射資訊，不能轉。

如果變數首字母大寫，則為public。不管加不加 tag 都能正常轉，加了tag的變數就按照tag的名稱顯示。

範例：

type User struct {
	Name string    `json:"u_name"`
	age int        `json:"u_age"`
	Skill string   // 也可以不指定 tag標籤，預設就是 變數名稱
	addr string
}

func main()  {
	user := User{"admin", 23, "football", "上海"}
	data, err := json.Marshal(&user)
	if err != nil {
		fmt.Printf("序列化錯誤 err=%vn", err)
		return
	}
	fmt.Println("序列化後: ", string(data))  // 列印: 序列化後:  {"u_name":"admin","Skill":"football"}
}

通過列印，我們發現小寫的變數，如 age、addr 都沒有轉成 json資料。

總結：

首字母小寫的不管加不加tag都不能轉為json資料，而大寫的加了tag可以取別名，不加tag則json內的欄位跟結構體變數原名一致

4. JSON操作的一些小技巧

（1）忽略掉 struct 指定欄位

type User struct {
	Name string    `json:"u_name"`
	Password string `json:"password"`
	Email string `json:"email"`
}

func main()  {
	user := User{"admin", "pwd", "user@163.com"}
	person := Person{23, "上海"}
	// 忽略掉 Password 欄位
	data, _ := json.Marshal(struct {
		*User
		Password string `json:"password,omitempty"`
	}{User: &user})
	fmt.Println("忽略欄位: ", string(data))  // 列印: 忽略欄位: {"u_name":"admin","email":"user@163.com"}
}

忽略欄位: {“u_name”:“admin”,“email”:“user@163.com”}}

（2）新增額外的欄位

data, _ = json.Marshal(struct {
	*User
	Skill string `json:"skill"`  // 臨時新增額外的 Skill欄位
}{
	User: &user,
	Skill: "football",
})

fmt.Println("新增額外欄位: ", string(data))

新增額外欄位: {“u_name”:“admin”,“password”:“pwd”,“email”:“user@163.com”,“skill”:“football”}

（3）合併兩個 struct

type User struct {
	Name string    `json:"u_name"`
	Password string `json:"password"`
	Email string `json:"email"`
}

type Person struct {
	Age int
	Addr string `json:"addr"`
}

func main()  {
    // 初始化兩個 struct
	user := User{"admin", "pwd", "user@163.com"}
	person := Person{23, "上海"}
	
	data, _ := json.Marshal(struct {
		*User
		*Person
	}{
		User: &user,
		Person: &person,
	})
	
	fmt.Println("合併兩個struct: ", string(data))
}

合併兩個struct: {“u_name”:“admin”,“password”:“pwd”,“email”:“user@163.com”,“Age”:23,“addr”:“上海”}

（4）字串傳遞給 int型別

emp := struct {                    // 建立匿名 struct
	Num int `json:"num,string"`
}{15,}
data, _ := json.Marshal(&emp)
fmt.Println("數位轉成字串: ", string(data))       // 數位轉成字串: {"num":"15"}

str := `{"Num":"25"}`
_ = json.Unmarshal([]byte(str), &emp)
fmt.Printf("字串轉成數位: Emp.Num=%vn", emp.Num) // 字串轉成數位: Emp.Num=25

（5）一個 json 分成兩個struct

str = ` {"u_name":"system","password":"abc","email":"user2@163.com","Age":23,"addr":"杭州"}`
var user2 User
var person2 Person
_ := json.Unmarshal([]byte(str), &struct {
	*User
	*Person
}{
	User: &user2,
	Person: &person2,
})

fmt.Printf("分成兩個struct: User=%v, Person=%vn", user2, person2)

分成兩個struct: User={system abc user2@163.com}, Person={23 杭州}

補充：GoLang json格式化輸出

簡單記錄一下go語言json格式化輸出的辦法

import (
    "bytes"
    "encoding/json"
    "fmt"
    "os"
)

type Complex_Type struct{
    Age int `json:"age"`
    Name string `json:"name"`
    Grades map[string]int `json:"grade"`
    Parents []string `json:"parents"`
}

    grades := map[string]int{
        "math" : 96,
        "chinese" : 87,
        "english" : 93,
    }

    parents := []string{
        "minato",
        "kushina",
    }

    complex_type := Complex_Type{
        Age: 18,
        Name: "Naruto",
        Grades : grades,
        Parents: parents,
    }
    res,err := json.Marshal(complex_type)
    exitOnError(err)
    var out bytes.Buffer
    err = json.Indent(&out,res,"","t")
    out.WriteTo(os.Stdout)
    fmt.Printf("n")

輸出：