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处理的大部分场景,从简单序列化到复杂的流式处理均可应对。

相关推荐
偷光1 小时前
浏览器中的隐藏IDE: Elements (元素) 面板
开发语言·前端·ide·php
Paul_09201 小时前
golang面经——内存相关模块
服务器·网络·golang
DKPT1 小时前
JVM栈溢出和堆溢出哪个先满?
java·开发语言·jvm·笔记·学习
海梨花1 小时前
今日八股——JVM篇
jvm·后端·面试
gopyer5 小时前
180课时吃透Go语言游戏后端开发6:Go语言的循环语句
开发语言·游戏·golang·循环语句
Pr Young6 小时前
服务优雅停止和服务优雅启动
后端
嘟嘟MD7 小时前
程序员副业 | 2025年9月复盘
后端·aigc
楼田莉子7 小时前
Qt开发学习——QtCreator深度介绍/程序运行/开发规范/对象树
开发语言·前端·c++·qt·学习
尘觉7 小时前
中秋节与 Spring Boot 的思考:一场开箱即用的团圆盛宴
java·spring boot·后端
间彧8 小时前
Seata分布式事务框架详解与项目实战
后端