Golang フレームワークでのエラー処理のベスト プラクティスは何ですか?

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

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

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

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

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

例如：

import "errors"

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

2. 使用自定义错误

在框架中编写自己的错误类型可以提供比内置错误类型更详细的信息。这允许应用程序以更有意义的方式处理错误。

例如：

type MyError struct {
    Message string
}

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

3. 适当的日志记录

错误处理中一个重要的方面是日志记录。框架应该提供日志记录功能，以记录所有发生的错误。这有助于调试问题和跟踪应用程序行为。

例如，使用 log 包：

import "log"

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

4. 错误传播

函数应该正确传播错误，允许上层函数处理它们。避免隐藏或抑制错误，因为它会使调试变得困难。

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. 错误包装

有时，需要增加对现有错误的上下文信息。错误包装（也称为错误累积）允许在原始错误之上添加额外的错误层。

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
}

实战案例

考虑一个使用 Gin 框架构建的 REST API，该框架处理来自数据库的错误：

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

这个示例演示了：

• 使用自定义错误类型 ErrNotFound
例:
• rrreee
• 2. カスタム エラーを使用する

🎜フレームワークに独自のエラー タイプを記述すると、組み込みのエラー タイプよりも詳細な情報を提供できます。これにより、アプリケーションはより有意義な方法でエラーを処理できるようになります。 🎜🎜例: 🎜rrreee🎜🎜3. 適切なログ記録🎜🎜🎜 エラー処理における重要な側面はログ記録です。フレームワークは、発生したすべてのエラーを記録するロギング機能を提供する必要があります。これは、問題をデバッグし、アプリケーションの動作を追跡するのに役立ちます。 🎜🎜たとえば、log パッケージを使用します。 🎜rrreee🎜🎜4. エラーの伝播 🎜🎜🎜関数はエラーを正しく伝播し、上位レベルの関数がエラーを処理できるようにする必要があります。デバッグが困難になるため、エラーを非表示にしたり抑制したりしないでください。 🎜rrreee🎜🎜5. エラーのラッピング🎜🎜🎜場合によっては、既存のエラーにコンテキスト情報を追加する必要があります。エラー ラッピング (エラー累積とも呼ばれる) を使用すると、元のエラーの上にエラーのレイヤーを追加できます。 🎜rrreee🎜🎜実践的な例🎜🎜🎜データベースからのエラーを処理する、Gin フレームワークを使用して構築された REST API を考えてみましょう: 🎜rrreee🎜この例は、次のことを示します: 🎜

🎜 カスタム エラー タイプ ErrNotFound の使用🎜🎜エラーを適切に伝播し、Gin の応答ハンドラーに返します🎜🎜エラーの種類に基づいて適切な HTTP ステータス コードを返します🎜🎜

以上がGolang フレームワークでのエラー処理のベスト プラクティスは何ですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。