Go语言新手求教：如何自定义JSON响应结构？

嗨，作为Go语言新手，这个修改其实很容易实现，核心思路是用一个新的结构体来包装你现有的数据，让它匹配你想要的外层status和data结构，具体步骤如下：

1. 定义响应结构体 #

首先创建一个对应目标JSON格式的结构体，它包含两个字段：status（状态码字符串）和data（存储你的人员列表）。注意要给结构体字段加上json:"xxx"标签，确保JSON输出的字段名和你想要的一致：

// 假设你已经定义了Person和Address结构体
type Address struct {
    City  string `json:"city"`
    State string `json:"state"`
}

type Person struct {
    Id        string  `json:"id"`
    Firstname string  `json:"firstname"`
    Lastname  string  `json:"lastname"`
    Address   Address `json:"address"`
}

// 新增响应结构体，匹配目标JSON结构
type Response struct {
    Status string   `json:"status"`
    Data   []Person `json:"data"`
}

2. 构造响应实例 #

把你之前组装好的people列表赋值给Response的Data字段，同时设置Status为"200"：

var people []Person
people = append(people, Person{Id: "1", Firstname: "John", Lastname: "Doe", Address: Address{City: "City X", State: "State X"}})
people = append(people, Person{Id: "2", Firstname: "Koko", Lastname: "Doe", Address: Address{City: "City Z", State: "State Y"}})
people = append(people, Person{Id: "3", Firstname: "Francis", Lastname: "Sunday"})

// 构造符合要求的响应对象
resp := Response{
    Status: "200",
    Data:   people,
}

3. 编码响应对象 #

最后修改JSON编码的目标，从原来的people数组改成刚构造的resp对象：

w.Header().Set("Content-Type", "application/json")
// 编码Response结构体而不是直接编码people数组
json.NewEncoder(w).Encode(resp)

额外优化（可选） #

如果你希望当Address的字段为空时，JSON里不显示address字段，可以给Person结构体的Address字段加上omitempty标签：

type Person struct {
    Id        string  `json:"id"`
    Firstname string  `json:"firstname"`
    Lastname  string  `json:"lastname"`
    Address   Address `json:"address,omitempty"`
}

这样第三个人员的输出就会变成：

{
 "id": "3",
 "firstname": "Francis",
 "lastname": "Sunday"
}

内容的提问来源于stack exchange，提问作者Ashish Kafle