GoLang之结构体Tag讲解及规范

已于 2022-03-23 15:53:02 修改
阅读量2.5k 收藏 10
点赞数 3
分类专栏： GoLang 文章标签： 学习 golang 开发语言
于 2022-03-04 13:12:33 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_52690231/article/details/123274409
版权

文章目录

GoLang之结构体Tag讲解及规范

1.Tag介绍

Go语言提供了可通过反射发现的的结构体标签，这些在标准库json/xml中得到了广泛的使用；

orm框架也支持了结构体标签，上面那个例子的使用就是因为encoding/json支持了结构体标签，不过他有自己的标签规则(ORM全称是：Object Relational Mapping(对象关系映射));

像json、yaml、gorm、validate、mapstructure、protobuf这几个库的结构体标签是很常用的，gin框架就集成了validate库用来做参数校验;

Go官方已经帮忙整理了哪些库已经支持了struct tag,具体这些库中是怎么使用的，大家可以看官方文档https://github.com/golang/go/wiki/Well-known-struct-tags 介绍，写的都很详细，具体场景具体用:

TagDocumentation
xmlhttps://godoc.org/encoding/xml
jsonhttps://godoc.org/encoding/json
asn1https://godoc.org/encoding/asn1
reformhttps://godoc.org/gopkg.in/reform.v1
dynamodbhttps://docs.aws.amazon.com/sdk-for-go/api/service/dynamodb/dynamodbattribute/#Marshal
bigqueryhttps://godoc.org/cloud.google.com/go/bigquery
datastorehttps://godoc.org/cloud.google.com/go/datastore
spannerhttps://godoc.org/cloud.google.com/go/spanner
bsonhttps://godoc.org/labix.org/v2/mgo/bson, https://godoc.org/go.mongodb.org/mongo-driver/bson/bsoncodec
gormhttps://godoc.org/github.com/jinzhu/gorm
yamlhttps://godoc.org/gopkg.in/yaml.v2
tomlhttps://godoc.org/github.com/pelletier/go-toml
validatehttps://github.com/go-playground/validator
mapstructurehttps://godoc.org/github.com/mitchellh/mapstructure
parserhttps://godoc.org/github.com/alecthomas/participle
protobufhttps://github.com/golang/protobuf
dbhttps://github.com/jmoiron/sqlx
urlhttps://github.com/google/go-querystring
featurehttps://github.com/nikolaydubina/go-featureprocessing

2.Tag规范

2.1Tag统一规范

不同的库即使标签不一样，不过都有一个统一的总体规则:

(2)结构体标签可以有多个键值对

(2)键与值要用冒号分隔

(3)值要使用双引号括起来

(4)多个键值对之间要使用一个空格分隔，千万不要使用逗号!

`key1:"value1" key2:"value2" key3:"value3"...`  // 键值对用空格分隔

2.2Tag不同库encoding/json规范举例

如果我们想要在一个值中传递多个信息怎么办？不同库中实现的是不一样的，在encoding/json中，多值使用逗号分隔：

`json:"lon,omitempty"`

2.3Tag不同库gorm规范举例

如果我们想要在一个值中传递多个信息怎么办？不同库中实现的是不一样的，在gorm中，多值使用分号分隔：

`gorm:"column:id;primaryKey"

2.4go vet main.go命令

现在大家已经知道什么是结构体标签了，规则还是很规范的，但是很容易出错，因为Go语言在编译阶段并不会对其格式做合法键值对的检查，这样我们不小心写错了，就很难被发现，不过我们有go vet工具做检查，具体使用来看一个例子:

package main

type User struct {
	Name string `abc def ghk`
	Age  uint16 `123: 232`
}

func main() {
}

image-20220304130428513
bad syntax for struct tag pair告诉我们键值对语法错误，bad syntax for struct tag value值语法错误；

所以在我们项目中引入go vet作为CI检查是很有必要的

GoGo在努力
关注
  • 3
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
Golang 解析xml文件标签带冒号( : )解决方案
Standup-jb的博客
10-30 3898
背景：我们有项目需要使用golang语言解析rabbitmq.xml。并把里面的内容解析出来，但是在解析的时候遇到了问题，最后通过google搜索，在stackoverflow上找到了解决方案，目前好像没有中文的解决方案，所以就写下这篇博客，当其他的开发者遇到同样的问题时，可以方便排查，不走弯路。遇到无法解决的问题时请用Google，大概率还是可以找到解决方法的。 一、基础的解析XML方法 假...
golang中的tag标识
weixin_45193103的博客
03-31 2819
1）Tag是Struct的一部分 Tag用于标识结构体字段的额外属性，有点类似于注释。标准库reflect包中提供了操作Tag的方法，在介绍方法前，有必要先了解一下结构体的字段是如何表示的。 在reflect包中，使用结构体structField表示结构体的一个字段: 可以看出，Tag也是字段的一个组成部分。Tag 的类型为structTag，实际上它是一个string类型的别名 type StructField struct { Name string //字段名 Type Type //字段类型
golang如何使用struct的tag属性的详细介绍
09-19
主要介绍了golang如何使用struct的tag属性的详细介绍，从例子说起，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Go最全Golang的Tag语法_golang tag example，成功收获美团、小米Golangoffer
最新发布
2401_84904942的博客
05-16 379
料的朋友，可以添加戳这里获取](https://bbs.csdn.net/topics/618658159)**
Golang中的结构体标签Struct Tag详解
路多辛的所思所想
05-17 1713
在Golang中，结构体标记（Struct Tag），也称为结构体注释（Struct Annotation），是一种对Go结构体中的字段进行元数据附加的机制。这些标记是用反引号(`)包裹起来的键值对，可以在运行时通过反射机制获取并处理。结构体标记使用key:"value"的格式来定义，其中key是标记的名称，value是该标记的值。一个结构体字段可以有多个标记，每个标记之间使用空格分隔。
Golang Gin监听多个端口
热门推荐
稻草人技术博客
02-21 1万+
package main import ( "log" "net/http" "time" "github.com/gin-gonic/gin" "golang.org/x/sync/errgroup" ) var ( g errgroup.Group ) func router01() http.Handle
大家一起学Golang——结构体、方法
01-07
大家一起学Golang——结构体、方法 结构体类型 空结构体 结构体标签 匿名字段 方法 重写 结构体类型 结构体类型通过一系列的且唯一的字段来声明。在go中数组切片只能存储同一类型的数据，但结构体用户可以自定义将...
实例学习Golang–结构体
01-07
// 定义结构体 type StudentMangement struct { name string id string addr string hobby []string } // 构造函数 一般以new开头 // 函数返回结构体指针，可以减少内存开销 func newStudent(name, id, addr ...
golang之两个结构体复制字段
01-08
两个结构体(可能类型一样), 字段名和类型都一样, 想复制一个结构体的全部或者其中某几个字段的值到另一个(即merge操作), 自然想到可以用反射实现. package main import fmt import reflect // 用b的所有字段覆盖a的 ...
golang该如何循环 多层结构体
01-20
一：首先贴代码（你们大概看看就行，在看看后面的数据 你们就能理解 结构体嵌套的案例） 如果是PHP就方便很多，直接数组嵌套数组就行，也就是二维数组。 package model import ( fmt time ) type Find struct { ...
Golang结构体和map
01-07
Golang 文章目录Golang1 struct2 map3 struct补充 1 struct 在Golang中没有对象,但是有面向对象的思想,有继承,多态,封装的思想。 但是缺少了class,而取而代之的是struct(结构体) 下面的是几种结构体的初始化方法4种...
Golang xml 使用
Sun198292的专栏
07-17 1万+
解析和读取规则golang对xml的解析和读取是通过stuct和refect实现的,对于struct中的tag以什么方式对应到xml的元素上,golang的文档中做了如下描述: 结构体中的XMLName字段或者类型为xml.Name的字段,会被删除.使用此字段tag上定义的属性进行解析 结构体tag中”-” 在解析过程中会忽略结构体中的这个字段 结构体t
37. Go 语言中结构体里的 Tag 怎么用？
王炳明
07-24 597
1. 抛砖引玉：什么是 Tag？ 正常情况下，你定义的结构体是这样子的，每个字段都由名字和字段类型组成 type Person struct { Name string Age int Addr string } 也有例外，就像下面这样子，字段上还可以额外再加一个属性，用反引号（Esc键下面的那个键）包含的字符串，称之为 Tag，也就是标签。 type Person struct { Name string `json:"name"` Age int
golang获取结构体中的tag_GoLang知识点
weixin_39543773的博客
11-29 1012
1. 系统中断信号注册interrupt := make(chan os.Signal) // 可以控制强制终止的信号 // 如果系统有中断信号，发送给r.interrupt signal.Notify(interrupt, os.Interrupt) // Ctrl+C 退出 sig := make(chan os.Signal, 1) signal.Notify(sig, syscall....
Tag标签优化规范，tag标签常见误区
weixin_33693070的博客
10-22 619
1、胡乱添加标签，不注重内容的相关性不是说tag标签好用，咱们就能随意用，胡乱给文章打标签。标签是为了便利用而户设置的，Tag标签正确使用的基本准则就是要和文章内容相关，TAG标签开始的动机就是将同类、同主题的文章归类到一同。假如内容不相关，从优化的角度，就会造成标签分类混乱，大大下降优化作用，影响TAG标签获得良好的搜索引擎排名；从用户体会的角度，也无法达到集中资源，增强处理用户问题可能性的作用...
Golang操作Mongodb
yantao_1994的博客
08-11 610
package main import ( "context" "fmt" "go.mongodb.org/mongo-driver/bson" "log" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/options" ) type Student struct { Name string Age int } func main() { // 设置客户端连接配置 clientOpti
golang结构体tag的使用
笔记
07-27 2078
tag是结构体的元信息，可以在运行的时候通过反射机制读取出来 1、tag定义格式：（tag在结构体字段的后方定义，由一对反引号包裹起来，不同的键值对之间使用空格分隔） `key1:"value1" key2:"value2"` 2、指定字段名（序列化与反序列化默认情况下使用结构体的字段名，我们可以通过给结构体字段添加tag来指定json序列化生成的字段名） // 使用json tag指定json序列化与反序列化时的行为 type Person struct { Name .
golang Tag语法
qq_49723651的博客
12-18 1305
golang Tag语法 文章目录golang Tag语法Tag格式 Tag格式
Golang tag 的使用方法
movoco的专栏
04-23 2604
package main import ( "fmt" "reflect" // 这里引入reflect模块 ) type User struct { Name string "user name" //这引号里面的就是tag Passwd string "user passsword" } func main() { user := &User{"ch
golang 匿名结构体
08-21
### 回答1： 在 Go 语言中，可以使用匿名结构体来定义一个没有名字的结构体类型。匿名结构体没有名字，只有字段，因此可以被用于一些临时性的数据结构或者只用一次的数据结构，可以减少代码的冗余度。 匿名结构体的定义方式和普通结构体类似，只是去掉了结构体的名称，例如： ``` var person struct { name string age int } person.name = "Tom" person.age = 18 ``` 在上面的例子中，我们定义了一个匿名结构体 person，并给它添加了两个字段 name 和 age。可以通过点号来访问结构体中的字段。 使用匿名结构体的好处是可以直接使用一个结构体类型而不需要定义结构体名称，从而简化代码。但是需要注意的是，匿名结构体不能被其他代码引用，因此只能在当前作用域内使用。同时，由于没有结构体名称，也不能像普通结构体一样定义方法。 ### 回答2： Golang中的匿名结构体是指在定义结构体变量时，省略结构体类型名称的方式。具体而言，我们可以在一个结构体内部直接定义另一个结构体，并在定义变量时直接使用该结构体的字段。 匿名结构体的语法形式为： ``` variable := struct { // 字段定义 }{ // 字段赋值 } ``` 这样，我们就可以在一个结构体内部定义并使用另一个结构体，而不需要为其指定一个具体的类型名称。匿名结构体的主要优点在于其灵活性和简洁性，适用于一些临时或者不需要重复使用的结构体。 值得注意的是，由于匿名结构体没有类型名称，因此它无法被其他函数访问或者重新使用。所以，匿名结构体主要用于一些局部的或者只需暂时使用的情况。 下面是一个例子来演示匿名结构体的使用： ``` package main import "fmt" func main() { user := struct { name string age int email string }{ name: "Alice", age: 20, email: "alice@example.com", } fmt.Println(user) } ``` 在上面的例子中，我们定义了一个匿名结构体，并直接在变量`user`的定义中初始化了该结构体的字段。然后，我们打印`user`的内容，就可以看到它的字段值。 总而言之，Golang中的匿名结构体可以在一个结构体内部定义并直接使用另一个结构体，具有灵活和简洁的特点，适用于一些临时或者不需要重复使用的场景。 ### 回答3： Golang中的匿名结构体是一种特殊的结构体类型，它不需要定义结构体的名称，直接定义结构体的字段和方法。 使用匿名结构体可以快速创建一个临时的结构体对象，无需定义结构体名称。例如： ```go package main import "fmt" func main() { p := struct { name string age int }{ name: "Alice", age: 20, } fmt.Println(p) } ``` 上面的代码中，我们创建了一个匿名结构体对象 `p`，它包含了 `name` 和 `age` 两个字段，并进行了初始化。我们可以直接通过 `p.name` 和 `p.age` 访问这两个字段的值。 匿名结构体通常用于临时的数据需求，避免定义一个独立的结构体类型。它可以直观地表示数据的结构，提高代码的可读性，并且无需关心结构体名称的重复问题。 对于匿名结构体，如果需要在多个地方复用，可以使用定义类型别名的方式。 ```go package main import "fmt" type Person struct { name string age int } func main() { p := struct { Person gender string }{ Person: Person{ name: "Bob", age: 25, }, gender: "Male", } fmt.Println(p) } ``` 上面的代码中，我们定义了一个 `Person` 结构体，并在匿名结构体中嵌入了这个结构体类型。这样一来，就可以在匿名结构体中访问到 `Person` 结构体的字段与方法。 总而言之，Golang中的匿名结构体是一种非常方便的临时数据结构，适用于不需要在其他地方复用的情况。它可以直接定义结构体的字段和方法，并进行初始化，提高代码的可读性和简洁性。如有需要进行复用，可以使用定义类型别名的方式。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

GoGo在努力

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值