讲师中心 微信公众号
AI工具推荐 视频效率加速

Golang如何统一项目中的错误定义

小婷同学_3193

小婷同学_3193

发布时间:2026-01-10 16:08:02

|

946人浏览过

|

来源于php中文网

原创

不能只用 errors.New 或 fmt.Errorf,因其导致错误信息分散、无法区分业务/系统错误、下游难判断类型或映射错误码、日志缺上下文;应定义全局错误变量并使用自定义 Error 类型统一管理。

golang如何统一项目中的错误定义

为什么不能只用 errors.New 或 fmt.Errorf

直接用 errors.New("user not found") 或 fmt.Errorf("failed to parse config: %w", err) 看似简单,但会导致几个实际问题:错误信息散落在各处、无法区分业务错误和系统错误、下游难以做类型判断或错误码映射、日志中缺少上下文字段(如请求 ID、用户 ID)。尤其当项目接入监控或需要国际化时,这种写法会让错误处理迅速失控。

定义全局错误变量 + 自定义错误类型

推荐在 pkg/errors 或 internal/errors 包中集中声明错误变量,并搭配自定义结构体承载错误码、HTTP 状态码、可序列化字段。关键不是“造轮子”,而是让错误具备可识别性与可扩展性。

package errors

import "fmt"

type Code int

const (
    ErrUserNotFound Code = 1001
    ErrInvalidToken Code = 1002
    ErrDatabase     Code = 5001
)

type Error struct {
    Code    Code
    Message string
    Status  int // HTTP status, e.g. 404, 401, 500
}

func (e *Error) Error() string {
    return e.Message
}

func (e *Error) ErrorCode() Code {
    return e.Code
}

var (
    UserNotFound = &Error{Code: ErrUserNotFound, Message: "user not found", Status: 404}
    InvalidToken = &Error{Code: ErrInvalidToken, Message: "invalid auth token", Status: 401}
)
  • 所有业务错误都从这里导出变量,避免拼写错误和重复定义
  • *Error 类型可被 errors.Is 和 errors.As 正确识别,支持错误链嵌套
  • 如果需要携带额外字段(如 UserID),可在结构体中添加并实现 Unwrap() 方法

如何包装底层错误而不丢失业务语义

调用数据库、HTTP 客户端等可能返回原始错误时,不能简单用 fmt.Errorf("%w", err) —— 这会丢掉错误码和状态码。必须用自定义构造函数做“语义升格”。

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
func GetUserByID(id int) (*User, error) {
    u, err := db.FindUser(id)
    if err != nil {
        if errors.Is(err, sql.ErrNoRows) {
            return nil, errors.UserNotFound // 直接返回预定义变量
        }
        return nil, &errors.Error{
            Code:    errors.ErrDatabase,
            Message: fmt.Sprintf("failed to get user %d from db: %v", id, err),
            Status:  500,
        }
    }
    return u, nil
}
  • 优先匹配已知底层错误(如 sql.ErrNoRows),映射为明确的业务错误变量
  • 对未知错误,用 &Error{...} 包装,保留原始错误作为 cause(可被 errors.Unwrap 获取)
  • 避免在包装时重复写 “failed to …” —— 预定义变量的 Message 已足够清晰,额外描述应放在日志里,而非错误值中

HTTP handler 中如何统一响应错误

在 handler 层,不要每个地方都写 if err != nil { w.WriteHeader(404); json.NewEncoder(w).Encode(...)} 。用中间件或封装的响应函数统一处理。

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

func JSONError(w http.ResponseWriter, err error, statusCode int) {
    var appErr *errors.Error
    if errors.As(err, &appErr) {
        statusCode = appErr.Status
    }

    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(statusCode)

    json.NewEncoder(w).Encode(map[string]interface{}{
        "error": map[string]interface{}{
            "code":    appErr.Code,
            "message": appErr.Message,
        },
    })
}

// 使用示例
func userHandler(w http.ResponseWriter, r *http.Request) {
    u, err := GetUserByID(123)
    if err != nil {
        JSONError(w, err, 0) // 0 表示由 JSONError 内部决定状态码
        return
    }
    json.NewEncoder(w).Encode(u)
}
  • JSONError 通过 errors.As 提取自定义错误字段,其他错误(如 panic 捕获或 net/http 超时)走默认状态码
  • 不强制要求所有错误都必须是 *errors.Error,兼容标准库错误,避免过度约束
  • 如果项目用 Gin/Echo,可进一步封装成 c.AbortWithStatusJSON 的 wrapper,但核心逻辑不变
错误定义真正难的不是结构设计,而是团队能否坚持把新错误加到统一包里、而不是随手 fmt.Errorf 一把梭。一旦放开这个口子,三个月后你就会在三个不同文件里看到几乎一样的 "order not found" 字符串。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

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

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

499

2024.02.23

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

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

576

2024.02.23

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

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

996

2024.02.23

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

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

751

2024.03.05

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

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

1466

2024.05.21

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

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

4094

2025.06.09

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

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

1834

2025.06.10

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

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

3786

2025.06.17

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

共101课时 | 20.7万人学习

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

共39课时 | 4.7万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn