0

0

如何在Golang中实现REST API错误返回

P粉602998670

P粉602998670

发布时间:2025-10-16 13:08:02

|

924人浏览过

|

来源于php中文网

原创

答案是:在Golang中实现REST API错误返回需定义统一的ErrorResponse结构体,包含Error、Message和Code字段,使用sendErrorResponse辅助函数设置Content-Type、状态码并返回JSON;根据错误类型返回400、401、403、404、422或500等恰当状态码,避免一律返回500;可定义AppError自定义错误类型携带错误信息与状态码,在handler中判断类型并响应,确保前端获得结构一致、语义清晰的错误信息。

如何在golang中实现rest api错误返回

在Golang中实现REST API错误返回,关键在于统一格式、明确状态码、提供可读的错误信息,并与HTTP响应良好集成。以下是一些实用的做法和结构示例。

定义统一的错误响应格式

前端通常希望所有错误都以一致的JSON结构返回。可以定义一个通用的错误响应结构体:

type ErrorResponse struct {
    Error   string `json:"error"`
    Message string `json:"message,omitempty"`
    Code    int    `json:"code,omitempty"`
}

这样无论发生什么错误,返回的JSON结构都保持一致,便于前端处理。

使用中间件或辅助函数发送错误响应

写一个工具函数来封装错误响应的发送逻辑,避免重复代码:

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

func sendErrorResponse(w http.ResponseWriter, message string, statusCode int) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(statusCode)
    json.NewEncoder(w).Encode(ErrorResponse{
        Error:   http.StatusText(statusCode),
        Message: message,
        Code:    statusCode,
    })
}

在处理函数中可以直接调用:

喵记多
喵记多

喵记多 - 自带助理的 AI 笔记

下载
if user, err := getUser(id); err != nil {
    sendErrorResponse(w, "用户不存在", http.StatusNotFound)
    return
}

区分不同类型的错误并返回对应状态码

不要把所有错误都返回500。根据错误类型设置合适的HTTP状态码:

  • 400 Bad Request:请求参数无效
  • 401 Unauthorized:未登录
  • 403 Forbidden:权限不足
  • 404 Not Found:资源不存在
  • 422 Unprocessable Entity:数据验证失败
  • 500 Internal Server Error:服务器内部错误

例如参数校验失败时:

if email == "" {
    sendErrorResponse(w, "邮箱不能为空", http.StatusBadRequest)
    return
}

结合自定义错误类型增强控制力

可以定义应用级错误类型,携带更多信息:

type AppError struct {
    Err    error
    Msg    string
    Status int
}

func (e *AppError) Error() string {
    return e.Err.Error()
}

在业务逻辑中返回这种错误,然后在handler中判断类型并处理:

if err != nil {
    if appErr, ok := err.(*AppError); ok {
        sendErrorResponse(w, appErr.Msg, appErr.Status)
    } else {
        sendErrorResponse(w, "服务器内部错误", http.StatusInternalServerError)
    }
    return
}
基本上就这些。核心是结构统一、状态码准确、信息清晰。不复杂但容易忽略细节。

相关专题

更多
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开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

391

2024.05.21

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

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

196

2025.06.09

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

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

191

2025.06.10

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

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

192

2025.06.17

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

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

精品课程

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

共101课时 | 8.3万人学习

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

共39课时 | 3.2万人学习

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

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