快捷導(dǎo)航

詳解Golang中errors包如何返回自定義error類型

更新時(shí)間：2023年09月07日 09:34:13 作者：路多辛

這篇文章主要為大家詳細(xì)介紹了Golang中errors包如何返回自定義error類型,文中的示例代碼簡(jiǎn)潔易懂,有需要的小伙伴可以跟隨小編一起學(xué)習(xí)一下

之前的文章《Golang 中的 errors 包詳解》詳細(xì)講解了 errors 包的主要類型和函數(shù)，以及它們的使用方法。本文結(jié)合之前講解的知識(shí)，來講解一下根據(jù)自己或團(tuán)隊(duì)的項(xiàng)目要求如何返回自定義的 error 類型。

為什么需要自定義 error 類型

在日常開發(fā)中，返回自定義 error 類型是一種很常見的做法，因?yàn)楹芏鄨?chǎng)景下標(biāo)準(zhǔn)庫 errors 包中的 error 類型并不能滿足需求。例如開發(fā) web 項(xiàng)目時(shí)，常見的返回結(jié)構(gòu)可能如下：

{"code":xxx, "data":yyy,"msg":"zzz"}

code 為狀態(tài)碼，data 為接口返回的業(yè)務(wù)數(shù)據(jù)，msg 為錯(cuò)誤信息。針對(duì)這種響應(yīng)結(jié)構(gòu)，一般做法是調(diào)用處理業(yè)務(wù)邏輯的函數(shù)或方法，返回業(yè)務(wù)數(shù)據(jù)和 error，然后在 api 層拼裝成這種結(jié)構(gòu)。所以 error 對(duì)象至少要包含狀態(tài)碼 code 和錯(cuò)誤信息 msg，這時(shí)候就需要實(shí)現(xiàn)自己的 error 類型了。

如何實(shí)現(xiàn)自定義 error 類型

在 Golang 中，可以通過創(chuàng)建一個(gè)實(shí)現(xiàn)了 error 接口（該接口僅包含一個(gè) Error 方法）的結(jié)構(gòu)體來返回自定義的 error 類型。自定義的 error 類型可以包含自己定義的字段和方法，以提供更多的錯(cuò)誤信息和上下文信息?？匆粋€(gè)示例來展示如何創(chuàng)建和返回自定義 error 類型：

package main
import (
    "errors"
    "fmt"
)
// 自定義的錯(cuò)誤類型
type MyError struct {
    code int64
    msg  string
}
// 實(shí)現(xiàn)error接口的Error方法
func (e MyError) Error() string {
    return fmt.Sprintf("Error: [%d] %s", e.code, e.msg)
}
func (e MyError) Code() int64 {
    return e.code
}
func (e MyError) Msg() string {
    return e.msg
}
// 函數(shù)示例，返回自定義error類型
func doSomething() error {
    err := MyError{
        code: 500,
        msg:  "Something went wrong",
    }
    return err
}
func main() {
    err := doSomething()
    if err != nil {
        fmt.Println(err)
    }
    // 比較自定義error類型
    myErr := MyError{
        code: 500,
        msg:  "Something went wrong",
    }
    equal := errors.Is(err, myErr)
    fmt.Println(equal) // true
}

在上述示例中，首先定義了一個(gè)自定義的 MyError 類型，包含 code 和 msg 兩個(gè)字段，然后實(shí)現(xiàn) error 接口要求的 Error 方法。

接下來再看一個(gè)結(jié)合 gin 框架的具體使用示例，簡(jiǎn)單示例代碼如下：

package main
import (
    "errors"
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
)
// 自定義的錯(cuò)誤類型
type MyError struct {
    code int64
    msg  string
}
func NewError(code int64, msg string) MyError {
    return MyError{
        code: code,
        msg:  msg,
    }
}
// 實(shí)現(xiàn)error接口的Error方法
func (e MyError) Error() string {
    return fmt.Sprintf("Error: [%d] %s", e.code, e.msg)
}
func (e MyError) GetCode() int64 {
    return e.code
}
func (e MyError) GetMsg() string {
    return e.msg
}
// 函數(shù)示例，返回自定義error類型
func doSomething() error {
    err := MyError{
        code: 500,
        msg:  "Something went wrong",
    }
    return err
}
func FromError(err error) MyError {
    if err == nil {
        return NewError(1, "")
    }
    if !errors.As(err, &MyError{}) {
        return NewError(-1, "")
    }
    return err.(MyError)
}
func TestHandler(c *gin.Context) {
    err := Logic()
    if err != nil {
        e := FromError(err)
        c.JSON(http.StatusOK, gin.H{"code": e.GetCode(), "data": nil, "msg": e.GetMsg()})
        return
    }
    c.JSON(http.StatusOK, gin.H{"code": 1, "data": nil, "msg": ""})
}
func Logic() error {
    return NewError(-1, "something went wrong")
}
func main() {
    r := gin.New()
    r.GET("/test", TestHandler)
    r.Run(":8080")
}