本文，我們將回到之前寫(xiě)的showMovieHandler方法，并更新它以返回一個(gè)JSON響應(yīng)，表示系統(tǒng)中的單個(gè)電影信息。類似于:

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

我們不使用map序列化來(lái)創(chuàng)建這個(gè)JSON對(duì)象(就像我們?cè)谏弦还?jié)中所做的那樣)，這次我們將編碼一個(gè)自定義的Movie結(jié)構(gòu)體。

首先，需要定義一個(gè)Movie結(jié)構(gòu)體。我們將在一個(gè)新internal/data包中完成此操作，該包稍后將擴(kuò)展用來(lái)封裝項(xiàng)目中所有自定義數(shù)據(jù)類型以及與數(shù)據(jù)庫(kù)交互的邏輯。

如果您按照文章步驟操作，請(qǐng)創(chuàng)建一個(gè)新的internal/data目錄，其中包含一個(gè)movies.go文件:

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

在這個(gè)新文件中，定義Movie結(jié)構(gòu)，像這樣:

File: internal/data/movies.go

package main

import (
? ? "time"
)

type Movie struct {
? ? ID ? ? ? ? ? ? int64 ? ? ?//唯一整數(shù)ID
? ? CreatedAt ? ? ?time.Time ?//創(chuàng)建電影到數(shù)據(jù)庫(kù)的時(shí)間
? ? Title ? ? ? ? ?string ? ? //電影標(biāo)題
? ? Year ? ? ? ? ? int32 ? ? ?//電影發(fā)布年份
? ? Runtime ? ? ? ?int32 ? ? ?//電影時(shí)長(zhǎng)
? ? Genres ? ? ? ? []string ? //電影類型(愛(ài)情片、喜劇片等)
? ? Version ? ? ? ?int32 ? ? ?//版本號(hào)從1開(kāi)始，每更新一次遞增
}

這里需要指出的是，Movie結(jié)構(gòu)體中的所有字段都是可導(dǎo)出的(即以大寫(xiě)字母開(kāi)頭)，這對(duì)于Go的encoding/json包可見(jiàn)是必要的。在將結(jié)構(gòu)體編碼為JSON時(shí)，不會(huì)包含任何未導(dǎo)出的字段。

現(xiàn)在結(jié)構(gòu)體已經(jīng)定義完成，讓我們更新showMovieHandler處理程序來(lái)初始化一個(gè)Movie結(jié)構(gòu)體實(shí)例，然后使用writeJSON()幫助函數(shù)將其作為JSON響應(yīng)發(fā)送給客戶端。

實(shí)現(xiàn)很簡(jiǎn)單：

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
    }

    //創(chuàng)建一個(gè)Move結(jié)構(gòu)體實(shí)例，包含從請(qǐng)求URL中解析的ID虛構(gòu)的數(shù)據(jù)。注意這里故意沒(méi)有設(shè)置Year字段
    movie := date.Movie{
        ID: id,
        CreateAt: time.now(),
        Title: "Casablanca",
        Runtime: 102,
        Genres: []string{"drama", "romance", "war"},
        Version: 1,
    }

    //將結(jié)構(gòu)體序列化為JSON并以HTTP響應(yīng)發(fā)送給客戶端
    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，然后在瀏覽器中訪問(wèn)localhost:4000/v1/movies/123。你應(yīng)該會(huì)看到一個(gè)類似這樣的JSON響應(yīng):

在這個(gè)返回結(jié)果中，有幾件有趣的事情需要指出:

• Movie結(jié)構(gòu)體被編碼成一個(gè)JSON對(duì)象，字段名和值作為鍵/值對(duì)。
• 默認(rèn)情況下，JSON對(duì)象中的鍵等于結(jié)構(gòu)體中的字段名(ID、CreatedAt、Title等等)。我們稍后將討論如何自定義JSON鍵。
• 如果結(jié)構(gòu)體實(shí)例字段沒(méi)有顯式賦值，那么字段零值將序列化為json值?？梢栽谏厦娴捻憫?yīng)中看到——我們沒(méi)有在Go代碼中為Year字段設(shè)置值，但它仍然以0值出現(xiàn)在JSON輸出中。

更改JSON對(duì)象中的鍵

在Go中序列化結(jié)構(gòu)體的一個(gè)好處是，您可以通過(guò)使用struct標(biāo)簽注釋字段來(lái)定制JSON。

struct標(biāo)簽最常見(jiàn)的用途可能是更改JSON對(duì)象中出現(xiàn)的鍵名稱。當(dāng)你的結(jié)構(gòu)體字段名不適合面向公眾展示，或者你想在JSON輸出中使用另一種大小寫(xiě)樣式時(shí)，這是很有用的。

為了說(shuō)明如何實(shí)現(xiàn)，對(duì)Movies結(jié)構(gòu)體字段打標(biāo)簽，使用蛇形格式：

File: internal/data/movies.go

//使用標(biāo)記對(duì)Movie結(jié)構(gòu)進(jìn)行注釋，以控制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"`
}

如果你重啟服務(wù)器并再次訪問(wèn)localhost:4000/v1/movies/123，應(yīng)該會(huì)看到一個(gè)類似于這樣的帶有蛇形鍵的響應(yīng):

在JSON對(duì)象中隱藏結(jié)構(gòu)體字段

在定義結(jié)構(gòu)體時(shí)候，通過(guò)使用omitempty可以控制對(duì)應(yīng)字段在JSON中的可見(jiàn)性。當(dāng)您不希望JSON輸出中出現(xiàn)特定的結(jié)構(gòu)體字段時(shí)，可以使用-(連字符)指令。這對(duì)包含和用戶不相關(guān)的內(nèi)部系統(tǒng)信息的字段或不想公開(kāi)的敏感信息(如密碼哈希值)非常有用。

相反，當(dāng)且僅當(dāng)struct字段值為空時(shí)，omitempty指令會(huì)在JSON輸出中隱藏字段，其中empty被定義為:

• 等于false，0或“”
• 空數(shù)組，切片或map
• nil指針或接口值為nil

為了演示如何使用這些指令，我們對(duì)Movie結(jié)構(gòu)進(jìn)行更多的改造。CreatedAt字段與我們的最終用戶無(wú)關(guān)，所以我們使用-指令在輸出中將其隱藏。我們還將使用omitempty指令在輸出中隱藏Year、Runtime和types字段，當(dāng)且僅當(dāng)它們?yōu)榭諘r(shí)生效。

繼續(xù)并像下面這樣更新struct標(biāo)簽:

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標(biāo)簽中保留它為空-如:json:"，omitempty"。注意，逗號(hào)是必要的。

現(xiàn)在，當(dāng)你重新啟動(dòng)應(yīng)用程序并刷新你的web瀏覽器時(shí)，你應(yīng)該會(huì)看到如下響應(yīng):

我們可以在這里看到，CreatedAt結(jié)構(gòu)字段不再出現(xiàn)在JSON中，而且Year字段(值為0)也沒(méi)有出現(xiàn)，這要感謝omitempty指令。其他字段使用了omitempty不受影響(例如Runtime和Genres)。

注意:您還可以通過(guò)簡(jiǎn)單地將結(jié)構(gòu)體字段設(shè)置為不可導(dǎo)出來(lái)防止它出現(xiàn)在JSON序列化中。但使用json:“-“標(biāo)記通常是一個(gè)更好的選擇：明確告知閱讀代碼的人，你不希望該字段包含在json。

舊版本的go vet如果你試圖在未導(dǎo)出的字段上使用struct標(biāo)記會(huì)引發(fā)錯(cuò)誤，但現(xiàn)在在go 1.16中已經(jīng)修復(fù)了這個(gè)問(wèn)題。

附加內(nèi)容

結(jié)構(gòu)體標(biāo)簽string指令

最后一個(gè)不太常用的struct標(biāo)記指令是string?？梢允褂眠@個(gè)標(biāo)簽明確表示字段值序列化成JSON字符串類型。例如，如果我們希望Runtime字段的值表示為一個(gè)JSON字符串 (而不是數(shù)字)我們可以像這樣使用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序列化結(jié)果如下所示:

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

注意string指令只對(duì)int， uint， float*或bool類型的字段有效。對(duì)于任何其他類型的結(jié)構(gòu)體字段沒(méi)有作用。

到此這篇關(guān)于Go 結(jié)構(gòu)體序列化的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Go 結(jié)構(gòu)體序列化內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論