Go應用中優雅處理Error的技巧總結

Posted on by

前言

Go語言很強大並且現在也十分流行 — 許多項目都是用Go語言來實現的，如Kubernetes。Go語言的一個有趣特性是它的多值返回功能提供瞭一種與其他編程語言不同的錯誤處理方法。 Go將error視為具有預定義類型的值，其本身是一個interface類型。然而，編寫多層體系結構應用程序並使用api暴露應用的特性需要有包含更多上下文信息的error處理，而不僅僅是一個值。 本文我們將探討如何封裝Go的error類型以在應用程序中帶來更大的價值。

用戶自定義類型

我們將重寫的Go裡自帶的error類型，首先從一個自定義的錯誤類型開始，該錯誤類型將在程序中識別為error類型。因此，我們引入一個封裝瞭Go的 error的新自定義Error類型。

type GoError struct {
   error
}

上下文數據

當我們在Go中說error是一個值時，它是字符串值 – 任何實現瞭Error() string函數的類型都可以視作error類型。將字符串值視為error會使跨層的error處理復雜化，因此處理error字符串信息並不是正確的方法。所以我們可以把字符串和錯誤碼解耦：

type GoError struct {
   error
   Code    string
}

現在對error的處理將基於錯誤碼Code字段而不是字符串。讓我們通過上下文數據進一步對錯誤字符串進行解耦，在上下文數據中可以使用i18n包進行國際化。

type GoError struct {
   error
   Code    string
   Data    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 {
   error
   Code    string
   Data    map[string]interface{}
   Causes  []error
}

如果必須保存多個error數據，則causes是一個數組類型，並將其設置為基本error類型，以便在程序中包含該原因的第三方錯誤。

組件(Component)

標記層組件將有助於識別error發生在哪一層，並且可以避免不必要的error wrap。例如，如果service類型的error組件發生在服務層，則可能不需要wrap error。檢查組件信息將有助於防止暴露給用戶不應該通知的error，比如數據庫error：

type GoError struct {
   error
   Code      string
   Data      map[string]interface{}
   Causes    []error
   Component 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 {
   error
   Code         string
   Data         map[string]interface{}
   Causes       []error
   Component    ErrComponent
   ResponseType ResponseErrType
}

type ResponseErrType string

const (
   BadRequest    ResponseErrType = "BadRequest"
   Forbidden     ResponseErrType = "Forbidden"
   NotFound      ResponseErrType = "NotFound"
   AlreadyExists ResponseErrType = "AlreadyExists"
)

重試

在少數情況下，出現error會進行重試。retry字段可以通過設置Retryable標記來決定是否要進行error重試:

type GoError struct {
   error
   Code         string
   Message      string
   Data         map[string]interface{}
   Causes       []error
   Component    ErrComponent
   ResponseType ResponseErrType
   Retryable    bool
}

GoError 接口

通過定義一個帶有GoError實現的顯式error接口，可以簡化error檢查:

package goerr

type Error interface {
   error

   Code() string
   Message() string
   Cause() error
   Causes() []error
   Data() map[string]interface{}
   String() string
   ResponseErrType() ResponseErrType
   SetResponseType(r ResponseErrType) Error
   Component() ErrComponent
   SetComponent(c ErrComponent) Error
   Retryable() bool
   SetRetryable() 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在多層應用程序中更有意義。你可以在這裡[1]看到完整的代碼實現和定義。

到此這篇關於Go應用中優雅處理Error的文章就介紹到這瞭,更多相關Go優雅處理Error內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

參考資料

[1] 這裡: https://gist.github.com/prathabk/744367cbfc70435c56956f650612d64b

推薦閱讀：