Go 语言标准库中encoding/json模块详细功能介绍与示例

Go语言的encoding/json模块提供了丰富的JSON编解码方法,以下是对各主要方法及结构体标签的详细说明和示例:


1. json.Marshal

将Go对象转换为JSON字节切片。

go 复制代码
type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

p := Person{"Alice", 30}
data, err := json.Marshal(p)
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(data)) // 输出: {"name":"Alice","age":30}

2. json.Unmarshal

将JSON字节切片解析到Go对象。

go 复制代码
jsonStr := `{"name":"Bob","age":25}`
var p Person
err := json.Unmarshal([]byte(jsonStr), &p)
if err != nil {
    log.Fatal(err)
}
fmt.Println(p.Name) // 输出: Bob

3. json.MarshalIndent

生成带缩进格式的JSON。

go 复制代码
data, err := json.MarshalIndent(p, "", "  ")
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(data))
// 输出:
// {
//   "name": "Alice",
//   "age": 30
// }

4. json.NewEncoderEncoder.Encode

将JSON写入io.Writer(如文件或HTTP响应)。

go 复制代码
file, _ := os.Create("person.json")
encoder := json.NewEncoder(file)
err := encoder.Encode(p)
if err != nil {
    log.Fatal(err)
}
// 文件内容: {"name":"Alice","age":30}

5. json.NewDecoderDecoder.Decode

io.Reader(如文件或HTTP请求)读取并解析JSON。

go 复制代码
file, _ := os.Open("person.json")
var p Person
decoder := json.NewDecoder(file)
err := decoder.Decode(&p)
if err != nil {
    log.Fatal(err)
}
fmt.Println(p.Name) // 输出: Alice

6. Encoder.SetEscapeHTML

控制是否转义HTML字符(默认true)。

go 复制代码
encoder := json.NewEncoder(os.Stdout)
encoder.SetEscapeHTML(false)
encoder.Encode("<div>test</div>")
// 输出: "<div>test</div>"

7. Decoder.DisallowUnknownFields

禁止JSON中出现未知字段。

go 复制代码
jsonStr := `{"name":"Charlie","age":35,"gender":"male"}`
decoder := json.NewDecoder(strings.NewReader(jsonStr))
decoder.DisallowUnknownFields()
err := decoder.Decode(&p) // 报错: json: unknown field "gender"

8. Decoder.UseNumber

将数字解析为json.Number类型(避免精度丢失)。

go 复制代码
jsonStr := `{"age": 30}`
decoder := json.NewDecoder(strings.NewReader(jsonStr))
decoder.UseNumber()
var result map[string]interface{}
decoder.Decode(&result)
age, _ := result["age"].(json.Number).Int64()
fmt.Println(age) // 输出: 30

9. json.Valid

验证字节切片是否为合法JSON。

go 复制代码
data := []byte(`{"name":"Alice"}`)
valid := json.Valid(data)
fmt.Println(valid) // 输出: true

10. json.RawMessage

延迟解析部分JSON数据。

go 复制代码
type RawExample struct {
    Data json.RawMessage `json:"data"`
}
rawJson := `{"data": {"key": "value"}}`
var re RawExample
json.Unmarshal([]byte(rawJson), &re)
// re.Data 保持原始JSON: {"key":"value"}

结构体标签(Struct Tags)

控制JSON字段名称、忽略字段等。

go 复制代码
type User struct {
    Name    string `json:"username"`          // 字段重命名为username
    Age     int    `json:"age,omitempty"`     // 如果Age为0,则省略
    Secret  string `json:"-"`                 // 忽略该字段
}

u := User{Name: "Dave", Age: 0}
data, _ := json.Marshal(u)
fmt.Println(string(data)) // 输出: {"username":"Dave"}

总结

  • 常用方法MarshalUnmarshalMarshalIndentNewEncoderNewDecoder
  • 流处理 :使用EncoderDecoder处理网络或文件流。
  • 高级控制SetEscapeHTMLDisallowUnknownFieldsUseNumber
  • 验证与延迟解析ValidRawMessage
  • 字段定制:通过结构体标签灵活控制JSON映射。

这些方法覆盖了JSON处理的大部分场景,从简单序列化到复杂的流式处理均可应对。

相关推荐
平头哥技术团队33 分钟前
Day 10 | 工欲善其事:VS Code 配置与项目归档
android·开发语言·前端·javascript·html·交互
乌萨奇也要立志学C++34 分钟前
【洛谷】kmp算法
开发语言·算法
传奇开心果编程1 小时前
【Rust入门知识点学与练】第4课:条件判断 if / else
开发语言·学习·rust
m0_380743871 小时前
给 Claude API 调用补上超时重试和错误分类
开发语言·人工智能·php
Draw Stars1 小时前
Git BASH安装教程
开发语言·git·bash
步行cgn1 小时前
YAML 的语法规则
spring boot·后端
vortex51 小时前
一文讲透 Zsh 与 Bash 的区别
开发语言·bash
千谦阙听1 小时前
C++类和对象(中):默认成员函数、构造与析构、拷贝构造、运算符重载
开发语言·c++·学习
骇客野人2 小时前
SpringBoot电商系统用户注册、登录、留存及数据埋点设计与落地实施方案
java·spring boot·后端
IT_陈寒5 小时前
React的状态更新坑得我差点加班到天亮
前端·人工智能·后端