0

0

Golang项目中错误处理规范示例

P粉602998670

P粉602998670

发布时间:2026-01-12 16:31:28

|

706人浏览过

|

来源于php中文网

原创

Go 错误必须显式判断,不可忽略;应使用 %w 包装、errors.Is 判断、统一 HTTP 错误映射,并在测试中覆盖各类错误场景。

golang项目中错误处理规范示例

Go 中错误类型必须显式判断,不能忽略 error 返回值

Go 的设计哲学是“错误不是异常”,error 是普通返回值,不处理就等于放任失败。常见错误是写成 json.Unmarshal(data, &v) 后直接用 v,没检查第二个返回的 error。一旦解码失败,v 处于未定义状态,后续逻辑可能 panic 或静默出错。

正确做法是每次调用后立即判断:

if err := json.Unmarshal(data, &v); err != nil {
    return fmt.Errorf("failed to parse config: %w", err)
}
  • 永远不要用 _ 忽略 error,除非你明确知道该函数在当前上下文中绝不会返回非 nil 错误(如 fmt.Sprintf
  • %w 包装错误可保留原始调用链,方便后续用 errors.Iserrors.As 判断
  • 避免裸写 return err 在业务入口,应补充上下文,比如 return fmt.Errorf("create user: %w", err)

自定义错误类型优先用 errors.Newfmt.Errorf,而非结构体

90% 的场景不需要定义新 struct 类型来表示错误。过度封装会增加维护成本,且 Go 标准库的错误处理机制(如 errors.Iserrors.Unwrap)对字符串错误同样有效。

反例(不必要):

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

type ValidationError struct {
    Field string
    Msg   string
}
func (e *ValidationError) Error() string { return e.Msg }

正例(更轻量、更通用):

ClipDrop Relight
ClipDrop Relight

ClipDrop推出的AI图片图像打光工具

下载
err := fmt.Errorf("validation failed on field %q: %w", field, errors.New("must be non-empty"))
  • 需要携带字段或状态时,用 fmt.Errorf + 命名参数(如 fmt.Errorf("timeout after %v: %w", timeout, err))更清晰
  • 只有当需实现特定接口(如 Timeout() bool)或需被第三方库深度集成时,才考虑自定义 error struct
  • 所有自定义 error 类型必须实现 Error() string,且不应暴露内部字段给调用方直接比较

HTTP handler 中错误要转为标准状态码,避免泄露内部细节

Web 服务中,把底层存储错误(如 "pq: duplicate key violates unique constraint")直接返回给前端,既不安全也不友好。应统一拦截、分类、映射。

推荐在中间件或统一响应构造处处理:

func handleError(w http.ResponseWriter, err error) {
    switch {
    case errors.Is(err, sql.ErrNoRows):
        http.Error(w, "not found", http.StatusNotFound)
    case strings.Contains(err.Error(), "duplicate key"):
        http.Error(w, "conflict", http.StatusConflict)
    default:
        log.Printf("unhandled error: %v", err)
        http.Error(w, "internal error", http.StatusInternalServerError)
    }
}
  • 不要用 http.Error 返回原始错误消息,尤其涉及数据库、文件路径、配置键名等敏感信息
  • errors.Is 比对已知错误(如 os.ErrNotExist),比字符串匹配更健壮
  • 若使用 Gin/Echo 等框架,应在全局 Recovery 中间件里做类似转换,而不是每个 handler 里重复写

测试中验证错误行为比验证成功路径更重要

很多 Go 项目只测“能跑通”,但线上故障往往来自边界错误。比如一个依赖外部 API 的函数,必须测它在 HTTP 超时、JSON 解析失败、空响应等场景下是否返回预期错误类型和消息。

示例测试片段:

func TestFetchUser(t *testing.T) {
    server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.WriteHeader(http.StatusBadGateway)
        w.Write([]byte(`{"error":"upstream failed"}`))
    }))
    defer server.Close()

    _, err := FetchUser(context.Background(), server.URL)
    if !strings.Contains(err.Error(), "upstream failed") {
        t.Fatal("expected upstream error in message")
    }
    if !errors.Is(err, ErrUpstreamFailed) {
        t.Fatal("expected ErrUpstreamFailed error")
    }
}
  • httptest.Servermock 替换真实依赖,精准控制错误触发点
  • 断言既要检查错误文本是否含关键信息,也要用 errors.Is 验证错误类型归属
  • 别忘了测试 context.Canceledcontext.DeadlineExceeded 这类系统级错误的传播路径
错误处理在 Go 里不是附加动作,而是接口契约的一部分。最常被跳过的其实是「错误是否被日志记录」「错误是否被监控捕获」「错误是否提供了用户可操作的修复提示」——这些不在代码语法里,却决定线上问题的平均恢复时间。

相关专题

更多
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

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

9

2026.01.12

热门下载

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

精品课程

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