iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > GO >Go 结构体序列化的实现
  • 792
分享到

Go 结构体序列化的实现

2024-04-02 19:04:59 792人浏览 泡泡鱼
摘要

目录更改JSON对象中的键在jsON对象中隐藏结构体字段附加内容结构体标签string指令本文,我们将回到之前写的showMovieHandler方法,并更新它以返回一个JSON响应

本文,我们将回到之前写的showMovieHandler方法,并更新它以返回一个JSON响应,表示系统中的单个电影信息。类似于:

{
    "id": 123,
    "title": "Casablanca", 
    "runtime": 102, 
    "genres": [
        "drama", 
        "romance", 
        "war"
    ],
    "version": 1 
}

我们不使用map序列化来创建这个JSON对象(就像我们在上一节中所做的那样),这次我们将编码一个自定义的Movie结构体。

首先,需要定义一个Movie结构体。我们将在一个新internal/data包中完成此操作,该包稍后将扩展用来封装项目中所有自定义数据类型以及与数据库交互的逻辑。

如果您按照文章步骤操作,请创建一个新的internal/data目录,其中包含一个movies.Go文件:

$ mkdir internal/data
$ touch internal/data/movies.go

在这个新文件中,定义Movie结构,像这样:

File: internal/data/movies.go

package main

import (
    "time"
)

type Movie struct {
    ID             int64      //唯一整数ID
    CreatedAt      time.Time  //创建电影到数据库的时间
    Title          string     //电影标题
    Year           int32      //电影发布年份
    Runtime        int32      //电影时长
    Genres         []string   //电影类型(爱情片、喜剧片等)
    Version        int32      //版本号从1开始,每更新一次递增
}

这里需要指出的是,Movie结构体中的所有字段都是可导出的(即以大写字母开头),这对于Go的encoding/json包可见是必要的。在将结构体编码为JSON时,不会包含任何未导出的字段。

现在结构体已经定义完成,让我们更新showMovieHandler处理程序来初始化一个Movie结构体实例,然后使用writeJSON()帮助函数将其作为JSON响应发送给客户端。

实现很简单:

File: cmd/api/movies.go

package main

import (
    "fmt"
    "net/Http"
    "time"

    "greenlight.alexedwards.net/internal/data"
)

func (app *application) showMovieHandler(w http.ResponseWriter, r *http.Request) {
    id, err := app.readIDParam(r)
    if err != nil {
        http.NotFound(w, r)
        return
    }

    //创建一个Move结构体实例,包含从请求URL中解析的ID虚构的数据。注意这里故意没有设置Year字段
    movie := date.Movie{
        ID: id,
        CreateAt: time.now(),
        Title: "Casablanca",
        Runtime: 102,
        Genres: []string{"drama", "romance", "war"},
        Version: 1,
    }

    //将结构体序列化为JSON并以HTTP响应发送给客户端
    err = app.writeJSON(w, http.StatusOK, movie, nil)
    if err != nil {
         app.logger.Println(err)
         http.Error(w, "The server encountered a problem and could not process your request", http.StatusInternalServerError)
    }
}

ok,下面试试!

重启API,然后在浏览器中访问localhost:4000/v1/movies/123。你应该会看到一个类似这样的JSON响应:

在这个返回结果中,有几件有趣的事情需要指出:

  • Movie结构体被编码成一个JSON对象,字段名和值作为键/值对。
  • 默认情况下,JSON对象中的键等于结构体中的字段名(ID、CreatedAt、Title等等)。我们稍后将讨论如何自定义JSON键。
  • 如果结构体实例字段没有显式赋值,那么字段零值将序列化为json值。可以在上面的响应中看到——我们没有在Go代码中为Year字段设置值,但它仍然以0值出现在JSON输出中。

更改JSON对象中的键

在Go中序列化结构体的一个好处是,您可以通过使用struct标签注释字段来定制JSON。

struct标签最常见的用途可能是更改JSON对象中出现的键名称。当你的结构体字段名不适合面向公众展示,或者你想在JSON输出中使用另一种大小写样式时,这是很有用的。

为了说明如何实现,对Movies结构体字段打标签,使用蛇形格式:

File: internal/data/movies.go

//使用标记对Movie结构进行注释,以控制json编码的key显示方式。
type Movie struct {
    ID       int64     `json:"id"`
    CreateAt time.Time `json:"created_at"`
    Title    string    `json:"title"`
    Year     int32     `json:"year"`
    Runtime  int32     `json:"runtime"`
    Genres   []string  `json:"genres"`
    Version  int32     `json:"version"`
}

如果你重启服务器并再次访问localhost:4000/v1/movies/123,应该会看到一个类似于这样的带有蛇形键的响应:

在JSON对象中隐藏结构体字段

在定义结构体时候,通过使用omitempty可以控制对应字段在JSON中的可见性。当您不希望JSON输出中出现特定的结构体字段时,可以使用-(连字符)指令。这对包含和用户不相关的内部系统信息的字段或不想公开的敏感信息(如密码哈希值)非常有用。

相反,当且仅当struct字段值为空时,omitempty指令会在JSON输出中隐藏字段,其中empty被定义为:

  • 等于false,0或“”
  • 数组,切片或map
  • nil指针或接口值为nil

为了演示如何使用这些指令,我们对Movie结构进行更多的改造。CreatedAt字段与我们的最终用户无关,所以我们使用-指令在输出中将其隐藏。我们还将使用omitempty指令在输出中隐藏Year、Runtime和types字段,当且仅当它们为空时生效。

继续并像下面这样更新struct标签:

File:interface/data/movies.go

package data

....

type Movie struct {
    ID       int64     `json:"id"`
    CreateAt time.Time `json:"-"`       //使用-指令
    Title    string    `json:"title"`
    Year     int32     `json:"year,omitempty"`            //添加omitempty
    Runtime  int32     `json:"runtime,omitempty"`         //添加omitempty
    Genres   []string  `json:"genres,omitempty"`          //添加omitempty
    Version  int32     `json:"version"`
}

如果你想使用omitempty而不改变键名,那么你可以在struct标签中保留它为空-如:json:",omitempty"。注意,逗号是必要的。

现在,当你重新启动应用程序并刷新你的WEB浏览器时,你应该会看到如下响应:

我们可以在这里看到,CreatedAt结构字段不再出现在JSON中,而且Year字段(值为0)也没有出现,这要感谢omitempty指令。其他字段使用了omitempty不受影响(例如Runtime和Genres)。

注意:您还可以通过简单地将结构体字段设置为不可导出来防止它出现在JSON序列化中。但使用json:“-“标记通常是一个更好的选择:明确告知阅读代码的人,你不希望该字段包含在json。

旧版本的go vet如果你试图在未导出的字段上使用struct标记会引发错误,但现在在go 1.16中已经修复了这个问题。

附加内容

结构体标签string指令

最后一个不太常用的struct标记指令是string。可以使用这个标签明确表示字段值序列化成JSON字符串类型。例如,如果我们希望Runtime字段的值表示为一个JSON字符串 (而不是数字)我们可以像这样使用string指令:

type Movie struct {
    ID       int64     `json:"id"`
    CreateAt time.Time `json:"-"`       //使用-指令
    Title    string    `json:"title"`
    Year     int32     `json:"year,omitempty"`   
    Runtime  Runtime   `json:"runtime,omitempty,string"` 
    Genres   []string  `json:"genres,omitempty"`       
    Version  int32     `json:"version"`
}

JSON序列化结果如下所示:

{
"id": 123,
"title": "Casablanca",
"runtime": "102",   //这是字符串
"genres": [
    "drama", 
    "romance", 
    "war"
    ],
"version": 1 
}

注意string指令只对int, uint, float*或bool类型的字段有效。对于任何其他类型的结构体字段没有作用。

到此这篇关于Go 结构体序列化的实现的文章就介绍到这了,更多相关Go 结构体序列化内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

您可能感兴趣的文档:

--结束END--

本文标题: Go 结构体序列化的实现

本文链接: https://www.lsjlt.com/news/163509.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Go 结构体序列化的实现
    目录更改JSON对象中的键在JSON对象中隐藏结构体字段附加内容结构体标签string指令本文,我们将回到之前写的showMovieHandler方法,并更新它以返回一个JSON响应...
    99+
    2024-04-02
  • Go结构体序列化的实现是怎样的
    Go结构体序列化的实现是怎样的,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。我们将回到之前写的showMovieHandler方法,并更新它以返回一个JSON响...
    99+
    2023-06-29
  • golang结构体序列化怎么实现
    在Go中,可以使用encoding/json包来实现结构体的序列化和反序列化。 首先,需要导入encoding/json包: imp...
    99+
    2023-10-22
    golang
  • 带指针的结构体序列化
    哈喽!大家好,很高兴又见面了,我是编程网的一名作者,今天由我给大家带来一篇《带指针的结构体序列化》,本文主要会讲到等等知识点,希望大家一起学习进步,也欢迎大家关注、点赞、收藏、转发! 下面就一起来看...
    99+
    2024-04-04
  • Golang怎么使用gob实现结构体的序列化
    本文小编为大家详细介绍“Golang怎么使用gob实现结构体的序列化”,内容详细,步骤清晰,细节处理妥当,希望这篇“Golang怎么使用gob实现结构体的序列化”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。Gol...
    99+
    2023-07-05
  • Golang使用gob实现结构体的序列化过程详解
    目录Gob简介单个对象序列化列表数据序列化简单编码示例编码在TCP连接中使用Golang有自己的序列化格式,称为gob。使用gob可以对结构进行编码和解码。你可以使用其他格式,如JS...
    99+
    2023-03-08
    Golang序列化结构体 Golang gob序列化
  • Go Struct结构体如何实现
    本文小编为大家详细介绍“Go Struct结构体如何实现”,内容详细,步骤清晰,细节处理妥当,希望这篇“Go Struct结构体如何实现”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。什么是结构...
    99+
    2023-07-05
  • go语言string转结构体的实现
    在 Go 语言中,可以使用标准库中的 encoding/json 包将 JSON 格式的字符串转换为结构体。 假设有以下 JSON 字符串: { "name": "鸡哥", ...
    99+
    2023-03-19
    go语言string转结构体 go string 结构体
  • go json转结构体怎么实现
    要将JSON转换为结构体,可以使用encoding/json包提供的Unmarshal函数。以下是一个简单的示例: package ...
    99+
    2024-02-29
    go json
  • PHP数据结构:序列化与反序列化的艺术,实现数据持久化与传输
    非常抱歉,由于您没有提供文章标题,我无法为您生成一篇高质量的文章。请您提供文章标题,我将尽快为您生成一篇优质的文章。...
    99+
    2024-05-14
  • GoStruct结构体的具体实现
    目录什么是结构体1. 基本实例化(方法1)2. new实例化(方法2)3. 键值对初始化(方法3 结构体能够使用指针就使用指针)结构体方法和接收者encoding-json包1. s...
    99+
    2023-03-15
    Go Struct结构体 Go Struct
  • php浅析反序列化结构
    目录简介反序列化中常见的魔术方法反序列化绕过小Trick绕过_wakeup(CVE-2016-7124)绕过部分正则利用引用16进制绕过字符的过滤简介 序列化的目的是方便数据的传输和...
    99+
    2024-04-02
  • Python实现结构体
    #!/usr/bin/python import sys class MyClass(): def __init__(self, name = ""): self.name = name ...
    99+
    2023-01-31
    结构 Python
  • go语言string转结构体如何实现
    这篇“go语言string转结构体如何实现”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“go语言string转结构体如何实现...
    99+
    2023-07-05
  • Go语言中实现对象的序列化与反序列化方法
    Golang中实现对象序列化和反序列化的方法,需要具体代码示例 序列化和反序列化是将对象转化为可存储或传输的格式,以及将存储或传输的格式转化为对象的过程。在Golang中,可以通过一些内置的库和方法来实现对象...
    99+
    2024-01-29
  • go中的var可以初始化结构体吗
    本篇内容主要讲解“go中的var可以初始化结构体吗”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“go中的var可以初始化结构体吗”吧!语法提前了解string转成int 在golang中使用st...
    99+
    2023-06-21
  • go序列化的实现方法有哪些
    Go语言中序列化的实现方法有以下几种: 使用标准库的encoding/json包进行JSON序列化和反序列化。 使用标准库的enc...
    99+
    2024-02-29
    go
  • Go语言中怎么实现结构体反射
    本篇文章给大家分享的是有关Go语言中怎么实现结构体反射,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。结构体type Student struct ...
    99+
    2023-06-15
  • SpringBoot怎么结合Redis实现序列化
    这篇文章主要介绍了SpringBoot怎么结合Redis实现序列化的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇SpringBoot怎么结合Redis实现序列化文章都会有所收获,下面我们一起来看看吧。配置类配置...
    99+
    2023-07-02
  • go语言实现二叉树的序例化与反序列化
    目录二叉树的反序列化反序列化解题思路TreeNode结构体反序列化方法代码解读二叉树的序列化介绍解题思路代码代码解读运行结果二叉树的反序列化 反序列化 树的反序列化故名知意就是将一个...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作