golang如何使用struct的tag属性的详细介绍
从一个例子说起
我们经常会碰到下面格式的struct定义:
typePersonstruct{
Namestring`json:"name"`
Ageint`json:"age"`
}
这个struct定义一个叫做Person的类型,包含两个域Name和Age;但是在域的后面有神奇的json:"name",这个用来干什么用?这篇文章试图来解释这个问题。
当golang的对象需要和json做转换的时候,我们就经常用到这个特性。
有两点注意的地方:
1、如果一个域不是以大写字母开头的,那么转换成json的时候,这个域是被忽略的。
$catmain.go
packagemain
import(
"fmt"
"encoding/json"
)
typePersonstruct{
Namestring`json:"name"`
ageint`json:"age"`
}
funcmain(){
person:=Person{"tom",12}
ifb,err:=json.Marshal(person);err!=nil{
fmt.Printf("error:%s",err.Error())
}else{
fmt.Printf("value:%s",b)
}
}
$gobuild-omainmain.go
$./main
value:{"name":"tom"}
我们看到转换成json串之后,name正常输出了,而age被丢弃了,因为age以小写字母开头。
2、如果没有使用json:"name"tag,那么输出的json字段名和域名是一样的。
$catmain.go
packagemain
import(
"fmt"
"encoding/json"
)
typePersonstruct{
Namestring
Ageint
}
funcmain(){
person:=Person{"tom",12}
ifb,err:=json.Marshal(person);err!=nil{
fmt.Printf("error:%s",err.Error())
}else{
fmt.Printf("value:%s",b)
}
}
$gobuild-omainmain.go
$./main
value:{"Name":"tom","Age":12}
我们看到输出的json串使用的是struct定义的字段名。
总结一下,json:"name"格式串是用来指导json.Marshal/Unmarshal,在进行json串和golang对象之间转换的时候映射字段名使用的。再举一个例子,json串和golang域名字可以任意转换:
$catmain.go
packagemain
import(
"fmt"
"encoding/json"
)
typePersonstruct{
Namestring`json:"age"`
Ageint`json:"address"`
}
funcmain(){
person:=Person{"tom",12}
ifb,err:=json.Marshal(person);err!=nil{
fmt.Printf("error:%s",err.Error())
}else{
fmt.Printf("value:%s",b)
}
}
$gobuild-omainmain.go
$./main
value:{"age":"tom","address":12}
这个例子我们把Name映射成了age,而把Age映射成address,当然这是个奇葩的映射,没有任何正向意义,只有负向意义,只是为了说明可以进行任何名字映射而已。
如果我们去看json包的源代码,我可以看到在encoding/json/encode.go,encoding/json/decode.go里面有读取tag值得相关代码。
tag:=sf.Tag.Get("json")
也就是说这个json的tag是被json.Marshal和json.Unmarshal来使用的。
我们如何使用tag
还是以前的例子,Person有一个域Age,我们能不能限定Age的值在1-100之间,不至于太大,否则这个值没有意义了。
$catmain.go
packagemain
import(
"fmt"
"strings"
"strconv"
"reflect"
_"encoding/json"
)
typePersonstruct{
Namestring`json:"name"`
Ageint`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,"-")
varmin,maxint
min,_=strconv.Atoi(result[0])
max,_=strconv.Atoi(result[1])
ifval>=min&&val<=max{
returntrue
}else{
returnfalse
}
}
funcmain(){
person1:=Person{"tom",12}
ifperson1.validation(){
fmt.Printf("person1:valid\n")
}else{
fmt.Printf("person1:invalid\n")
}
person2:=Person{"tom",250}
ifperson2.validation(){
fmt.Printf("person2valid\n")
}else{
fmt.Printf("person2invalid\n")
}
}
这么例子我们给Person添加了一个validate函数,validate验证age是不是合理。
这个函数可以扩展对任意struct的任意valid域进行验证。
$catmain.go
packagemain
import(
"fmt"
"strings"
"strconv"
"reflect"
_"encoding/json"
)
typePersonstruct{
Namestring`json:"name"`
Ageint`json:"age"valid:"1-100"`
}
typeOtherStructstruct{
Ageint`valid:"20-300"`
}
funcvalidateStruct(sinterface{})bool{
v:=reflect.ValueOf(s)
fori:=0;i=min&&val<=max{
returntrue
}else{
returnfalse
}
}
}
returntrue
}
funcmain(){
person1:=Person{"tom",12}
ifvalidateStruct(person1){
fmt.Printf("person1:valid\n")
}else{
fmt.Printf("person1:invalid\n")
}
person2:=Person{"jerry",250}
ifvalidateStruct(person2){
fmt.Printf("person2:valid\n")
}else{
fmt.Printf("person2:invalid\n")
}
other1:=OtherStruct{12}
ifvalidateStruct(other1){
fmt.Printf("other1:valid\n")
}else{
fmt.Printf("other1:invalid\n")
}
other2:=OtherStruct{250}
ifvalidateStruct(other2){
fmt.Printf("other2:valid\n")
}else{
fmt.Printf("other2:invalid\n")
}
}
在这个例子中我们定义了一个函数validateStruct,接受任意一个struct作为参数;validateStruct为验证struct中所有定义的Age字段,如果字段名字是Age,字段类型是int,并且定义了validtag,那么就会验证这个valid是否有效。
看执行结果:
$gobuild-omainmain.go
$./main
person1:valid
person2:invalid
other1:invalid
other2:valid
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。