0

0

Golang在API设计中选择指针还是值类型

P粉602998670

P粉602998670

发布时间:2026-01-11 18:49:18

|

633人浏览过

|

来源于php中文网

原创

优先接收T,除非结构体大或需修改原值;返回值同理,仅当需表达“无值”或避免大对象复制时用T;JSON字段用string仅当需区分“未提供”与“空字符串”。

golang在api设计中选择指针还是值类型

接收参数时用 *T 还是 T?看是否需要修改原值

Go 函数参数是值传递,传 T 会复制整个结构体;传 *T 只复制指针(8 字节),且能修改调用方的原始数据。API 处理函数(如 HTTP handler)通常不希望副作用,所以多数情况应接收 T —— 尤其是小结构体(如 type User struct { ID int; Name string })。只有明确需要就地更新字段(比如解析请求后填充默认值并复用该实例),才考虑接收 *T

  • 接收 *T 时,调用方必须确保传入非 nil 指针,否则运行时报 panic: runtime error: invalid memory address
  • 如果结构体含 sync.Mutex 或其他不可拷贝字段,编译器会强制你用 *T(因为 T 无法赋值)
  • JSON 反序列化常写成 json.Unmarshal(data, &v),这里 &v 是惯用法,不是 API 设计偏好 —— 它本质是为让 Unmarshal 能写入内存

返回值用 *T 还是 T?优先 T,除非对象大或需区分零值

返回 T 更安全:调用方无需检查 nil,也不用担心悬空指针。但两种场景适合返回 *T

  • 结构体较大(比如超过 64 字节),避免复制开销(可通过 go tool compile -S yourfile.go 查看是否逃逸)
  • 需要表达“无值”语义,例如查找失败时返回 nil*User 可为 nil,User 不行)
  • 类型实现了接口,且需保持方法集一致(比如 io.Reader 的实现通常以指针形式返回)

注意:不要为“看起来更像 OOP”而盲目返回指针 —— Go 的 func (T) Method()func (*T) Method() 方法集不同,混用易导致接口实现意外丢失。

在 JSON API 中,struct 字段该用 *string 还是 string?按语义决定

这是最常被误用的点。用 *string 的唯一合理理由是:要区分「字段未提供」和「字段显式设为空字符串」。例如 PATCH 请求中,只更新部分字段:

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

小蓝本
小蓝本

ToB智能销售增长平台

下载
type UpdateUserRequest struct {
    Name *string `json:"name,omitempty"`
    Age  *int    `json:"age,omitempty"`
}

这样你能判断:req.Name == nil 表示客户端没传 name,跳过更新;*req.Name == "" 表示客户端传了空字符串,要清空名字。

  • 若业务上「空字符串」和「未提供」等价,一律用 string —— 简单、高效、不易出错
  • *string 会增加 GC 压力(每次解析都 new 一个 string),且 JSON 序列化时对 nil 指针输出 null,前端可能未适配
  • 切勿对所有字段无脑加 *:比如 ID uint64 绝对不该是 *uint64,因为 ID 不可能“未提供却合法”

嵌套结构体字段要不要用指针?看是否允许为 nil

嵌套时是否用指针,取决于该子结构在业务逻辑中能否合法为 nil。例如:

type Order struct {
    ID     uint64 `json:"id"`
    User   *User  `json:"user,omitempty"` // 订单可暂无绑定用户
    Items  []Item `json:"items"`
}

type User struct {
    ID   uint64 `json:"id"`
    Name string `json:"name"`
}

这里 User 用指针,是因为订单创建初期可能尚未关联用户;而 Items 是切片(引用类型),天然支持空值,没必要包一层 *[]Item

  • 切片、map、channel、func、interface 本身是指针包装类型,内部已含 nil 状态,无需额外加 *
  • 嵌套结构体若总是存在(如 AddressUser 的必需字段),就用 Address Address,避免强制解引用和 nil 检查
  • 使用 sql.NullString 等类型时,它内部已是 *string,外部字段直接声明为 sql.NullString 即可,不用再套指针

最易忽略的是:指针字段在 JSON 序列化/反序列化时行为不一致,且容易在日志、调试中因 nil panic,上线前务必用真实请求覆盖所有字段组合路径。

相关专题

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

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

178

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、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

337

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数组用法,想了解更多的相关内容,请阅读专题下面的文章。

192

2025.06.17

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

80

2026.01.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号