ベスト プラクティス: 明確に定義されたエラー タイプ (エラー パッケージ) を使用してカスタム エラーを作成する 詳細を提供する エラーを適切にログに記録する エラーを正しく伝播し、非表示または抑制しないようにする コンテキストを追加するために必要に応じてエラーをラップする

Go フレームワークのエラー処理のベスト プラクティス

Go アプリケーションでエラーを処理することは、安定した堅牢なコードを作成するために重要です。 Go 標(biāo)準(zhǔn)ライブラリにはエラー処理のサポートが組み込まれていますが、フレームワークごとに獨自のベスト プラクティスがある場合があります。この記事では、Go フレームワークを使用する際の最適なエラー処理のためのガイドラインについて説明します。

1. エラー タイプを使用する

エラー処理を簡素化し、読みやすさを向上させるために、明確に定義されたエラー タイプを使用することをお勧めします。エラー タイプは、errors パッケージの New 関數(shù)または Errorf 関數(shù)を使用して作成できます。 errors 包中的 New 或者 Errorf 函數(shù)創(chuàng)建。

例如：

import "errors"

var ErrNotFound = errors.New("not found")

2. 使用自定義錯誤

在框架中編寫自己的錯誤類型可以提供比內(nèi)置錯誤類型更詳細的信息。這允許應(yīng)用程序以更有意義的方式處理錯誤。

例如：

type MyError struct {
    Message string
}

func (e MyError) Error() string {
    return e.Message
}

3. 適當(dāng)?shù)娜罩居涗?/strong>

錯誤處理中一個重要的方面是日志記錄。框架應(yīng)該提供日志記錄功能，以記錄所有發(fā)生的錯誤。這有助于調(diào)試問題和跟蹤應(yīng)用程序行為。

例如，使用 log 包：

import "log"

func main() {
    log.Fatal(ErrNotFound)
}

4. 錯誤傳播

函數(shù)應(yīng)該正確傳播錯誤，允許上層函數(shù)處理它們。避免隱藏或抑制錯誤，因為它會使調(diào)試變得困難。

func GetResource() (*Resource, error) {
    db, err := connectToDB()
    if err != nil {
        return nil, err
    }

    resource, err := db.GetResource()
    if err != nil {
        return nil, err
    }

    return resource, nil
}

5. 錯誤包裝

有時，需要增加對現(xiàn)有錯誤的上下文信息。錯誤包裝（也稱為錯誤累積）允許在原始錯誤之上添加額外的錯誤層。

import "fmt"

func GetResource() (*Resource, error) {
    resource, err := db.GetResource()
    if err != nil {
        return nil, fmt.Errorf("failed to get resource: %w", err)
    }

    return resource, nil
}

實戰(zhàn)案例

考慮一個使用 Gin 框架構(gòu)建的 REST API，該框架處理來自數(shù)據(jù)庫的錯誤：

import (
    "errors"
    "github.com/gin-gonic/gin"
)

var ErrNotFound = errors.New("not found")

func GetResource(c *gin.Context) {
    db, err := connectToDB()
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    resource, err := db.GetResource(c.Param("id"))
    if err == ErrNotFound {
        c.JSON(http.StatusNotFound, gin.H{"error": "resource not found"})
        return
    }

    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusOK, resource)
}

這個示例演示了：