Go語言很強(qiáng)大并且現(xiàn)在也十分流行 — 許多項(xiàng)目都是用Go語言來實(shí)現(xiàn)的，如Kubernetes。Go語言的一個(gè)有趣特性是它的多值返回功能提供了一種與其他編程語言不同的錯(cuò)誤處理方法。Go將error視為具有預(yù)定義類型的值，其本身是一個(gè)interface類型。然而，編寫大型應(yīng)用時(shí)需要有包含更多上下文信息的error才有價(jià)值，而不僅僅是一個(gè)值。本文我們將探討如何封裝Go的error類型以在應(yīng)用程序中帶來更大的價(jià)值。

用戶自定義類型

我們將重寫的Go里自帶的 error 類型，首先從一個(gè)自定義的錯(cuò)誤類型開始，該錯(cuò)誤類型將在程序中識(shí)別為 error 類型。因此，我們引入一個(gè)封裝了Go的 error 的新自定義Error類型。

type GoError struct { 
   error 
} 

上下文數(shù)據(jù)

當(dāng)我們?cè)贕o中說error是一個(gè)值時(shí)，它是字符串值 - 任何實(shí)現(xiàn)了 Error() string 函數(shù)的類型都可以視作error類型。將字符串值視為error會(huì)使跨層的error處理復(fù)雜化，因此處理error字符串信息并不是正確的方法。所以我們可以把字符串和錯(cuò)誤碼解耦：

type GoError struct { 
   error 
   Code    string 
} 

現(xiàn)在對(duì)error的處理將基于錯(cuò)誤碼 Code 字段而不是字符串。讓我們通過上下文數(shù)據(jù)進(jìn)一步對(duì)錯(cuò)誤字符串進(jìn)行解耦，在上下文數(shù)據(jù)中可以使用 i18n 包進(jìn)行國際化。

type GoError struct { 
   error 
   Code    string 
   Data    map[string]interface{} 
} 

Data 包含用于構(gòu)造錯(cuò)誤字符串的上下文數(shù)據(jù)。錯(cuò)誤字符串可以通過數(shù)據(jù)模板化:

//i18N def 
"InvalidParamValue": "Invalid parameter value '{{.actual}}', expected '{{.expected}}' for '{{.name}}'" 

在i18N定義文件中，錯(cuò)誤碼 Code 將會(huì)映射到使用 Data 構(gòu)建的模板化的錯(cuò)誤字符串中。

原因(Causes)

error可能發(fā)生在任何一層，有必要為每一層提供處理error的選項(xiàng)，并在不丟失原始error值的情況下進(jìn)一步使用附加的上下文信息對(duì)error進(jìn)行包裝。 GoError 結(jié)構(gòu)體可以用 Causes 進(jìn)一步封裝，用來保存整個(gè)錯(cuò)誤堆棧。

type GoError struct { 
   error 
   Code    string 
   Data    map[string]interface{} 
   Causes  []error 
} 

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

組件(Component)

標(biāo)記層組件將有助于識(shí)別error發(fā)生在哪一層，并且可以避免不必要的error wrap。例如，如果 service 類型的error組件發(fā)生在服務(wù)層，則可能不需要wrap error。檢查組件信息將有助于防止暴露給用戶不應(yīng)該通知的error，比如數(shù)據(jù)庫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" 
) 

響應(yīng)類型(ResponseType)

添加一個(gè)錯(cuò)誤響應(yīng)類型這樣可以支持error分類，以便于了解什么錯(cuò)誤類型。例如，可以根據(jù)響應(yīng)類型(如 NotFound )對(duì)error進(jìn)行分類，像 DbRecordNotFound 、 ResourceNotFound 、 UserNotFound 等等的error都可以歸類為 NotFound error。這在多層應(yīng)用程序開發(fā)過程中非常有用，而且是可選的封裝：

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" 
) 

重試

在少數(shù)情況下，出現(xiàn)error會(huì)進(jìn)行重試。retry字段可以通過設(shè)置 Retryable 標(biāo)記來決定是否要進(jìn)行error重試:

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

GoError 接口

通過定義一個(gè)帶有 GoError 實(shí)現(xiàn)的顯式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

有了上述的封裝方式，更重要的是對(duì)error進(jìn)行抽象，將這些封裝保存在同一地方，并提供error函數(shù)的可重用性

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, 
   } 
} 

這個(gè)error函數(shù)抽象了 ResourceNotFound 這個(gè)error，開發(fā)者可以使用這個(gè)函數(shù)來返回error對(duì)象而不是每次創(chuàng)建一個(gè)新的對(duì)象：

//UserService 
user, err := u.repo.FindUser(ctx, userId) 
if err != nil { 
   if err.ResponseType == NotFound { 
      return ResourceNotFound(userUid, "User", err) 
   } 
   return err 
} 

結(jié)論

我們演示了如何使用添加上下文數(shù)據(jù)的自定義Go的error類型，從而使得error在多層應(yīng)用程序中更有意義。你可以在 這個(gè)GitHub Gist [1]看到完整的代碼實(shí)現(xiàn)和定義。