Go语言中json.Marshal的正确使用：解决空JSON输出与字节切片困惑-Golang-PHP中文网

Go语言中json.Marshal的正确使用：解决空JSON输出与字节切片困惑

碧海醫心

发布： 2025-11-20 11:46:43

原创

953人浏览过

Go语言中json.Marshal的正确使用：解决空JSON输出与字节切片困惑

本文深入探讨go语言中encoding/json包的json.marshal函数在使用时常遇到的两个核心问题：结构体字段未导出导致生成空json对象，以及json.marshal返回字节切片而非直接的字符串。通过详细的解释和代码示例，我们将学习如何正确地定义可序列化的结构体，并处理json.marshal的输出，从而生成预期的json字符串。

理解Go语言的JSON序列化机制

在Go语言中，encoding/json包提供了强大的功能，用于将Go结构体转换为JSON格式（序列化或编码），以及将JSON数据解析回Go结构体（反序列化或解码）。json.Marshal函数是实现序列化的核心工具。然而，初学者在使用该函数时，常常会遇到一些看似“奇怪”的输出，例如得到空的JSON对象{}或一串数字[123 125]。这通常源于对Go语言的可见性规则和json.Marshal返回类型的不完全理解。

问题一：结构体字段未导出导致空JSON输出

json.Marshal在将Go结构体序列化为JSON时，默认只会处理结构体中已导出（Exported）的字段。在Go语言中，一个字段是否导出，取决于其名称的首字母大小写：

首字母大写：表示该字段是已导出的（Public），可以在包外部访问，并且json.Marshal可以对其进行序列化。
首字母小写：表示该字段是未导出的（Private），只能在定义它的包内部访问，json.Marshal无法访问和序列化这些字段。

当结构体中所有希望被序列化的字段都是未导出时，json.Marshal将无法找到任何可序列化的数据，因此会生成一个空的JSON对象{}。

示例：错误的使用方式

立即学习“go语言免费学习笔记（深入）”；

考虑以下结构体定义：

package main

import (
    "encoding/json"
    "fmt"
)

type Zoo struct {
    name string        // 未导出字段
    animals []Animal   // 未导出字段
}

type Animal struct {
    species string     // 未导出字段
    says string        // 未导出字段
}

func main() {
    zoo := Zoo{
        name: "Magical Mystery Zoo",
        animals: []Animal{
            {"Cow", "Moo"},
            {"Cat", "Meow"},
            {"Fox", "???"},
        },
    }

    zooJson, err := json.Marshal(zoo)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    fmt.Println("原始结构体:", zoo)
    fmt.Println("json.Marshal 输出:", string(zooJson)) // 转换为字符串以便查看
}

登录后复制

上述代码的输出将是：

原始结构体: {Magical Mystery Zoo [{Cow Moo} {Cat Meow} {Fox ???}]}
json.Marshal 输出: {}

登录后复制

尽管zoo结构体本身包含数据，但json.Marshal输出的JSON却是空的{}，原因就是Zoo和Animal结构体中的所有字段（name, animals, species, says）都是首字母小写的未导出字段。

解决方案一：导出结构体字段

要解决这个问题，只需将结构体中需要序列化的字段首字母改为大写，使其成为已导出字段。

package main

import (
    "encoding/json"
    "fmt"
)

type Zoo struct {
    Name string        // 已导出字段
    Animals []Animal   // 已导出字段
}

type Animal struct {
    Species string     // 已导出字段
    Says string        // 已导出字段
}

func main() {
    zoo := Zoo{
        Name: "Magical Mystery Zoo",
        Animals: []Animal{
            {"Cow", "Moo"},
            {"Cat", "Meow"},
            {"Fox", "???"},
        },
    }

    zooJson, err := json.Marshal(zoo)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    fmt.Println("原始结构体:", zoo)
    fmt.Println("json.Marshal 输出:", string(zooJson))
}

登录后复制

现在，json.Marshal将能够正确地访问并序列化这些字段，输出将接近预期：

OmniAudio

OmniAudio 是一款通过 AI 支持将网页、Word 文档、Gmail 内容、文本片段、视频音频文件都转换为音频播客，并生成可在常见 Podcast ap

111

查看详情

原始结构体: {Magical Mystery Zoo [{Cow Moo} {Cat Meow} {Fox ???}]}
json.Marshal 输出: {"Name":"Magical Mystery Zoo","Animals":[{"Species":"Cow","Says":"Moo"},{"Species":"Cat","Says":"Meow"},{"Species":"Fox","Says":"???"}]}

登录后复制

使用JSON Tag自定义字段名

如果希望JSON输出的字段名与Go结构体字段名不同（例如，Go中使用驼峰命名，JSON中使用蛇形命名），可以使用结构体标签（json tag）来指定。

type Zoo struct {
    Name string `json:"zoo_name"`        // JSON输出时字段名为 "zoo_name"
    Animals []Animal `json:"animals"`
}

type Animal struct {
    Species string `json:"species_name"`
    Says string `json:"sound"`
}

登录后复制

这样，JSON输出会变成：

{
    "zoo_name": "Magical Mystery Zoo",
    "animals": [
        {
            "species_name": "Cow",
            "sound": "Moo"
        },
        {
            "species_name": "Cat",
            "sound": "Meow"
        },
        {
            "species_name": "Fox",
            "sound": "???"
        }
    ]
}

登录后复制

问题二：json.Marshal返回字节切片[]byte

另一个常见的困惑是fmt.Println(zooJson)直接输出一串数字，如[123 125]，而不是可读的JSON字符串。这是因为json.Marshal函数的设计：它返回的是一个字节切片（[]byte），而不是一个Go字符串（string）。

[123 125]实际上是ASCII码，123代表字符{，125代表字符}。这意味着在字段未导出的情况下，json.Marshal生成了空的JSON对象{}，并将其以字节切片的形式返回。当直接打印[]byte时，fmt.Println会默认打印其内部的字节数值表示。

解决方案二：将字节切片转换为字符串

要查看json.Marshal生成的JSON内容，需要将返回的[]byte显式地转换为string类型。

package main

import (
    "encoding/json"
    "fmt"
)

type Zoo struct {
    Name string
    Animals []Animal
}

type Animal struct {
    Species string
    Says string
}

func main() {
    zoo := Zoo{
        Name: "Magical Mystery Zoo",
        Animals: []Animal{
            {"Cow", "Moo"},
            {"Cat", "Meow"},
            {"Fox", "???"},
        },
    }

    zooJson, err := json.Marshal(zoo)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    // 正确的做法：将 []byte 转换为 string
    fmt.Println("序列化后的JSON字符串:", string(zooJson))

    // 如果需要格式化输出，可以使用 json.MarshalIndent
    prettyJson, err := json.MarshalIndent(zoo, "", "    ")
    if err != nil {
        fmt.Println("Error formatting JSON:", err)
        return
    }
    fmt.Println("格式化后的JSON字符串:\n", string(prettyJson))
}

登录后复制

输出将是：

序列化后的JSON字符串: {"Name":"Magical Mystery Zoo","Animals":[{"Species":"Cow","Says":"Moo"},{"Species":"Cat","Says":"Meow"},{"Species":"Fox","Says":"???"}]}
格式化后的JSON字符串:
 {
    "Name": "Magical Mystery Zoo",
    "Animals": [
        {
            "Species": "Cow",
            "Says": "Moo"
        },
        {
            "Species": "Cat",
            "Says": "Meow"
        },
        {
            "Species": "Fox",
            "Says": "???"
        }
    ]
}

登录后复制

通过string(zooJson)，我们得到了可读的JSON字符串。此外，json.MarshalIndent函数可以帮助我们生成带有缩进的、更易读的JSON格式。

总结与注意事项

导出字段是关键：确保所有需要被json.Marshal序列化的结构体字段都以大写字母开头，成为已导出字段。
[]byte到string的转换：json.Marshal返回的是[]byte类型，要以字符串形式查看其内容，务必使用string()进行类型转换。
错误处理：json.Marshal和json.MarshalIndent都可能返回错误，尤其是在处理复杂或循环引用的数据结构时。始终检查err返回值是一个良好的编程习惯。
JSON Tag：利用结构体标签（json:"fieldName"）可以灵活地控制JSON输出的字段名，甚至可以通过json:"-"忽略特定字段，或通过json:",omitempty"在字段为空值时省略该字段。

理解并遵循这些原则，可以有效避免在使用Go语言进行JSON序列化时常见的陷阱，确保程序能够正确、高效地处理JSON数据。

以上就是Go语言中json.Marshal的正确使用：解决空JSON输出与字节切片困惑的详细内容，更多请关注php中文网其它相关文章！