Go语言如何做接口响应统一格式_Golang封装code msg data结构

夏静君_8418

夏静君_8418

2026-05-30

154人浏览

原创

最稳妥方式是每个handler显式构造response结构体并调用json.newencoder(w).encode(),避免中间件自动包装;response需含code、msg、data、timestamp字段,http状态码与业务码解耦,所有分支统一走同一响应路径。

go语言如何做接口响应统一格式_golang封装code msg data结构

Go 语言做接口响应统一格式,最稳妥的方式是**每个 handler 显式构造结构体 + json.NewEncoder(w).Encode()**,而不是依赖中间件自动包装。中间件在 panic、提前 http.Error 或多次 WriteHeader 时极易出错,反而增加维护成本。

定义 Response 结构体要注意字段导出和 JSON tag

结构体字段必须首字母大写才能被 json.Marshal 序列化;json tag 缺一不可,且不能拼错:

type Response struct {
    Code    int         `json:"code"`
    Msg     string      `json:"msg"`
    Data    interface{} `json:"data,omitempty"`
    Timestamp int64     `json:"timestamp"`
}
  • Timestamp 用 int64(如 time.Now().UnixMilli()),前端直接 Date.now() 对齐,不传 time.Time 避免时区和格式歧义
  • Data 用 interface{} 是为了泛型兼容,但实际传入应是具体 struct(如 User{}),不是 map[string]interface{} —— 否则 Swagger 和 TypeScript 类型推导失效
  • 别加 Pagination 字段到顶层:它只属于列表接口的 Data 内部(如 Data: struct{ List []User; Pagination Pagination }{})

handler 里别用 Success/Fail 工具函数封装业务语义

Success()、Fail() 这类方法容易把业务逻辑(比如 “登录失败” vs “参数错误”)和协议层(HTTP 状态码、JSON 序列化)混在一起。它们不该决定 Code 是 0 还是 200,也不该内置 "success" 字符串。

Golang Naming
Golang Naming

Go(Golang)命名规范 — 包括包、构造函数、结构体、接口、常量、枚举、错误、布尔值、接收器、getter/setter、函数等。

下载
  • 真正该封装的只有三件事:w.Header().Set("Content-Type", "application/json")、json.NewEncoder(w).Encode(resp)、w.WriteHeader(statusCode)
  • 业务码和 HTTP 状态码要解耦:HTTP 状态码走 w.WriteHeader()(如 http.StatusOK、http.StatusBadRequest),业务码走 Response.Code 字段(如 1001 表示“用户不存在”)
  • 如果真要简化,只封装序列化动作,例如:func WriteJSON(w http.ResponseWriter, status int, v interface{}) { w.WriteHeader(status); json.NewEncoder(w).Encode(v) }

为什么不要用中间件自动包装返回体

中间件拦截 Write 的方式看似省事,但实际踩坑率极高:

  • handler 里调了 http.Error(w, "...", 400),中间件仍尝试读取空 body 并 marshal,结果返回 {"code":200,"msg":"success","data":null} —— 错误被吞掉
  • handler panic 了,中间件还没来得及 wrap 就已崩溃,日志里看不到原始错误上下文
  • 多个中间件叠加时,header 可能被重复设置,触发 http: superfluous response.WriteHeader call panic
  • 无法判断 handler 是否已调用 w.WriteHeader,强行覆盖会破坏 HTTP 流程(比如流式响应、文件下载)

真正难的不是写一个通用结构体,而是坚持让每个 handler 在末尾显式构造 Response 并调用一次 WriteJSON —— 所有分支(包括 error 分支)都走同一路径,才能保证前端永远拿到可预测的 shape。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang go语言

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2989

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2228

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2078

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3280

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14715

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程