0

0

如何在Golang中实现统一错误处理_封装函数返回统一格式

P粉602998670

P粉602998670

发布时间:2025-12-25 18:42:08

|

936人浏览过

|

来源于php中文网

原创

Go中统一错误处理需定义AppError结构体封装状态码、业务码、消息等,业务函数返回*AppError,HTTP层用中间件拦截并序列化为标准JSON响应,兼顾安全与日志可追溯性。

如何在golang中实现统一错误处理_封装函数返回统一格式

在 Go 中实现统一错误处理并封装函数返回统一格式,核心是定义清晰的错误结构、规范错误创建方式、统一响应体,并在 HTTP 层或业务入口处集中拦截和转换错误。不依赖框架也能做到简洁可控。

定义统一错误类型与错误码

避免直接返回 error 接口导致信息丢失,自定义结构体携带状态码、业务码、消息和可选详情:

type AppError struct {
    Code    int    `json:"code"`    // HTTP 状态码(如 400、500)
    ErrCode int    `json:"err_code"` // 业务错误码(如 1001 表示用户不存在)
    Msg     string `json:"msg"`
    Details []string `json:"details,omitempty"`
}

func (e *AppError) Error() string {
    return fmt.Sprintf("[%d]%s", e.ErrCode, e.Msg)
}

// 快捷构造函数
func NewBadRequest(errCode int, msg string, details ...string) *AppError {
    return &AppError{Code: 400, ErrCode: errCode, Msg: msg, Details: details}
}

func NewInternalError(errCode int, msg string, details ...string) *AppError {
    return &AppError{Code: 500, ErrCode: errCode, Msg: msg, Details: details}
}

业务函数统一返回 (data, error)

所有服务层函数遵循相同签名,错误一律用 *AppError,不混用标准 errors.Newfmt.Errorf

  • 成功时返回数据和 nil
  • 失败时返回零值和具体 *AppError,不 panic,不裸露底层错误(如数据库驱动错误)
  • 例如:user, err := userService.GetUserByID(ctx, id)err 类型为 error,但实际应为 *AppError

HTTP 层统一拦截并序列化响应

在 handler 中用 defer 或中间件捕获错误,转为标准 JSON 响应:

超会AI
超会AI

AI驱动的爆款内容制造机

下载

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

func jsonHandler(f func() (interface{}, error)) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json; charset=utf-8")

        data, err := f()
        if err != nil {
            var appErr *AppError
            if errors.As(err, &appErr) {
                w.WriteHeader(appErr.Code)
                json.NewEncoder(w).Encode(map[string]interface{}{
                    "success": false,
                    "data":    nil,
                    "error":   appErr,
                })
                return
            }
            // 非 AppError,兜底为 500
            w.WriteHeader(500)
            json.NewEncoder(w).Encode(map[string]interface{}{
                "success": false,
                "data":    nil,
                "error":   &AppError{Code: 500, ErrCode: 9999, Msg: "Unknown server error"},
            })
            return
        }

        w.WriteHeader(200)
        json.NewEncoder(w).Encode(map[string]interface{}{
            "success": true,
            "data":    data,
            "error":   nil,
        })
    }
}

// 使用示例
http.HandleFunc("/api/user/:id", jsonHandler(func() (interface{}, error) {
    id := chi.URLParam(r, "id")
    user, err := userService.GetUserByID(r.Context(), id)
    if err != nil {
        return nil, err // 直接返回 *AppError
    }
    return user, nil
}))

日志与错误透传的平衡

对外响应要简洁安全,对内日志需保留上下文:

  • 返回给前端Msg 应通用友好(如“用户名已存在”),不暴露技术细节
  • 记录日志时,补充 traceID、参数、原始错误(可用 fmt.Sprintf("%+v", err)
  • 必要时在 *AppError 中加字段 LogID string 关联日志,但不返回给客户端

相关专题

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

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

173

2024.02.23

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

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

224

2024.02.23

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

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

334

2024.02.23

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

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

204

2024.03.05

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

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

387

2024.05.21

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

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

193

2025.06.09

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

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

184

2025.06.10

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

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

191

2025.06.17

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

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

共101课时 | 8万人学习

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

共39课时 | 3.1万人学习

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

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号