Go 结构体序列化的实现

目录

• 更改JSON对象中的键
• 在JSON对象中隐藏结构体字段
• 附加内容
• 结构体标签string指令

本文，我们将回到之前写的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 结构体序列化内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！