大家好喉童,我叫謝偉侄泽,是一名程序員。
近期我會持續(xù)更新內(nèi)置庫的學(xué)習(xí)筆記正勒,主要參考的是文檔 godoc 和 內(nèi)置庫的源碼
在日常開發(fā)過程中得院,使用最頻繁的當(dāng)然是內(nèi)置庫,無數(shù)的開源項(xiàng)目昭齐,無不是在內(nèi)置庫的基礎(chǔ)之上進(jìn)行衍生尿招、開發(fā),所以其實(shí)是有很大的必要進(jìn)行梳理學(xué)習(xí)阱驾。
本節(jié)的主題:內(nèi)置庫 json
大綱:
- 自己總結(jié)的使用方法
- 官方支持的API
- 學(xué)到了什么
自己總結(jié)的用法
既然是 json 操作就谜,那么核心應(yīng)該是包括兩個方面:
- 序列化:go 數(shù)據(jù)類型轉(zhuǎn)換為 json
- 反序列化:json 轉(zhuǎn)換為 go 數(shù)據(jù)類型
對應(yīng)的方法:
func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
func Unmarshal(data []byte, v interface{}) error
具體如何使用呢?
布爾類型
func boolToJson(ok bool) []byte {
jsonResult, _ := json.Marshal(ok)
return jsonResult
}
func jsonToBool(value []byte) bool {
var goResult bool
json.Unmarshal(value, &goResult)
return goResult
}
func main(){
fmt.Println(string(boolToJson(1 == 1)))
fmt.Println(jsonToBool([]byte(`true`)))
}
>>
true
true
數(shù)值型
func intToJson(value int) []byte {
jsonInt, _ := json.Marshal(value)
return jsonInt
}
func main(){
fmt.Println(string(intToJson(12)))
}
>>
12
結(jié)構(gòu)體
結(jié)構(gòu)體 轉(zhuǎn)換為 json
type Info struct {
Name string `json:"name,omitempty"`
Age int `json:"age,string"`
City string `json:"city_shanghai"`
Company string `json:"-"`
}
func (i Info) MarshalOp() []byte {
jsonResult, _ := json.Marshal(i)
return jsonResult
}
func main(){
var info Info
info = Info{
Name: "XieWei",
Age: 100,
City: "shangHai",
Company: "Only Me",
}
fmt.Println(string(info.MarshalOp()))
var otherInfo Info
otherInfo.Name = ""
otherInfo.Age = 20
otherInfo.City = "BeiJing"
otherInfo.Company = "Only You"
fmt.Println(string(otherInfo.MarshalOp()))
}
>>
{"name":"XieWei","age":"100","city_shanghai":"shangHai"}
{"age":"20","city_shanghai":"BeiJing"}
還記得我們之間講的 反射章節(jié) 結(jié)構(gòu)體的 tag 嗎里覆?
- info 結(jié)構(gòu)體的 tag
- omitempty 表示該字段為空時丧荐,不序列化
-
-
表示忽略該字段 - json 內(nèi)定義了該字段序列化時顯示的字段,比如 Name 最后序列化 為 name喧枷;比如 City 最后序列化為 city_shanghai
- json 內(nèi)還可以轉(zhuǎn)換類型虹统,比如 age 原本 int 類型弓坞,最后轉(zhuǎn)化為 string 類型
json 轉(zhuǎn)換為 結(jié)構(gòu)體:
func UnMarshalExample(value []byte) (result Info) {
json.Unmarshal(value, &result)
return result
}
func main(){
fmt.Println(UnMarshalExample([]byte(`{"name":"xieWei", "age": "20", "city_shanghai": "GuangDong"}`)))
}
>>
{xieWei 20 GuangDong }
好,至此车荔,我們常用的 json 操作就這些渡冻,主要兩個方面:Marshal 和 UnMarshal
大概講述了下 結(jié)構(gòu)體的 tag 的作用:
- 比如如何定義字段名稱
- 比如如何忽略字段
- 比如如何更改類型
- 比如如何零值忽略
官方文檔
列舉幾個再常用的:
- func Valid(data []byte) bool
- type Marshaler 接口,可以自己定義序列化的返回值
- type Unmarshaler 接口忧便,可以自己定義反序列化的返回值
Valid
判斷是否是有效的 json 格式的數(shù)據(jù)
func main(){
fmt.Println(json.Valid([]byte(`{"name":1, 2}`)))
}
>>
false
- 表示不是標(biāo)準(zhǔn)的 json 格式的數(shù)據(jù)
Marshaler 接口族吻,需要實(shí)現(xiàn) MarshalJSON 方法
自定義序列化返回值
type Marshaler interface {
MarshalJSON() ([]byte, error)
}
type SelfMarshal struct {
Name string
Age int
City string
}
func (self SelfMarshal) MarshalJSON() ([]byte, error) {
result := fmt.Sprintf("name:--%s,age:--%d,city:--%s", self.Name, self.Age, self.City)
if !json.Valid([]byte(result)) {
fmt.Println("invalid")
return json.Marshal(result)
}
return []byte(result), nil
}
func main(){
var self = SelfMarshal{}
self.Age = 20
self.Name = "XieWei"
self.City = "HangZhou"
selfJsonMarshal, err := json.Marshal(self)
fmt.Println(err, string(selfJsonMarshal))
}
>>
<nil> "name:--XieWei,age:--20,city:--HangZhou"
- 返回了自定義的序列化的格式
type jsonTime time.Time
//實(shí)現(xiàn)它的json序列化方法
func (this jsonTime) MarshalJSON() ([]byte, error) {
var stamp = fmt.Sprintf("\"%s\"", time.Time(this).Format("2006-01-02 15:04:05"))
return []byte(stamp), nil
}
type Test struct {
Date jsonTime `json:"date"`
Name string `json:"name"`
State bool `json:"state"`
}
func main(){
var t = Test{}
t.Date = jsonTime(time.Now())
t.Name = "Hello World"
t.State = true
body, _ := json.Marshal(t)
fmt.Println(string(body))
}
>>
{"date":"2018-11-06 22:23:19","name":"Hello World","state":true}
- 返回了自定義的序列化格式數(shù)據(jù)
總結(jié)
- 友好的 API
- 日常的序列化反序列化,內(nèi)置的庫其實(shí)已經(jīng)滿足要求珠增,但是對于復(fù)雜的嵌套的數(shù)據(jù)類型超歌,想要獲取某個字段的值則相當(dāng)費(fèi)勁
- 所以衍生了各種各樣的號稱高性能的 json 解析庫
各 json 解析庫性能比對 | 各 json 解析庫性能比對
收獲:
- 可以自己定義序列化、反序列化的格式
- 可以檢測 是否符合 json 類型
func (self SelfMarshal) MarshalJSON() ([]byte, error) {
result := fmt.Sprintf("name:--%s,age:--%d,city:--%s", self.Name, self.Age, self.City)
return []byte(result), nil
}
上文代碼會報(bào)錯蒂教,為什么巍举?因?yàn)椴皇菢?biāo)準(zhǔn) json 格式的數(shù)據(jù)。
所以通常建議這么做:
func (self SelfMarshal) MarshalJSON() ([]byte, error) {
result := fmt.Sprintf("name:--%s,age:--%d,city:--%s", self.Name, self.Age, self.City)
if !json.Valid([]byte(result)) {
fmt.Println("invalid")
return json.Marshal(result)
}
return []byte(result), nil
}
即將字符串 marshal 處理凝垛。
<完>