如何使用 Go 解析 JSON 文件到结构体-Golang-PHP中文网

如何使用 Go 解析 JSON 文件到结构体

霞舞

发布： 2025-10-11 09:04:47

原创

946人浏览过

如何使用 go 解析 json 文件到结构体

本文介绍了如何使用 Go 语言将 JSON 文件解析到结构体中。重点在于结构体字段的导出，以及如何使用 `json` 标签将 JSON 字段映射到结构体字段。通过示例代码，读者可以了解如何正确定义结构体，并使用 `json.NewDecoder` 或 `json.Unmarshal` 函数进行 JSON 解析。

在 Go 语言中，将 JSON 数据解析到结构体是一项常见的任务，尤其是在处理配置文件或 API 响应时。encoding/json 包提供了强大的支持，但初学者可能会遇到一些问题。本文将详细介绍如何正确地解析 JSON 数据到结构体，并避免常见的陷阱。

结构体定义：导出的重要性

Go 语言的 encoding/json 包在解析 JSON 时，只会处理结构体中已导出的字段。这意味着字段名必须以大写字母开头。如果字段名以小写字母开头，JSON 解析器将忽略它们，导致结构体字段保持其零值。

以下是一个常见的错误示例：

package main

import (
    "encoding/json"
    "fmt"
    "os"
)

type settings struct {
    serverMode bool
    sourceDir  string
    targetDir  string
}

func main() {
    configFile, err := os.Open("config.json")
    if err != nil {
        fmt.Println("Error opening config file:", err)
        return
    }
    defer configFile.Close()

    jsonParser := json.NewDecoder(configFile)
    var config settings
    if err = jsonParser.Decode(&config); err != nil {
        fmt.Println("Error parsing config file:", err)
        return
    }

    fmt.Printf("%v %s %s\n", config.serverMode, config.sourceDir, config.targetDir)
}

登录后复制

config.json 文件内容：

{
    "serverMode": true,
    "sourceDir": ".",
    "targetDir": "."
}

登录后复制

这段代码看似正确，但由于 settings 结构体中的字段 serverMode、sourceDir 和 targetDir 都是未导出的（小写字母开头），因此 JSON 解析器无法将 JSON 数据正确地填充到这些字段中。

正确的做法是将字段名改为大写字母开头，并使用 json 标签来指定 JSON 字段与结构体字段之间的映射关系：

package main

import (
    "encoding/json"
    "fmt"
    "os"
)

type Settings struct {
    ServerMode bool   `json:"serverMode"`
    SourceDir  string `json:"sourceDir"`
    TargetDir  string `json:"targetDir"`
}

func main() {
    configFile, err := os.Open("config.json")
    if err != nil {
        fmt.Println("Error opening config file:", err)
        return
    }
    defer configFile.Close()

    jsonParser := json.NewDecoder(configFile)
    var config Settings
    if err = jsonParser.Decode(&config); err != nil {
        fmt.Println("Error parsing config file:", err)
        return
    }

    fmt.Printf("%v %s %s\n", config.ServerMode, config.SourceDir, config.TargetDir)
}

登录后复制

在这个修改后的版本中，Settings 结构体中的字段 ServerMode、SourceDir 和 TargetDir 都是已导出的。json:"serverMode" 这样的标签告诉 JSON 解析器，将 JSON 中的 serverMode 字段的值赋给结构体中的 ServerMode 字段。

讯飞智作-讯飞配音

讯飞智作是一款集AI配音、虚拟人视频生成、PPT生成视频、虚拟人定制等多功能的AI音视频生产平台。已广泛应用于媒体、教育、短视频等领域。

查看详情

使用 json.NewDecoder 和 json.Unmarshal

Go 语言提供了两种主要的 JSON 解析方法：json.NewDecoder 和 json.Unmarshal。

json.NewDecoder: 适用于从 io.Reader 读取 JSON 数据的情况，例如从文件中读取。它允许逐个解析 JSON 数据流，对于处理大型 JSON 文件非常有效。
json.Unmarshal: 适用于已经将 JSON 数据加载到内存中的情况，例如从 API 响应中获取的字符串。它将 JSON 字节切片直接解析到结构体中。

上面的例子展示了如何使用 json.NewDecoder 从文件中读取 JSON 数据。以下是如何使用 json.Unmarshal 解析 JSON 字符串的示例：

package main

import (
    "encoding/json"
    "fmt"
)

type Settings struct {
    ServerMode bool   `json:"serverMode"`
    SourceDir  string `json:"sourceDir"`
    TargetDir  string `json:"targetDir"`
}

func main() {
    jsonData := `
    {
        "serverMode": true,
        "sourceDir": ".",
        "targetDir": "."
    }
    `

    var config Settings
    err := json.Unmarshal([]byte(jsonData), &config)
    if err != nil {
        fmt.Println("Error unmarshaling JSON:", err)
        return
    }

    fmt.Printf("%v %s %s\n", config.ServerMode, config.SourceDir, config.TargetDir)
}

登录后复制

注意事项

错误处理: 在解析 JSON 数据时，务必检查错误。json.NewDecoder 和 json.Unmarshal 都会返回一个 error 类型的值，如果解析失败，该值将不为 nil。
类型匹配: 确保 JSON 数据中的类型与结构体字段的类型匹配。例如，如果 JSON 字段的值是字符串，而结构体字段的类型是整数，则解析会失败。
默认值: 如果 JSON 数据中缺少某个字段，则结构体字段将保持其零值。可以使用指针类型来区分字段是否存在。
JSON 标签: 使用 json 标签可以自定义 JSON 字段与结构体字段之间的映射关系。这在 JSON 字段名与 Go 字段名不一致时非常有用。