学会定制化 Go 项目的 error,回溯错误的原因和发生位置

如果你们的研发习惯是请求接口的响应一律是 HTTP 200 再通过相应里的code码判断是否正确,这个方法可以放着不用, 规范化一点肯定是这种比较好,况且HTTP Status 不是 200 状态码,也是可以返回 code msg 那些信息给客户端的。
首页 新闻资讯 行业资讯 学会定制化 Go 项目的 error,回溯错误的原因和发生位置

Go语言的Error处理一直被人吐槽,吐槽的点除了一个接一个的 if err != nil 的判断外,还有人说Go的错误太原始不能像其他语言那样在抛出异常的时候的时候传一个Casue Exception 把导致异常的整个原因链串起来。

第一点确实是事实,但是写习惯了也能接受,而且对新手友好。第二点属实就有点尬黑了。

用Go开发项目时想让程序抛出的 error 信息不要那么单薄,需要自己搭建项目时先做一番基础工作,自己定义项目的Error类型在包装错误的时候记录上错误的原因和发生的位置,比如像下面这样。

{"code":10000000,"msg":"服务器内部错误","cause":"db error: undefined column user_id","occurred":"go-study-lab/go-mall.TestAppError, file: building.go, line: 69"}

同时它还要实现Go的error interface,能融入Go 的错误处理机制才行。

今天我就带大家通过自定义项目Error并实现 Go error interface ,让你的Go项目Error拥有更丰富的错误原因和发生位置的信息。看到一个错误能看出来时什么原因导致的、以及是哪的代码导致的这样能大大降低Go项目的维护难度。

Go Error 定制化Go Error 定制化


定义项目的Error结构

首先我们在项目的common目录中增加errcode目录,该目录下会创建两个文件error.go 和 code.go。error.go文件用来存放自定义Error的结构和相关方法,code.go 用来放置项目各种预定义的Error。

.|-- common||-- errcode||---code.go||---error.go|-- main.go|-- go.mod|-- go.sum

我们现在error.go 中定义AppError

typeAppError struct {
 codeint`json:"code"`msg      string`json:"msg"`cause    error`json:"cause"`}

cause 字段保存的是导致产生 AppErr 的原因,比如一个数据库查询语法错误,拿它再来生成项目的 AppError 或者是给预定义好的 AppError 追加上这个原因的error, 这样就能达到保存错误链条的目的。

现在AppError 还不是 error 类型,需要让他实现Go的 error interface,这个接口如下。

typeerror interface {
 Error()string
}

其中只定义了一个方法,我们让AppError实现Error方法把它变成 error 类型。

func(e*AppError)Error()string {ife==nil {return""}

 formattedErr :=struct {
  Codeint`json:"code"`Msg      string`json:"msg"`Cause    string`json:"cause"`}{
  Code:     e.Code(),Msg:      e.Msg(),}ife.cause!=nil {
  formattedErr.Cause=e.cause.Error()}
 errByte,_ :=json.Marshal(formattedErr)returnstring(errByte)}

Error方法返回的是AppError对象的JSON序列化字符串,其中如果cause字段不为空即错误原因不为空,再去错误原因的Error方法拿到底层的错误信息。

我们把Stringer 接口也实现一下,在没有类型字段转换的地方,它还是*AppErr类型,保证这个时候序列化它的时候仍然能得到期望的信息。

func(e*AppError)String()string {returne.Error()}

接下来我们在code.go 中先预定义一些基础的错误

var(Success=newError(0,"success")ErrServer=newError(10000000,"服务器内部错误")ErrParams=newError(10000001,"参数错误, 请检查")ErrNotFound=newError(10000002,"资源未找到")ErrPanic=newError(10000003,"(*^__^*)系统开小差了,请稍后重试")// 无预期的panic错误ErrToken=newError(10000004,"Token无效")ErrForbidden=newError(10000005,"未授权")// 访问一些未授权的资源时的错误ErrTooManyRequests=newError(10000006,"请求过多"))

上面大家看到了 AppError 的类型定义中,字段的访问性都是包内可访问的,所以我们要定义一些 getter 方法,这样接口返回错误响应时,才能读到错误码和错误信息。

func(e*AppError)Code()int{returne.code
}

func(e*AppError)Msg()string {returne.msg
}

func(e*AppError)HttpStatusCode()int{
 switch e.Code(){caseSuccess.Code():returnhttp.StatusOKcaseErrServer.Code(),ErrPanic.Code():returnhttp.StatusInternalServerErrorcaseErrParams.Code():returnhttp.StatusBadRequestcaseErrNotFound.Code():returnhttp.StatusNotFoundcaseErrTooManyRequests.Code():returnhttp.StatusTooManyRequestscaseErrToken.Code():returnhttp.StatusUnauthorizedcaseErrForbidden.Code():returnhttp.StatusForbiddendefault:returnhttp.StatusInternalServerError
 }
}

这里的 HttpStatusCode 返回的是HTTP 状态码,如果你们的研发习惯是请求接口的响应一律是 HTTP 200 再通过相应里的code码判断是否正确,这个方法可以放着不用, 规范化一点肯定是这种比较好,况且HTTP Status 不是 200 状态码,也是可以返回 code msg 那些信息给客户端的。

底层Error怎么变成项目Error

上面我们预定义好了几个应用错误,这里说明一下,预定义好的错误会最终返回给发起请求的客户端,所以控制器层各个URI的路由处理控制器中最后一定要返回预定义的错误,这个我们会在未来给Go项目封装统一的响应组件时处理。

那一个底层的错误怎么才能变成我们自定义的错误呢?

13    2024-10-28 09:04:38    Go 项目 客户端