0

0

Golang库代码中错误处理的设计原则

P粉602998670

P粉602998670

发布时间:2026-01-13 13:33:01

|

131人浏览过

|

来源于php中文网

原创

Go错误处理应避免字符串匹配,优先用errors.Is/As和导出错误变量;库中禁用panic除非编程错误;错误信息需含上下文但不冗余或泄露敏感数据;公开错误契约须稳定并文档化。

golang库代码中错误处理的设计原则

错误值应该可判断而非仅靠字符串匹配

Go 中的 error 是接口,不是字符串。用 err.Error() == "xxx" 判断错误类型是脆弱的:一旦底层库修改了错误消息(比如加了空格、翻译成英文、补充上下文),你的判断就失效了。

正确做法是使用类型断言或标准库提供的判断函数:

  • 对自定义错误,导出可比较的变量,如 var ErrNotFound = errors.New("not found"),然后用 errors.Is(err, ErrNotFound)
  • 对包装错误(如 fmt.Errorf("failed: %w", io.EOF)),必须用 errors.Is()errors.As(),不能用 ==
  • 调用第三方库时,优先查其文档是否导出了错误变量(如 sql.ErrNoRows),而不是硬编码字符串

不要在库中 panic,除非是真正的编程错误

库代码面向调用方,panic 会中断调用,且无法被常规 recover 捕获(尤其跨包时行为不可控)。只有以下情况才考虑 panic:

  • 违反函数前提条件(precondition),例如传入 nil 指针且文档明确要求非空
  • 内部状态严重不一致(如 sync.Pool 返回了已释放对象)
  • 配置解析失败且该配置由库自身硬编码、不可能出错——但这种情况本身就该避免

常见反例:json.Unmarshal 遇到非法 JSON 返回 errortime.Parse 格式错误也返回 error;它们从不 panic。

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

成新网络商城购物系统
成新网络商城购物系统

使用模板与程序分离的方式构建,依靠专门设计的数据库操作类实现数据库存取,具有专有错误处理模块,通过 Email 实时报告数据库错误,除具有满足购物需要的全部功能外,成新商城购物系统还对购物系统体系做了丰富的扩展,全新设计的搜索功能,自定义成新商城购物系统代码功能代码已经全面优化,杜绝SQL注入漏洞前台测试用户名:admin密码:admin888后台管理员名:admin密码:admin888

下载

错误信息要包含上下文,但避免冗余和敏感数据

库返回的错误应帮助调用方定位问题,而不是让对方再层层打日志。但“加 context”不等于无脑拼接字符串。

  • fmt.Errorf("read header: %w", err) 包装,保留原始错误链,支持 errors.UnwrapIs/As
  • 避免重复前缀:如果调用方已在日志里打了 "[upload] failed",库里就不必再写 "upload: failed to write file: permission denied"
  • 绝不把用户输入、token、密码、路径全量塞进错误字符串——攻击者可能通过 API 错误响应获取敏感信息
func (s *Service) CreateUser(ctx context.Context, u User) error {
	if u.Email == "" {
		return fmt.Errorf("CreateUser: email required") // ✅ 清晰、无敏感内容、可定位
	}
	if err := s.store.Insert(ctx, u); err != nil {
		return fmt.Errorf("CreateUser: insert user: %w", err) // ✅ 包装并保留原始错误
	}
	return nil
}

公开接口的错误返回需稳定,且文档化

库的 API 错误契约是公共合约的一部分。一旦声明某个函数可能返回 io.EOF 或自定义 ErrTimeout,就不能在后续版本中静默替换为其他错误类型,否则调用方的 errors.Is(err, io.EOF) 会突然失效。

  • godoc 注释里明确列出所有可能返回的错误,尤其是自定义错误变量
  • 避免用 errors.New("unknown error") 这类模糊错误;要么导出具体变量,要么确保它能被 errors.Is 合理识别
  • 如果必须变更错误行为(如升级依赖导致底层错误类型变化),属于不兼容变更,需升主版本号

最常被忽略的一点:错误的「可测试性」。如果你的库导出错误变量,测试才能用 assert.Equal(t, err, mypkg.ErrInvalidID);如果只返回临时 errors.New,测试只能退化为字符串匹配,这就回到了第一个坑。

相关专题

更多
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结构体相关大全,想了解更多内容,请阅读专题下面的文章。

195

2025.06.09

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

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

189

2025.06.10

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

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

192

2025.06.17

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

1

2026.01.13

热门下载

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

精品课程

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