0

0

如何在Golang中实现JSON API接口_Golang JSON数据解析与返回示例

P粉602998670

P粉602998670

发布时间:2026-01-06 16:53:02

|

182人浏览过

|

来源于php中文网

原创

Go中返回JSON需手动调用json.Marshal并设Content-Type;解析请求体要用json.Unmarshal配合类型安全结构体;大响应推荐json.Encoder流式编码;结构体字段应合理使用omitempty标签控制零值输出。

如何在golang中实现json api接口_golang json数据解析与返回示例

json.Marshalhttp.ResponseWriter 返回 JSON 响应

Go 标准库不自动序列化结构体为 JSON,必须显式调用 json.Marshal,再手动写入响应体。常见错误是忘记设置 Content-Type: application/json,导致前端解析失败或浏览器直接下载文件。

关键点:

  • 务必在 WriteHeaderWrite 前调用 w.Header().Set("Content-Type", "application/json")
  • json.Marshal 返回 []byteerror,不能忽略错误(如含不可序列化字段的 struct)
  • 避免直接拼接字符串返回 JSON,既不安全也不符合标准
func handler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    data := map[string]interface{}{
        "id":   123,
        "name": "alice",
        "tags": []string{"go", "api"},
    }
    b, err := json.Marshal(data)
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    w.WriteHeader(http.StatusOK)
    w.Write(b)
}

json.Unmarshal 解析请求体中的 JSON 数据

HTTP 请求体(如 POST/PUT)的 JSON 数据需手动读取并反序列化。容易出错的地方包括:未限制读取长度、未检查 Content-Type 头、未处理空 body 或非法编码

建议做法:

立即学习go语言免费学习笔记(深入)”;

知元AI
知元AI

AI智能语音聊天 对讲问答 AI绘画 AI写作 AI创作助手工具

下载
  • 先检查 r.Header.Get("Content-Type") 是否包含 application/json
  • io.LimitReader(r.Body, 1048576) 限制最大读取 1MB,防内存耗尽
  • json.Unmarshal 解析到预定义结构体(而非 map[string]interface{}),利于类型安全和字段校验
type UserRequest struct {
    Name  string `json:"name"`
    Email string `json:"email"`
}

func createUser(w http.ResponseWriter, r *http.Request) {
    if r.Header.Get("Content-Type") != "application/json" {
        http.Error(w, "Content-Type must be application/json", http.StatusBadRequest)
        return
    }

    var req UserRequest
    decoder := json.NewDecoder(io.LimitReader(r.Body, 1048576))
    if err := decoder.Decode(&req); err != nil {
        http.Error(w, "Invalid JSON", http.StatusBadRequest)
        return
    }

    // 处理业务逻辑...
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(map[string]string{"status": "created"})
}

json.Encoder 替代 json.Marshal 避免中间字节切片

当响应数据较大(如列表导出、日志流)时,json.Marshal 会先全部加载进内存再写入,可能触发 GC 或 OOM。此时应直接用 json.NewEncoder(w).Encode(v) 流式编码。

注意:

  • json.Encoder 会自动处理 http.ResponseWriter 的写入,但不会自动设 Content-Type,仍需手动设置
  • 它对 error 的处理更“静默”——失败时只返回 error,不自动中断响应,需显式检查
  • 不适用于需要修改 JSON 字节后再发送的场景(如加签名、压缩)
func listItems(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")

    items := []map[string]string{
        {"id": "1", "title": "first"},
        {"id": "2", "title": "second"},
    }

    enc := json.NewEncoder(w)
    if err := enc.Encode(items); err != nil {
        // 此处 err 可能是写入失败(如客户端断连),需记录但通常不重试
        log.Printf("encode error: %v", err)
    }
}

结构体字段标签与零值处理:为什么 omitempty 很关键

Go 的 JSON 序列化默认导出所有字段,但空字符串、零值数字、nil 切片等常不希望出现在响应中。这时必须用 json:"field,omitempty" 标签控制。

典型陷阱:

  • 忘记加 omitempty 导致前端收到 "count": 0"name": "",误判为有效值
  • 混用指针字段(如 *string)和 omitempty,结果字段完全消失,调试困难
  • omitempty 对布尔字段无效(false 总被忽略),需用 *bool 或自定义 MarshalJSON
type ApiResponse struct {
    ID     int64  `json:"id"`
    Name   string `json:"name,omitempty"`      // 空字符串时不出现
    Count  int    `json:"count,omitempty"`     // 0 时不出现
    Tags   []string `json:"tags,omitempty"`    // nil 或空切片时不出现
    Active *bool  `json:"active,omitempty"`    // 只有非 nil 才序列化
}
字段名大小写、嵌套结构、时间格式(time.Time 默认转 RFC3339)这些细节不显眼,但上线后最容易引发前后端联调问题。别依赖“看起来能跑”,每个字段的输出都要验证。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

177

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

226

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

336

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

208

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

194

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

189

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

C++ 高性能计算与并行编程
C++ 高性能计算与并行编程

本专题专注于 C++ 在高性能计算(HPC)与并行编程中的应用,涵盖多线程、并发数据处理、OpenMP、MPI、GPU加速等技术。通过实际案例,帮助开发者掌握 如何利用 C++ 进行大规模数据计算和并行处理,提高程序的执行效率,适应高性能计算与数据密集型应用场景。

5

2026.01.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号