【Golang】Golang进阶系列教程--为什么 Go 语言 struct 要使用 tags

文章目录

  • 前言
  • struct tags 的使用
    • 使用反引号
    • 避免使用空格
    • 避免重复
    • 使用标准化的 tag 名称
    • 多个 tag 值
  • struct tags 的原理
  • struct tags 的优势
  • 常用的 struct tags
  • 参考文章:

前言

在 Go 语言中,struct 是一种常见的数据类型,它可以用来表示复杂的数据结构。在 struct 中,我们可以定义多个字段,每个字段可以有不同的类型和名称。

除了这些基本信息之外,Go 还提供了 struct tags,它可以用来指定 struct 中每个字段的元信息。
在本文中,我们将探讨为什么 Go 语言中需要使用 struct tags,以及 struct tags 的使用场景和优势。

struct tags 的使用

struct tags 使用还是很广泛的,特别是在 json 序列化,或者是数据库 ORM 映射方面。
在这里插入图片描述

在定义上,它以 key:value 的形式出现,跟在 struct 字段后面,除此之外,还有以下几点需要注意:

使用反引号

在声明 struct tag 时,使用反引号 ` 包围 tag 的值,可以防止转义字符的影响,使 tag 更容易读取和理解。例如:

type User struct {ID    int    `json:"id" db:"id"`Name  string `json:"name" db:"name"`Email string `json:"email" db:"email"`
}

避免使用空格

在 struct tag 中,应该避免使用空格,特别是在 tag 名称和 tag 值之间。使用空格可能会导致编码或解码错误,并使代码更难以维护。例如:

// 不规范的写法
type User struct {ID    int    `json: "id" db: "id"`Name  string `json: "name" db: "name"`Email string `json: "email" db: "email"`
}// 规范的写法
type User struct {ID    int    `json:"id" db:"id"`Name  string `json:"name" db:"name"`Email string `json:"email" db:"email"`
}

避免重复

在 struct 中,应该避免重复使用同一个 tag 名称。如果重复使用同一个 tag 名称,编译器可能会无法识别 tag,从而导致编码或解码错误。例如:

// 不规范的写法
type User struct {ID    int    `json:"id" db:"id"`Name  string `json:"name" db:"name"`Email string `json:"email" db:"name"`
}// 规范的写法
type User struct {ID    int    `json:"id" db:"id"`Name  string `json:"name" db:"name"`Email string `json:"email" db:"email"`
}

使用标准化的 tag 名称

为了使 struct tag 更加标准化和易于维护,应该使用一些标准化的 tag 名称。
例如,对于序列化和反序列化,可以使用 json、xml、yaml 等;对于数据库操作,可以使用 db。

type User struct {ID       int    `json:"id" db:"id"`Name     string `json:"name" db:"name"`Password string `json:"-" db:"password"` // 忽略该字段Email    string `json:"email" db:"email"`
}

其中,Password 字段后面的 - 表示忽略该字段,也就是说该字段不会被序列化或反序列化。

多个 tag 值

如果一个字段需要指定多个 tag 值,可以使用 , 将多个 tag 值分隔开。例如:

type User struct {ID        int    `json:"id" db:"id"`Name      string `json:"name" db:"name"`Email     string `json:"email,omitempty" db:"email,omitempty"`
}

其中 omitempty 表示如果该字段值为空,则不序列化该字段。

struct tags 的原理

Go 的反射库提供了一些方法,可以让我们在程序运行时获取和解析结构体标签。
介绍这些方法之前,先来看看 reflect.StructField ,它是描述结构体字段的数据类型。定义如下:

type StructField struct {Name      string      // 字段名Type      Type        // 字段类型Tag       StructTag   // 字段标签
}

结构体中还有一些其他字段,被我省略了,只保留了和本文相关的。
在结构体的反射中,我们经常使用 reflect.TypeOf 获取类型信息,然后使用 Type.Field 或 Type.FieldByName() 获取结构体字段的 reflect.StructField,然后根据 StructField 中的信息做进一步处理。
例如,可以通过 StructField.Tag.Get 方法获取结构体字段的标签值。
下面看一段代码:

package mainimport ("fmt""reflect"
)type User struct {Name string `json:"name"`Age  int    `json:"age"`
}type Manager struct {Title string `json:"title"`User
}func main() {m := Manager{Title: "Manager", User: User{Name: "Alice", Age: 25}}mt := reflect.TypeOf(m)// 获取 User 字段的 reflect.StructFielduserField, _ := mt.FieldByName("User")fmt.Println("Field 'User' exists:", userField.Name, userField.Type)// 获取 User.Name 字段的 reflect.StructFieldnameField, _ := userField.Type.FieldByName("Name")tag := nameField.Tag.Get("json")fmt.Println("User.Name tag:", tag)
}

运行以上代码,输出结果如下:

Field 'User' exists: User {string int}
User.Name tag: "name"

struct tags 的优势

使用 struct tag 的主要优势之一是可以在运行时通过反射来访问和操作 struct 中的字段。

比如在 Go Web 开发中,常常需要将 HTTP 请求中的参数绑定到一个 struct 中。这时,我们可以使用 struct tag 指定每个字段对应的参数名称、验证规则等信息。在接收到 HTTP 请求时,就可以使用反射机制读取这些信息,并根据信息来验证参数是否合法。

另外,在将 struct 序列化为 JSON 或者其他格式时,我们也可以使用 struct tag 来指定每个字段在序列化时的名称和规则。

此外,使用 struct tag 还可以提高代码的可读性和可维护性。在一个大型的项目中,struct 中的字段通常会包含很多不同的元信息,比如数据库中的表名、字段名、索引、验证规则等等。

如果没有 struct tag,我们可能需要将这些元信息放在注释中或者在代码中进行硬编码。这样会让代码变得难以维护和修改。而使用 struct tag 可以将这些元信息与 struct 字段紧密关联起来,使代码更加清晰和易于维护。

常用的 struct tags

在 Go 的官方 wiki 中,有一个常用的 struct tags 的库的列表,我复制在下面了,感兴趣的同学可以看看源码,再继续深入学习。

TagDocumentation
xmlpkg.go.dev/encoding/xm…
jsonpkg.go.dev/encoding/js…
asn1pkg.go.dev/encoding/as…
reformpkg.go.dev/gopkg.in/re…
dynamodbdocs.aws.amazon.com/sdk-for-go/…
bigquerypkg.go.dev/cloud.googl…
datastorepkg.go.dev/cloud.googl…
spannerpkg.go.dev/cloud.googl…
bsonpkg.go.dev/labix.org/v…, pkg.go.dev/go.mongodb.…
gormpkg.go.dev/github.com/…
yamlpkg.go.dev/gopkg.in/ya…
tomlpkg.go.dev/github.com/…
validategithub.com/go-playgrou…
mapstructurepkg.go.dev/github.com/…
parserpkg.go.dev/github.com/…
protobufgithub.com/golang/prot…
dbgithub.com/jmoiron/sql…
urlgithub.com/google/go-q…
featuregithub.com/nikolaydubi…

以上就是本文的全部内容。

参考文章:

github.com/golang/go/w…

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/12149.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

《吐血整理》进阶系列教程-拿捏Fiddler抓包教程(8)-Fiddler如何设置捕获会话

1.简介 前边几篇宏哥介绍了Fiddler界面内容以及作用。今天宏哥就讲解和分享如何设置Fiddler后,我们就可以捕获会话,进行抓包了。 2.捕获会话的设备 常见的捕获会话的设备分为PC(电脑)端和手机(Android和IOS苹果&…

Bert经典变体学习

ALBert ALBERT就是为了解决模型参数量大以及训练时间过长的问题。ALBERT最小的参数只有十几M, 效果要比BERT低1-2个点,最大的xxlarge也就200多M。可以看到在模型参数量上减少的还是非常明显的,但是在速度上似乎没有那么明显。最大的问题就是这种方式其实…

使用CRM分析数据有哪些功能?

CRM数据分析软件可以帮助企业增强竞争力,并更好地了解客户需求及市场变化,助力企业数据分析,并提供实时更新的数据和分析结果,CRM数据分析软件的主要特点是什么?包括以下6个特点。 CRM数据分析软件的主要功能通常包括…

SpringBoot 和 Vue 参数类型不对应,导致method parameter is not present

org.springframework.web.bind.MissingServletRequestParameterException: Required request parameter id for method parameter type String is not present 客户端: requestUserInfoById()const requestUserInfoById async (id?: string) > {} 服务器端&am…

亚马逊云科技全新Amazon Bedrock,助力客户构建生成式AI应用

亚马逊云科技近日在纽约峰会上宣布全面扩展其全托管基础模型服务Amazon Bedrock,包括新增Cohere作为基础模型供应商,加入Anthropic和Stability AI的最新基础模型,并发布变革性的新功能Amazon Bedrock Agents功能。客户无需管理任何基础设施&a…

ChatGPT统计“一到点就下班”的人数

ChatGPT统计“一到点就下班”的人数 1、到点下班 Chatgpt统计各部门F-D级员工到点下班人数占比,是在批评公司内部存在到点下班现象。 根据图片,该占比的计算方法是:最后一次下班卡在17:30-17:40之间,且1-5月合计有40天以上的人…

day16-347.前 K 个高频元素

347.前 K 个高频元素 力扣题目链接(opens new window) 给定一个非空的整数数组,返回其中出现频率前 k 高的元素。 示例 1: 输入: nums [1,1,1,2,2,3], k 2输出: [1,2] 示例 2: 输入: nums [1], k 1输出: [1] 思路 解题步骤大概如下: 统计频…

OpenCV图像处理-视频分割静态背景-MOG/MOG2/GMG

视频分割背景 1.概念介绍2. 函数介绍MOG算法MOG2算法GMG算法 原视频获取链接 1.概念介绍 视频背景扣除原理:视频是一组连续的帧(一幅幅图组成),帧与帧之间关系密切(GOP/group of picture),在GOP中,背景几乎…

服务器远程不上服务器怎么办?服务器无法远程的原因是什么?

服务器远程不上服务器怎么办?服务器无法远程的原因是什么? 接下来跟着笔者一起分析一下具体的原因有哪些以及相对应的解决方法 一、网络问题 1.本地网络问题 解决办法:检查本地网络是否正常,访问外网是否流畅,可以…

关于Java中的Lambda变量捕获

博主简介:想进大厂的打工人博主主页:xyk:所属专栏: JavaEE进阶 目录 一、Lambda表达式语法 二、Lambda中变量捕获 一、Lambda表达式语法 基本语法: (parameters) -> expression 或 (parameters) ->{ statements; } Lambda表达式由三部分组成&a…

使用Feign出现空指针异常

说明:本文记录一次偶然出现的空指针异常,在微服务架构中,一个服务在调用另一个服务时,出现了空指针异常。 业务描述:在做订单超时功能时,大家都知道,可以使用RabbitMQ延迟队列,下单…

数据结构—数组和广义表

4.2数组 数组:按一定格式排列起来的,具有相同类型的数据元素的集合。 **一维数组:**若线性表中的数据元素为非结果的简单元素,则称为一维数组。 **一维数组的逻辑结构:**线性结构,定长的线性表。 **声明…

TD1850多用表校准系统参考标准

参考标准 分类 标准名称 国家标准 GB/T 13978-2008 数字多用表 GB/T 15637-2012 数字多用表校准仪通用规范 计量法规 JJF 1075-2015 钳形电流表校准规范 JJF 1284-2011 交直流电表校验仪校准规范 JJF 1587-2016 数字多用表校准规范 JJG 124-2005 电流表、电压表、功率表及…

【多模态】18、ViLD | 通过对视觉和语言知识蒸馏来实现开集目标检测(ICLR2022)

文章目录 一、背景二、方法2.1 对新类别的定位 Localization2.2 使用 cropped regions 进行开放词汇检测2.3 ViLD 三、效果 论文:Open-vocabulary Object Detection via Vision and Language Knowledge Distillation 代码:https://github.com/tensorflo…

Angular函数中,哪些情况需要保存当前this作用域再使用?

在Angular函数中,有几种情况需要保存当前this作用域,以便在嵌套函数或回调函数中正确地使用它。这是因为JavaScript中的this关键字的值在不同的上下文中可能会发生变化。下面是几种需要注意的情况: 1、回调函数中的this: 当你在一…

三子棋(超详解+完整码源)

三子棋 前言一,游戏规则二,所需文件三,创建菜单四,游戏核心内容实现1.棋盘初始化1.棋盘展示3.玩家下棋4.电脑下棋5.游戏胜负判断6.game()函数内部具体实现 四,游戏运行实操 前言 C语言实现三子棋…

8.10 PowerBI系列之DAX函数专题-TopN中实现动态指标

需求 实现 建立一个辅助表供切片器选择 2 建立条件判断度量值top_measure swich(true(),selectedvalue(table[tope_type])"按数量top",sum(order_2[产品数量]),selectedvalue(table[tope_type])"按金额top",sum(order_2[订单金额]),selectedvalue(table…

本地部署中文LLaMA模型实战教程,民间羊驼模型

羊驼实战系列索引 博文1:本地部署中文LLaMA模型实战教程,民间羊驼模型(本博客) 博文2:本地训练中文LLaMA模型实战教程,民间羊驼模型 博文3:精调训练中文LLaMA模型实战教程,民间羊驼模型 简介 LLaMA大部分是英文语料训练的,讲中文能力很弱。如果我们想微调训练自己的…

aop实现方式及基本使用

aop实现方式 aspectj 编译器增强,直接修改源码可以不借助Spring实现 也没有用代理对象 (ajc编译器) aop 的原理并非代理一种, 编译器也能玩出花样(直接修改源码) 运行时需要在 VM options 里加入 -javaagent:D:/envir…

贪心算法总结及其leetcode题目N道

1 我为什么要写这个总结 1.1 字节笔试题 小明在玩一场通关游戏,初始血量为1,关卡有怪兽或者有血包(正数就是血包可回血数,负数说明是怪兽的伤害值),当捡到血包时会加血量,碰到怪兽时会掉血&am…