API响应中简单的错误信息（例如{“error”: “something went wrong.”}）毫无用处。有效的错误响应应该包含：问题描述、以及API的构建细节。本文介绍如何构建一个提供一致、实用且有意义的错误响应的系统。
构建可操作的错误处理系统
系统的核心是customerror结构体，它包含所有必要的错误信息。
自定义错误结构体详解:
type customerror struct { baseerr error // 底层错误 statuscode int // HTTP状态码 message string // 详细错误信息 usermessage string // 用户友好的错误信息 errtype string // 错误类型 errcode string // 唯一错误代码 retryable bool // 是否可重试 metadata map[string]interface{} // 附加元数据 }
登录后复制
简而言之：
- baseerr：原始错误。
- statuscode：HTTP状态码，例如404或500。
- usermessage：对用户友好的错误信息。
- errtype 和 errcode：用于错误分类和调试。
- retryable：指示是否可以重试请求。
创建自定义错误
该系统包含一个工厂函数new，用于简化customerror实例的创建，确保所有错误都以一致的结构初始化：
func new(statuscode int, message, usermessage, errtype, errcode string, retryable bool) *customerror { return &customerror{ baseerr: fmt.Errorf("error: %s", message), statuscode: statuscode, message: message, usermessage: usermessage, errtype: errtype, errcode: errcode, retryable: retryable, metadata: make(map[string]interface{}), } }
登录后复制
例如，创建一个“资源未找到”错误：
func newNotFoundError(resource string) *customerror { return new( 404, fmt.Sprintf("%s not found", resource), "请求的资源未找到。", "not_found", "err_not_found", false, ) }
登录后复制
这确保所有“未找到”错误都返回一致且有意义的响应。
newFromError函数用于将现有错误包装到自定义错误中：
func newFromError(err error, statuscode int, usermessage, errtype, errcode string, retryable bool) *customerror { return &customerror{ baseerr: err, statuscode: statuscode, message: err.Error(), usermessage: usermessage, errtype: errtype, errcode: errcode, retryable: retryable, metadata: make(map[string]interface{}), } }
登录后复制
例如，处理文件解析错误：
func handleParseError(filename string) *customerror { err := parseFile(filename) if err != nil { return newFromError( err, 400, "无法处理您上传的文件。", "bad_request", "err_file_parse", false, ) } return nil }
登录后复制
这在提供用户友好的消息的同时保留了原始错误信息。
错误：将错误转换为响应
newErrHandler函数充当内部错误和面向客户端API响应之间的转换器。其关键步骤包括：
- 检查自定义错误：确定错误是否为customerror类型。
- 创建API特定的错误：使用apiErrorCreator接口动态创建API特定的错误响应结构体。
- 使用apiError接口的fromCustomError方法将错误转换为API特定的错误。
- 处理后备：如果错误转换失败或错误不是customerror类型，则返回内部服务器错误。
核心逻辑：
func newErrHandler(creator apiErrorCreator, writerFactory func() responseWriter) func(error) { return func(werr error) { var customErr *customerror writer := writerFactory() // ... (error handling logic) ... } }
登录后复制
灵活的接口
错误处理器利用三个关键接口：apiError，apiErrorCreator 和 responseWriter。
- apiError：定义API错误的格式。
- apiErrorCreator：创建新的apiError实例。
- responseWriter：抽象响应写入机制。
工作流程
- 定义错误响应：实现apiError和apiErrorCreator接口。
- 处理请求：使用错误处理器处理错误。
- 写入响应：使用responseWriter接口发送错误响应。
使用YAML和模板生成错误
为了避免手动定义错误，可以使用YAML配置和Go模板来自动化此过程。
YAML配置示例:
errors: - name: badrequest description: 请求无效或格式错误。 err_type: bad_request err_code: err_bad_request err_msg: 无效请求: %s display_msg: 请求无效。 status_code: 400 retryable: false args: - name: details arg_type: string
登录后复制
Go模板将YAML配置转换为Go代码。
代码生成的优势:
- 一致性：所有错误定义遵循相同的结构。
- 效率：避免重复编码。
- 可扩展性：轻松添加新错误。
- 自定义性：支持特定于应用程序的字段。
预定义错误
使用代码生成机制从YAML配置动态生成预定义的错误。
总结
这个错误处理系统通过其组件的无缝协作，提供了一个强大且可扩展的解决方案。 它提供清晰、可操作且对开发人员友好的反馈，极大地简化了Go API的错误处理。
以上就是GO API中自定义错误处理系统的最终指南的详细内容，更多请关注php中文网其它相关文章！
微信扫一扫打赏
支付宝扫一扫打赏
