0

0

如何使用Golang实现接口调用错误处理_返回标准错误类型

P粉602998670

P粉602998670

发布时间:2025-12-26 08:46:02

|

648人浏览过

|

来源于php中文网

原创

Go中接口调用错误处理应使用结构化AppError类型,包含Code、Message、HTTPStatus和Err字段,通过工厂函数封装、统一HTTP响应,并映射网络错误、状态码及解析失败等场景。

如何使用golang实现接口调用错误处理_返回标准错误类型

在 Go 中实现接口调用的错误处理,核心是统一返回标准错误类型(如 error 接口),并结合上下文、状态码、原始错误等信息构造可读、可分类、可序列化的错误。不建议直接裸抛 errors.Newfmt.Errorf,而应设计结构化错误类型,便于日志记录、API 响应封装和客户端解析。

定义标准错误结构体

推荐定义一个实现了 error 接口的结构体,包含错误码、消息、HTTP 状态码、原始错误(可选)等字段:

  • Code:业务错误码(如 "USER_NOT_FOUND", "INVALID_PARAM"),用于前端或调用方识别
  • Message:面向用户/开发者的提示语(避免暴露敏感信息)
  • HTTPStatus:对应 HTTP 响应状态码(如 400、401、500)
  • Err:底层原始错误(如网络超时、JSON 解析失败),用于日志追踪,不暴露给外部

示例:

type AppError struct {
  Code string
  Message string
  HTTPStatus int
  Err error
}

实现 Error() 方法:

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

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

封装 HTTP 接口调用并统一错误转换

使用 net/http 调用第三方 API 时,需将各类底层错误(连接失败、超时、非 2xx 响应、JSON 解析失败)映射为标准 *AppError

剪映
剪映

一款全能易用的桌面端剪辑软件

下载
  • 网络层错误(url.Errorcontext.DeadlineExceeded)→ 映射为系统错误(如 "SERVICE_UNAVAILABLE",HTTP 503)
  • 非成功状态码(如 400/401/404/500)→ 根据响应体解析错误详情,或按状态码默认映射(如 404 → "RESOURCE_NOT_FOUND")
  • JSON 反序列化失败 → 包装为 "INVALID_RESPONSE_FORMAT",保留原始 error 用于日志

示例片段:

resp, err := http.DefaultClient.Do(req)
if err != nil {
  return nil, &AppError{
    Code: "HTTP_REQUEST_FAILED",
    Message: "请求第三方服务失败",
    HTTPStatus: http.StatusServiceUnavailable,
    Err: err,
  }
}
defer resp.Body.Close()

if resp.StatusCode = 300 {
  body, _ := io.ReadAll(resp.Body)
  return nil, &AppError{
    Code: statusCodeToCode(resp.StatusCode),
    Message: fmt.Sprintf("第三方服务返回异常状态: %d", resp.StatusCode),
    HTTPStatus: resp.StatusCode,
    Err: fmt.Errorf("status %d, body: %s", resp.StatusCode, string(body)),
  }
}

提供便捷错误构造函数

避免重复 new 结构体,提供工厂函数提升可读性和一致性:

  • NewBadRequest(code, msg string) *AppError → 返回 400 错误
  • NewUnauthorized(msg string) *AppError → 返回 401
  • NewInternalError(err error) *AppError → 包装 panic 或不可预期错误
  • Wrap(err error, code, msg string, status int) *AppError → 封装底层 error 并补充上下文

这样在业务逻辑中可简洁表达:

if userID == "" {
  return nil, NewBadRequest("INVALID_USER_ID", "用户ID不能为空")
}

在 HTTP handler 中统一响应错误

所有 handler 应捕获 *AppError 并生成标准 JSON 响应(如 {"code":"xxx","message":"yyy","trace_id":"..."}),同时设置对应 HTTP 状态码:

func (h *Handler) GetUser(w http.ResponseWriter, r *http.Request) {
  user, err := h.service.GetUser(r.Context(), r.URL.Query().Get("id"))
  if err != nil {
    if appErr, ok := err.(*AppError); ok {
      w.Header().Set("Content-Type", "application/json")
      w.WriteHeader(appErr.HTTPStatus)
      json.NewEncoder(w).Encode(map[string]interface{}{
        "code": appErr.Code,
        "message": appErr.Message,
        "trace_id": getTraceID(r),
      })
      return
    }
    // 非标准错误兜底
    w.WriteHeader(http.StatusInternalServerError)
    json.NewEncoder(w).Encode(map[string]string{"code": "INTERNAL_ERROR", "message": "服务内部错误"})
    return
  }
  json.NewEncoder(w).Encode(user)
}

相关专题

更多
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对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

205

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

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

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号