golang如何使用struct的tag屬性的詳細(xì)介紹
從一個(gè)例子說(shuō)起
我們經(jīng)常會(huì)碰到下面格式的struct定義:
type Person struct { Name string `json:"name"` Age int `json:"age"` }
這個(gè)struct定義一個(gè)叫做Person的類型,包含兩個(gè)域Name和Age;但是在域的后面有神奇的 json:"name" ,這個(gè)用來(lái)干什么用?這篇文章試圖來(lái)解釋這個(gè)問(wèn)題。
當(dāng)golang的對(duì)象需要和json做轉(zhuǎn)換的時(shí)候,我們就經(jīng)常用到這個(gè)特性。
有兩點(diǎn)注意的地方:
1、如果一個(gè)域不是以大寫(xiě)字母開(kāi)頭的,那么轉(zhuǎn)換成json的時(shí)候,這個(gè)域是被忽略的。
$ cat main.go package main import ( "fmt" "encoding/json" ) type Person struct { Name string `json:"name"` age int `json:"age"` } func main() { person := Person { "tom", 12 } if b, err := json.Marshal(person); err != nil { fmt.Printf("error: %s", err.Error()) } else { fmt.Printf("value: %s", b) } } $ go build -o main main.go $ ./main value: {"name":"tom"}
我們看到轉(zhuǎn)換成json串之后,name正常輸出了,而age被丟棄了,因?yàn)閍ge以小寫(xiě)字母開(kāi)頭。
2、如果沒(méi)有使用 json:"name" tag,那么輸出的json字段名和域名是一樣的。
$ cat main.go package main import ( "fmt" "encoding/json" ) type Person struct { Name string Age int } func main() { person := Person { "tom", 12 } if b, err := json.Marshal(person); err != nil { fmt.Printf("error: %s", err.Error()) } else { fmt.Printf("value: %s", b) } } $ go build -o main main.go $ ./main value: {"Name":"tom","Age":12}
我們看到輸出的json串使用的是struct定義的字段名。
總結(jié)一下, json:"name" 格式串是用來(lái)指導(dǎo)json.Marshal/Unmarshal,在進(jìn)行json串和golang對(duì)象之間轉(zhuǎn)換的時(shí)候映射字段名使用的。再舉一個(gè)例子,json串和golang域名字可以任意轉(zhuǎn)換:
$ cat main.go package main import ( "fmt" "encoding/json" ) type Person struct { Name string `json:"age"` Age int `json:"address"` } func main() { person := Person { "tom", 12 } if b, err := json.Marshal(person); err != nil { fmt.Printf("error: %s", err.Error()) } else { fmt.Printf("value: %s", b) } } $ go build -o main main.go $ ./main value: {"age":"tom","address":12}
這個(gè)例子我們把Name映射成了 age,而把Age映射成address,當(dāng)然這是個(gè)奇葩的映射,沒(méi)有任何正向意義,只有負(fù)向意義,只是為了說(shuō)明可以進(jìn)行任何名字映射而已。
如果我們?nèi)タ磈son包的源代碼,我可以看到在encoding/json/encode.go, encoding/json/decode.go里面有讀取tag值得相關(guān)代碼。
tag := sf.Tag.Get("json")
也就是說(shuō)這個(gè)json的tag是被json.Marshal和json.Unmarshal來(lái)使用的。
我們?nèi)绾问褂胻ag
還是以前的例子,Person有一個(gè)域Age,我們能不能限定Age的值在1-100之間,不至于太大,否則這個(gè)值沒(méi)有意義了。
$ cat main.go package main import ( "fmt" "strings" "strconv" "reflect" _ "encoding/json" ) type Person struct { Name string `json:"name"` Age int `json:"age" valid:"1-100"` } func (p * Person) validation() bool { v := reflect.ValueOf(*p) tag := v.Type().Field(1).Tag.Get("valid") val := v.Field(1).Interface().(int) fmt.Printf("tag=%v, val=%v\n", tag, val) result := strings.Split(tag, "-") var min, max int min, _ = strconv.Atoi(result[0]) max, _ = strconv.Atoi(result[1]) if val >= min && val <= max { return true } else { return false } } func main() { person1 := Person { "tom", 12 } if person1.validation() { fmt.Printf("person 1: valid\n") } else { fmt.Printf("person 1: invalid\n") } person2 := Person { "tom", 250 } if person2.validation() { fmt.Printf("person 2 valid\n") } else { fmt.Printf("person 2 invalid\n") } }
這么例子我們給Person添加了一個(gè)validate函數(shù),validate驗(yàn)證age是不是合理。
這個(gè)函數(shù)可以擴(kuò)展對(duì)任意struct的任意valid域進(jìn)行驗(yàn)證。
$ cat main.go package main import ( "fmt" "strings" "strconv" "reflect" _ "encoding/json" ) type Person struct { Name string `json:"name"` Age int `json:"age" valid:"1-100"` } type OtherStruct struct { Age int `valid:"20-300"` } func validateStruct(s interface{}) bool { v := reflect.ValueOf(s) for i := 0; i < v.NumField(); i++ { fieldTag := v.Type().Field(i).Tag.Get("valid") fieldName := v.Type().Field(i).Name fieldType := v.Field(i).Type() fieldValue := v.Field(i).Interface() if fieldTag == "" || fieldTag == "-" { continue } if fieldName == "Age" && fieldType.String() == "int" { val := fieldValue.(int) tmp := strings.Split(fieldTag, "-") var min, max int min, _ = strconv.Atoi(tmp[0]) max, _ = strconv.Atoi(tmp[1]) if val >= min && val <= max { return true } else { return false } } } return true } func main() { person1 := Person { "tom", 12 } if validateStruct(person1) { fmt.Printf("person 1: valid\n") } else { fmt.Printf("person 1: invalid\n") } person2 := Person { "jerry", 250 } if validateStruct(person2) { fmt.Printf("person 2: valid\n") } else { fmt.Printf("person 2: invalid\n") } other1 := OtherStruct { 12 } if validateStruct(other1) { fmt.Printf("other 1: valid\n") } else { fmt.Printf("other 1: invalid\n") } other2 := OtherStruct { 250 } if validateStruct(other2) { fmt.Printf("other 2: valid\n") } else { fmt.Printf("other 2: invalid\n") } }
在這個(gè)例子中我們定義了一個(gè)函數(shù)validateStruct,接受任意一個(gè)struct作為參數(shù);validateStruct為驗(yàn)證struct中所有定義的Age字段,如果字段名字是Age,字段類型是int,并且定義了valid tag,那么就會(huì)驗(yàn)證這個(gè)valid是否有效。
看執(zhí)行結(jié)果:
$ go build -o main main.go
$ ./main
person 1: valid
person 2: invalid
other 1: invalid
other 2: valid
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Go語(yǔ)言 如何實(shí)現(xiàn)RSA加密解密
這篇文章主要介紹了Go語(yǔ)言實(shí)現(xiàn)RSA加密解密的操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-05-05對(duì)Golang import 導(dǎo)入包語(yǔ)法詳解
今天小編就為大家分享一篇對(duì)Golang import 導(dǎo)入包語(yǔ)法詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2019-06-06Go調(diào)度器學(xué)習(xí)之系統(tǒng)調(diào)用詳解
這篇文章腫,將以一個(gè)簡(jiǎn)單的文件打開(kāi)的系統(tǒng)調(diào)用,來(lái)分析一下Go調(diào)度器在系統(tǒng)調(diào)用時(shí)做了什么。文中的示例代碼講解詳細(xì),需要的可以參考一下2023-04-04Go中string與[]byte高效互轉(zhuǎn)的方法實(shí)例
string與[]byte經(jīng)常需要互相轉(zhuǎn)化,普通轉(zhuǎn)化會(huì)發(fā)生底層數(shù)據(jù)的復(fù)制,下面這篇文章主要給大家介紹了關(guān)于Go中string與[]byte高效互轉(zhuǎn)的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2021-09-09使用Gorm操作Oracle數(shù)據(jù)庫(kù)踩坑記錄
gorm是目前用得最多的go語(yǔ)言orm庫(kù),本文主要介紹了使用Gorm操作Oracle數(shù)據(jù)庫(kù)踩坑記錄,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06go運(yùn)算符對(duì)變量和值執(zhí)行操作示例詳解
這篇文章主要為大家介紹了go運(yùn)算符對(duì)變量和值執(zhí)行操作示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-09-09