百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分析 > 正文

2020重学Go系列:反引号的妙用—结构体里的 Tag 标签

liebian365 2024-12-31 12:45 27 浏览 0 评论

以下文章来源于Go编程时光 ,作者写代码的明哥

1. 抛砖引玉:什么是 Tag?

正常情况下,你定义的结构体是这样子的,每个字段都由名字和字段类型组成

type Person struct {
    Name string 
    Age  int   
    Addr string
}

也有例外,就像下面这样子,字段上还可以额外再加一个属性,用反引号(Esc键下面的那个键)包含的字符串,称之为 Tag,也就是标签。

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
    Addr string `json:"addr,omitempty"`
}

那么这个标签有什么用呢?

这边先以 encoding/json 库的用法抛砖引玉,看一下它能起到什么样的效果。

package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
    Addr string `json:"addr,omitempty"`
}

func main() {
    p1 := Person{
        Name: "Jack",
        Age:  22,
    }

    data1, err := json.Marshal(p1)
    if err != nil {
        panic(err)
    }

    // p1 没有 Addr,就不会打印了
    fmt.Printf("%s\n", data1)

    // ================

    p2 := Person{
        Name: "Jack",
        Age:  22,
        Addr: "China",
    }

    data2, err := json.Marshal(p2)
    if err != nil {
        panic(err)
    }

    // p2 则会打印所有
    fmt.Printf("%s\n", data2)
}

由于 Person 结构体里的 Addr 字段有 omitempty 属性,因此 encoding/json 在将对象转化 json 字符串时,只要发现对象里的 Addr 为 false, 0, 空指针,空接口,空数组,空切片,空映射,空字符串中的一种,就会被忽略。

因此运行后,输出的结果如下

nbsp;go run demo.go 
{"name":"Jack","age":22}
{"name":"Jack","age":22,"addr":"China"}

2. 不懂就问:如何定义获取 Tag ?

Tag 由反引号包含,由一对或几对的键值对组成,通过空格来分割键值。格式如下

`key01:"value01" key02:"value02" key03:"value03"`

定义完后,如何从结构体中,取出 Tag 呢?

答案就是,我们上一节学过的 "反射"。

获取 Tag 可以分为三个步骤:

  1. 获取字段 field
  2. 获取标签 tag
  3. 获取键值对 key:value

演示如下

// 三种获取 field
field := reflect.TypeOf(obj).FieldByName("Name")
field := reflect.ValueOf(obj).Type().Field(i)  // i 表示第几个字段
field := reflect.ValueOf(&obj).Elem().Type().Field(i)  // i 表示第几个字段

// 获取 Tag
tag := field.Tag 

// 获取键值对
labelValue := tag.Get("label")
labelValue,ok := tag.Lookup("label")

获取键值对,有Get 和 Lookup 两种方法,但其实 Get 只是对 Lookup 函数的简单封装而已,当没有获取到对应 tag 的内容,会返回空字符串。

func (tag StructTag) Get(key string) string {
    v, _ := tag.Lookup(key)
    return v
}

空 Tag 和不设置 Tag 效果是一样的

package main

import (
    "fmt"
    "reflect"
)

type Person struct {
    Name string ``
    Age string
}
func main() {
    p := reflect.TypeOf(Person{})
    name, _ := p.FieldByName("Name")
    fmt.Printf("%q\n", name.Tag) //输出 ""
    age, _ := p.FieldByName("Age")
    fmt.Printf("%q\n", age.Tag) // 输出 ""
}

3. 实战一下:利用 Tag 搞点事情?

学会了如何定义 tag 和 获取 tag,可以试着利用 tag 来做一些事情,来练习一下。

这边我举个例子吧。

如果我想实现一个函数(就叫 Print 吧),在打印 person 对象时,能够美化输出

type Person struct {
    Name        string 
    Age         int    
    Gender      string
}

person := Person{
    Name:        "MING",
    Age:         29,
}

Print(person)

就像下面这样,key 和 value 之间有个 is:,如果没有指定 Gender 的值,那么显示为unknown(未知)。

Name is: MING
Age is: 29
Gender is: unknown

那该怎么做呢?

先改造下 Person 结构体,给每个字段加上 tag 标签,三个字段的tag 都有 label 属性,而 Gender 多了一个 default 属性,意在指定默认值。

type Person struct {
    Name        string `label:"Name is: "`
    Age         int    `label:"Age is: "`
    Gender      string `label:"Gender is: " default:"unknown"`
}

然后来写一下这个 Print 函数

func Print(obj interface{}) error {
    // 取 Value
    v := reflect.ValueOf(obj)

    // 解析字段
    for i := 0; i < v.NumField(); i++ {

        // 取tag
        field := v.Type().Field(i)
        tag := field.Tag

        // 解析label 和 default
        label := tag.Get("label")
        defaultValue := tag.Get("default")

        value := fmt.Sprintf("%v", v.Field(i))
        if value == "" {
            // 如果没有指定值,则用默认值替代
            value = defaultValue
        }

        fmt.Println(label + value)
    }

    return nil
}

最后执行一下,看了下输出,符合我们的预期:

nbsp;go run demo.go 
Name is: MING
Age is: 29
Gender is: unknown

至此,我们就把 Tag 的用法介绍完了。

相关推荐

Markdown 常用语法总结(markdown示例)

头条不能以代码模式查看,所以分两部分来写:效果、语法。效果和语法部分一一对应,最好自己把语法复制下来保存为.md用md编辑器打开。先看效果:Markdown常用语法注:查阅时在视图中切换为源代码模式...

CPU眼里的:字符串 vs 数组(字符数组与字符串区别)

“它们十分相似,但又非常不同”01提出问题字符串和字符数组,在内存分布上,跟普通数组(例如:int类型的数组)有很高的相似性。但使用字符串的危险系数,却远远高于普通数组。是什么细微的差异导致了二者在使...

rsync命令详解(rsync命令详解 -X)

1.rsync简介rsync是linux系统下的数据镜像备份工具。使用快速增量备份工具RemoteSync可以远程同步,支持本地复制,或者与其他SSH、rsync主机同步。2.rsync特性rsy...

Linux操作系统安全配置(linux系统的安全配置有哪些方面)

一、服务相关命令systemctlenable服务名#开机自启动systemctldisable服务名#禁用开机自启动systemctlstop服务名#停止服务systemctls...

一篇文章学会数据备份利器rsync(备份数据语句)

阿铭linux近16年的IT从业经验,6年+鹅厂运维经验,6年+创业公司经验,熟悉大厂运维体系,有从零搭建运维体系的实战经验。关注我,学习主流运维技能,让你比别人提升更快,涨薪更多!作为一个系统管理员...

成功尝试在NetBSD9.0中安装Mate Desktop环境记录

NETBSD系统桌面安裝系統最新的NetBSD9.0:http://cdn.netbsd.org/pub/NetBSD/NetBSD-9.0/images/https://mirrors.tuna.t...

使用OpenLDAP集中式认证(openresty集群)

1OpenLDAP入门1.1什么是LDAP?1.2我不理解。什么是目录?1.3信息结构是什么样?1.4所以……它可以用来做什么?2OpenLDAP服务器配置2.1.1OLC样式的LDIF...

在 Ubuntu 22.04 上安装和配置 VNC 远程桌面

环境Ubuntu22.04.2LTSx86_64Step-1安装桌面环境Ubuntu默认使用GNOME桌面环境,但也可以安装其他桌面环境,如Xfce、KDE等。这个可以根据个人喜好选...

hdfs集群的扩容和缩容(hdfs容量)

1、背景当我们的hadoop集群运行了一段时间之后,原有的数据节点的容量已经不能满足我们的存储了,这个时候就需要往集群中增加新的数据节点。此时我们就需要动态的对hdfs集群进行扩容操作(节点服役)。2...

Zabbix入门操作指南(zabbix怎么使用)

上篇:安装与配置一.概述在开始之前,一些概念和定义需要我们提前了解一下(以下内容摘自官方网站)。1.1几个概念架构Zabbix由几个主要的功能组件组成,其职责如下所示。ServerZabbixs...

从0开始学习KVM-KVM学习笔记(6)- CentOS远程桌面连接

CentOS远程桌面连接CentOS系统上配置远程桌面连接有多种方法,其中最常用的是通过xrdp或vnc来实现。安装xrdr实现CentOS远程桌面安装xrdp安装epel库sudoyu...

systemd service之:服务配置文件编写(2)

接下来会通过示例来描述不同ServiceType值的应用场景。在此之前,强烈建议先阅读前后台进程父子关系和daemon类进程来搞懂进程之间的关系和Daemon类进程的特性。systemdservi...

Linux项目开发,你必须了解Systemd服务!

1.Systemd简介Systemd是什么,以前linux系统启动init机制,由于init一方面对于进程的管理是串行化的,容易出现阻塞情况,另一方面init也仅仅是执行启动脚本,并不能对服务本身...

Oracle 数据库日常巡检之检查数据库安全性

在本节主要检查Oracle数据库的安全性,包含:检查系统安全信息,如系统账户,系统防火墙策略,密码策略等。1.检查系统安全信息系统安全日志文件的目录在/var/log下,主要检查登录成功或失败的用户日...

「分享」非常全面的CentOS7系统安全检测和加固脚本

CentOS7系统检测和加固脚本脚本来源:https://github.com/xiaoyunjie/Shell_Script主要是为了Linux系统的安全,通过脚本对Linux系统进行一键检测和一键...

取消回复欢迎 发表评论: