Golang如何在API接口中返回标准错误

定义标准错误结构并封装响应函数,使用预定义错误码与HTTP状态码返回统一格式的错误信息,避免暴露敏感细节。

golang如何在api接口中返回标准错误

在Go语言开发API接口时,返回标准错误能让客户端更清晰地理解出错原因。直接返回原始错误信息不仅不友好,还可能暴露敏感信息。正确的做法是统一错误格式,结合HTTP状态码,提供可读性强、结构一致的响应。

定义标准错误响应结构

先定义一个通用的错误响应体,便于所有接口统一使用:

{  "error": {    "code": "invalid_request",    "message": "请求参数有误",    "status": 400  }}

对应Go结构体可以这样写:

type Error struct {
  Code    string `json:”code”`
  Message string `json:”message”`
  Status  int   `json:”status”`
}

type ErrorResponse struct {
  Error Error `json:”error”`
}

封装错误生成函数

通过预定义常见错误类型,减少重复代码:

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

var (
  ErrInvalidRequest = Error{
    Code:    “invalid_request”,
    Message: “请求参数有误”,
    Status: 400,
  }
  ErrUnauthorized = Error{
    Code:    “unauthorized”,
    Message: “未授权访问”,
    Status: 401,
  }
  ErrInternal = Error{
    Code:    “internal_error”,
    Message: “服务器内部错误”,
    Status: 500,
  }
)

再写一个辅助函数发送错误响应:

func sendErrorResponse(w http.ResponseWriter, err Error) {
  w.Header().Set(“Content-Type”, “application/json; charset=utf-8”)
  w.WriteHeader(err.Status)
  json.NewEncoder(w).Encode(ErrorResponse{Error: err})
}

在Handler中使用标准错误

实际处理请求时,根据情况调用对应的错误返回:

func LoginHandler(w http.ResponseWriter, r *http.Request) {
  if r.Method != “POST” {
    sendErrorResponse(w, ErrInvalidRequest)
    return
  }
  // 模拟校验失败
  if !validCredentials(r) {
    sendErrorResponse(w, ErrUnauthorized)
    return
  }
  // 正常响应略…
}

处理未知错误并避免信息泄露

对于运行时panic或未预期错误,应记录日志但不返回细节给前端

defer func() {
  if r := recover(); r != nil {
    log.Printf(“Panic: %v”, r) // 记录真实错误
    sendErrorResponse(w, ErrInternal) // 返回通用提示
  }
}()

基本上就这些。关键是结构统一、错误分类清晰、对外不暴露实现细节。这样前后端协作更高效,也提升API专业度。

以上就是Golang如何在API接口中返回标准错误的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1419214.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
Go语言JSON解码器处理私有字段:深入解析与两种解决方案
上一篇 2025年12月16日 12:58:43
Go语言:通过名称动态访问结构体属性
下一篇 2025年12月16日 12:58:52

相关推荐

发表回复

登录后才能评论
关注微信