在 Go 語言中，MarshalJSON 是一個接口方法，允許自定義類型在進行 JSON 編碼時提供自定義的序列化邏輯。通過實現(xiàn) MarshalJSON 方法，你可以控制結(jié)構(gòu)體或其他類型在轉(zhuǎn)換為 JSON 時的表現(xiàn)。

基本用法

當你想要自定義某個類型的 JSON 表現(xiàn)時，可以實現(xiàn) json.Marshaler 接口，該接口只包含一個方法 MarshalJSON。實現(xiàn)該方法后，使用 json.Marshal 函數(shù)時會自動調(diào)用你定義的 MarshalJSON 方法。

示例

以下是一個示例，展示如何自定義結(jié)構(gòu)體的 JSON 序列化：

package main

import (
    "encoding/json"
    "fmt"
)

// 定義一個結(jié)構(gòu)體
type User struct {
    Name  string
    Age   int
    Email string
}

// 為 User 實現(xiàn) MarshalJSON 方法
func (u User) MarshalJSON() ([]byte, error) {
    // 自定義 JSON 輸出格式
    return json.Marshal(struct {
        FullName string `json:"name"`
        Age      int    `json:"age"`
        Email    string `json:"email_address"`
    }{
        FullName: u.Name,
        Age:      u.Age,
        Email:    u.Email,
    })
}

func main() {
    user := User{Name: "Alice", Age: 30, Email: "alice@example.com"}

    // Marshal 用戶對象為 JSON
    jsonData, err := json.Marshal(user)
    if err != nil {
        fmt.Println("Error marshaling to JSON:", err)
        return
    }

    fmt.Println(string(jsonData)) // 輸出: {"name":"Alice","age":30,"email_address":"alice@example.com"}
}

解釋

• 定義結(jié)構(gòu)體：我們定義了一個 User 結(jié)構(gòu)體，包含 Name、Age 和 Email 字段。
• 實現(xiàn) MarshalJSON 方法：我們?yōu)?nbsp;User 結(jié)構(gòu)體實現(xiàn)了 MarshalJSON 方法。在這個方法中，我們自定義了 JSON 輸出格式。
• 自定義輸出：在 MarshalJSON 方法中，我們使用匿名結(jié)構(gòu)體來定義最終的 JSON 格式。
• 使用 json.Marshal：在 main 函數(shù)中，我們創(chuàng)建了一個 User 實例，并使用 json.Marshal 將其轉(zhuǎn)換為 JSON 字符串。

注意事項

• 錯誤處理：MarshalJSON 方法應返回 error，以便在序列化過程中可以處理潛在的錯誤。
• 遞歸調(diào)用：在 MarshalJSON 方法中，如果調(diào)用 json.Marshal，需要確保所處理的結(jié)構(gòu)體不會遞歸調(diào)用自身的 MarshalJSON 方法。

Marshal函數(shù)將會遞歸遍歷整個對象，依次按成員類型對這個對象進行編碼。

類型轉(zhuǎn)換規(guī)則如下：

• bool類型：轉(zhuǎn)換為JSON的Boolean
• 整數(shù)、浮點數(shù)等數(shù)值類型： 轉(zhuǎn)換為JSON的Number
• string類型： 轉(zhuǎn)換為JSON的字符串(帶""引號)
• struct類型：轉(zhuǎn)換為JSON的Object，再根據(jù)各個成員的類型遞歸打包
• 數(shù)組或切片類型： 轉(zhuǎn)換為JSON的Array
• []byte類型： 會先進行base64編碼然后轉(zhuǎn)換為JSON字符串
• map類型：轉(zhuǎn)換為JSON的Object，key必須是string
• interface{}類型： 按照內(nèi)部的實際類型進行轉(zhuǎn)換
• nil類型： 轉(zhuǎn)為JSON的null
• channel,func等類型： 會返回UnsupportedTypeError

從golang到j(luò)son：

從json到golang：

避坑

json.marshal使用不當，會存在base64編碼問題問題出現(xiàn)在：[]byte 在json.marshal時會進行base64 encoding處理

解決辦法：使用json.RawMessagejson.RawMessage其實就是[]byte類型的重定義。可以進行強制類型轉(zhuǎn)換。

現(xiàn)在有這么一種場景，結(jié)構(gòu)體中的其中一個字段的格式是未知的：

type Command struct {  
    ID   int  
    Cmd  string  
    Args *json.RawMessage  
}  

使用json.RawMessage的話，Args字段在Unmarshal時不會被解析，直接將字節(jié)數(shù)據(jù)賦值給Args。我們可以能先解包第一層的JSON數(shù)據(jù)，然后根據(jù)Cmd的值，再確定Args的具體類型進行第二次Unmarshal。

注意：一定要使用指針類型*json.RawMessage，否則在Args會被認為是[]byte類型，在打包時會被打包成base64編碼的字符串。

使用interface{}, interface{}類型在Unmarshal時，會自動將JSON轉(zhuǎn)換為對應的數(shù)據(jù)類型：

JSON的boolean: 轉(zhuǎn)換為bool
JSON的數(shù)值: 轉(zhuǎn)換為float64
JSON的字符串: 轉(zhuǎn)換為string
JSON的Array: 轉(zhuǎn)換為[]interface{}
JSON的Object: 轉(zhuǎn)換為map[string]interface{}
JSON的null: 轉(zhuǎn)換為nil

需要注意的有兩個:

• 一是所有的JSON數(shù)值自動轉(zhuǎn)換為float64類型，使用時需要再手動轉(zhuǎn)換為需要的int，int64等類型。
• 二是JSON的object自動轉(zhuǎn)換為map[string]interface{}類型，訪問時直接用JSON Object的字段名作為key進行訪問。在不知道JSON數(shù)據(jù)的格式時，可以使用interface{}。

自定義類型：如果希望自己定義對象的打包解包方式，可以實現(xiàn)以下的接口：

type Marshaler interface {  
    MarshalJSON() ([]byte, error)  
}  
type Unmarshaler interface {  
    UnmarshalJSON([]byte) error  
}  

實現(xiàn)該接口的對象需要將自己的數(shù)據(jù)打包和解包。如果實現(xiàn)了該接口，json在打包解包時則會調(diào)用自定義的方法，不再對該對象進行其他處理。

總結(jié)

通過實現(xiàn) MarshalJSON 方法，可以為 Go 的自定義類型提供靈活的 JSON 序列化控制。這使得在與 JSON 數(shù)據(jù)交互時，可以更好地控制數(shù)據(jù)的結(jié)構(gòu)和格式。

到此這篇關(guān)于golang MarshalJson的實現(xiàn)的文章就介紹到這了,更多相關(guān)golang MarshalJson內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論