Go应用中优雅处理Error的几个技巧
Go语言很强大并且现在也十分流行 — 许多项目都是用Go语言来实现的,如Kubernetes。Go语言的一个有趣特性是它的多值返回功能提供了一种与其他编程语言不同的错误处理方法。Go将error视为具有预定义类型的值,其本身是一个interface类型。然而,编写大型应用时需要有包含更多上下文信息的error才有价值,而不仅仅是一个值。本文我们将探讨如何封装Go的error类型以在应用程序中带来更大的价值。
用户自定义类型
我们将重写的Go里自带的error
类型,首先从一个自定义的错误类型开始,该错误类型将在程序中识别为error
类型。因此,我们引入一个封装了Go的 error
的新自定义Error类型。
type GoError struct {error
}
上下文数据
当我们在Go中说error是一个值时,它是字符串值 - 任何实现了Error() string
函数的类型都可以视作error类型。将字符串值视为error会使跨层的error处理复杂化,因此处理error字符串信息并不是正确的方法。所以我们可以把字符串和错误码解耦:
type GoError struct {errorCode string
}
现在对error的处理将基于错误码Code
字段而不是字符串。让我们通过上下文数据进一步对错误字符串进行解耦,在上下文数据中可以使用i18n
包进行国际化。
type GoError struct {errorCode stringData map[string]interface{}
}
Data
包含用于构造错误字符串的上下文数据。错误字符串可以通过数据模板化:
//i18N def
"InvalidParamValue": "Invalid parameter value '{{.actual}}', expected '{{.expected}}' for '{{.name}}'"
在i18N定义文件中,错误码Code
将会映射到使用Data
构建的模板化的错误字符串中。
原因(Causes)
error可能发生在任何一层,有必要为每一层提供处理error的选项,并在不丢失原始error值的情况下进一步使用附加的上下文信息对error进行包装。GoError
结构体可以用Causes
进一步封装,用来保存整个错误堆栈。
type GoError struct {errorCode stringData map[string]interface{}Causes []error
}
如果必须保存多个error数据,则causes
是一个数组类型,并将其设置为基本error
类型,以便在程序中包含该原因的第三方错误。
组件(Component)
标记层组件将有助于识别error发生在哪一层,并且可以避免不必要的error wrap。例如,如果service
类型的error组件发生在服务层,则可能不需要wrap error。检查组件信息将有助于防止暴露给用户不应该通知的error,比如数据库error:
type GoError struct {errorCode stringData map[string]interface{}Causes []errorComponent ErrComponent
}type ErrComponent string
const (ErrService ErrComponent = "service"ErrRepo ErrComponent = "repository"ErrLib ErrComponent = "library"
)
响应类型(ResponseType)
添加一个错误响应类型这样可以支持error分类,以便于了解什么错误类型。例如,可以根据响应类型(如NotFound
)对error进行分类,像DbRecordNotFound
、ResourceNotFound
、UserNotFound
等等的error都可以归类为 NotFound
error。这在多层应用程序开发过程中非常有用,而且是可选的封装:
type GoError struct {errorCode stringData map[string]interface{}Causes []errorComponent ErrComponentResponseType ResponseErrType
}type ResponseErrType stringconst (BadRequest ResponseErrType = "BadRequest"Forbidden ResponseErrType = "Forbidden"NotFound ResponseErrType = "NotFound"AlreadyExists ResponseErrType = "AlreadyExists"
)
重试
在少数情况下,出现error会进行重试。retry字段可以通过设置Retryable
标记来决定是否要进行error重试:
type GoError struct {errorCode stringMessage stringData map[string]interface{}Causes []errorComponent ErrComponentResponseType ResponseErrTypeRetryable bool
}
GoError 接口
通过定义一个带有GoError
实现的显式error接口,可以简化error检查:
package goerrtype Error interface {errorCode() stringMessage() stringCause() errorCauses() []errorData() map[string]interface{}String() stringResponseErrType() ResponseErrTypeSetResponseType(r ResponseErrType) ErrorComponent() ErrComponentSetComponent(c ErrComponent) ErrorRetryable() boolSetRetryable() Error
}
抽象error
有了上述的封装方式,更重要的是对error进行抽象,将这些封装保存在同一地方,并提供error函数的可重用性
func ResourceNotFound(id, kind string, cause error) GoError {data := map[string]interface{}{"kind": kind, "id": id}return GoError{Code: "ResourceNotFound",Data: data,Causes: []error{cause},Component: ErrService,ResponseType: NotFound,Retryable: false,}
}
这个error函数抽象了ResourceNotFound
这个error,开发者可以使用这个函数来返回error对象而不是每次创建一个新的对象:
//UserService
user, err := u.repo.FindUser(ctx, userId)
if err != nil {if err.ResponseType == NotFound {return ResourceNotFound(userUid, "User", err)}return err
}
结论
我们演示了如何使用添加上下文数据的自定义Go的error类型,从而使得error在多层应用程序中更有意义。你可以在这个GitHub Gist[1]看到完整的代码实现和定义。
参考资料
[1] 这个GitHub Gist: https://gist.github.com/prathabk/744367cbfc70435c56956f650612d64b
欢迎关注Go招聘公众号,获取更多精彩内容。
Go应用中优雅处理Error的几个技巧相关推荐
- python切面异常处理_Spring项目中优雅的异常处理
Spring项目中优雅的异常处理 前言 如今的Java Web项目多是以 MVC 模式构建的,通常我们都是将 Service 层的异常统一的抛出,包括自定义异常和一些意外出现的异常,以便进行事务回滚, ...
- thinkphp中出现unserialize(): Error at offset 533 of 1857 bytes如何解决
thinkphp中出现unserialize(): Error at offset 533 of 1857 bytes如何解决 一.总结 一句话总结:清缓存就好了,所以框架有问题可以考虑清缓存 清缓存 ...
- Spring BPP中优雅的创建动态代理Bean
Spring BPP中优雅的创建动态代理Bean 一.前言 本文章所讲并没有基于Aspectj,而是直接通过Cglib以及ProxyFactoryBean去创建代理Bean.通过下面的例子,可以看出C ...
- WSS 3.0中An unexpected error has occurred的一个解决方案
之前在CodePlex上讨论到我在WSS v3里遇到的一个Bug,CKS团队的TheKid向我引用了他的一个解决方案,大意如下 如果需要了解WSS 3.0中An unexpected error ha ...
- easyswoole数据库连接池_如何在 Swoole 中优雅的实现 MySQL 连接池
如何在 Swoole 中优雅的实现 MySQL 连接池 一.为什么需要连接池 ? 数据库连接池指的是程序和数据库之间保持一定数量的连接不断开, 并且各个请求的连接可以相互复用, 减少重复连接数据库带来 ...
- 如何在MyBatis中优雅的使用枚举
From: https://segmentfault.com/a/1190000010755321 问题 在编码过程中,经常会遇到用某个数值来表示某种状态.类型或者阶段的情况,比如有这样一个枚举: p ...
- mysql报错error2002_mysql中异常错误ERROR:2002的解决方法分享
最近在启动mysql的时候发现mysql报错了,错误代码是2002,通过查找相关的资料发现是var/lib/mysql 的访问权限问题,所以这篇文章主要介绍了mysql中异常错误ERROR:2002的 ...
- Laravel中优雅的验证日期需要大于今天
我们有时会碰到一个场景,比如买车票,需要进行查询车票剩余,这时候需要一个日期范围,开始日期必须大于等于今天,结束日期必须大于等于开始日期. Version Laravel 5.5.40 PHP 7.1 ...
- 初学者必知的Python中优雅的用法
初学者必知的Python中优雅的用法:http://python.jobbole.com/81393/
最新文章
- 95后女程序员一下班就溜,拒绝加班!下班玩消失,不回信息!leader吐槽:95后都这么有个性吗?...
- python类的属性和对象属性_在python的类中动态添加属性与生成对象
- 当代的设计潮流是什么_12月,潮流咖的出行攻略!
- 【js与jquery】三级联动菜单的制作
- 教你如何在Ubuntu中创建 Sudo用户
- 管理新语:主管要辅导员工转正
- laravel 任务队列_Laravel 队列系统实现及使用教程
- 非平衡数据(imbalanced data)简单介绍
- 计算机的基本数据结构与算法分析,数据结构与算法分析
- 计算机组成原理不恢复余数法,计算机组成原理第八讲(除法-补码不恢复余数法)(科大罗克露)...
- 【华为浏览器如何安装扩展程序】
- FFmpeg之视频转码
- Strut2的工作流程
- excel输入公式显示公式_显示Excel公式而不是结果
- QT中使用GDAL多线程读取遥感图像到QImage
- IE6、IE7、IE8之IE多版本共存的几种方法(转)
- c、c++的getchar()函数
- 这些年我是如何在知乎安稳引流不被封号的
- 网站统计中的数据收集原理及实现-埋点统计
- 【编码译码】基于matlab HDB3编译码仿真【含Matlab源码 1961期】