從一個(gè)例子說起
我們經(jīng)常會碰到下面格式的struct定義:
type Person struct {
Name string `json:"name"`
Age int `json:"age"`
}
這個(gè)struct定義一個(gè)叫做Person的類型,包含兩個(gè)域Name和Age;但是在域的后面有神奇的 json:"name" ,這個(gè)用來干什么用?這篇文章試圖來解釋這個(gè)問題。
當(dāng)golang的對象需要和json做轉(zhuǎn)換的時(shí)候,我們就經(jīng)常用到這個(gè)特性。
有兩點(diǎn)注意的地方:
1、如果一個(gè)域不是以大寫字母開頭的,那么轉(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以小寫字母開頭。
2、如果沒有使用 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" 格式串是用來指導(dǎo)json.Marshal/Unmarshal,在進(jìn)行json串和golang對象之間轉(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è)奇葩的映射,沒有任何正向意義,只有負(fù)向意義,只是為了說明可以進(jìn)行任何名字映射而已。
如果我們?nèi)タ磈son包的源代碼,我可以看到在encoding/json/encode.go, encoding/json/decode.go里面有讀取tag值得相關(guān)代碼。
tag := sf.Tag.Get("json")
也就是說這個(gè)json的tag是被json.Marshal和json.Unmarshal來使用的。
我們?nèi)绾问褂胻ag
還是以前的例子,Person有一個(gè)域Age,我們能不能限定Age的值在1-100之間,不至于太大,否則這個(gè)值沒有意義了。
$ 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ò)展對任意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,那么就會驗(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
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
您可能感興趣的文章:- golang語言如何將interface轉(zhuǎn)為int, string,slice,struct等類型
- Golang 如何解析和生成json
- golang使用json格式實(shí)現(xiàn)增刪查改的實(shí)現(xiàn)示例
- golang json.Marshal 特殊html字符被轉(zhuǎn)義的解決方法
- golang 實(shí)現(xiàn)struct、json、map互相轉(zhuǎn)化