Ginフレームワークのミドルウェアとその応用について詳しく解説-Golang-php.cn

Ginフレームワークのミドルウェアとその応用について詳しく解説

王林

リリース： 2023-06-22 10:21:17

オリジナル

2453 人が閲覧しました

Gin フレームワークは、Go 言語をベースにした軽量の Web フレームワークで、効率性、柔軟性、拡張性が容易という利点があり、多くの開発者に愛されています。ミドルウェアメカニズムは、Gin フレームワークのハイライトです。この記事では、Gin フレームワークのミドルウェアメカニズムとそのアプリケーションについて詳しく説明します。

1. ミドルウェアとは

ミドルウェアとは、ネットワークリクエストの処理過程でリクエストとレスポンスの処理ロジックをインターセプトして書き換えるプラグインを指します。 Go 言語では、通常、ミドルウェアは関数型を使用して実装されます。これらの関数をリクエストとレスポンスを処理する関数に仮パラメータとして渡すことで、Gin フレームワークのミドルウェアが実装されます。

Gin フレームワークでは、ミドルウェアはグローバルミドルウェアとローカルミドルウェアの 2 種類に分類されます。グローバルミドルウェアはすべてのルートで動作しますが、ローカルミドルウェアは特定のルートまたはルーティンググループで動作します。

2. Gin フレームワークのミドルウェアの仕組み

Gin フレームワークのミドルウェアの仕組みは非常にシンプルで、リクエストを処理する関数にミドルウェアを関数型として渡すだけです。そして反応。

たとえば、次のコードは単純なミドルウェアです:

func MyMiddleware() gin.HandlerFunc {
  return func(c *gin.Context) {
    // do something
    c.Next()
    // do something after
  }
}

ログイン後にコピー

このうち、MyMiddleware 関数は関数型を返すミドルウェア関数を定義します。返される関数タイプは、リクエストと応答を処理する関数で、通常は HandlerFunc と呼ばれます。

HandlerFunc は次のように定義されます。

type HandlerFunc func(*Context)

ログイン後にコピー

これは、リクエストのコンテキストを表す *Context 型のパラメーターを受け取ります。 #Context タイプには、リクエストヘッダー、リクエスト本文、リクエストパラメータなど、リクエスト内のさまざまな情報が含まれます。

ミドルウェア関数では、コンテキストを操作して c.Next() メソッドを呼び出して、次のミドルウェアまたはルート処理関数に制御を移すことができます。

たとえば、ミドルウェアにリクエストヘッダーを追加したい場合は、次の方法で実行できます:

func AddHeader() gin.HandlerFunc {
  return func(c *gin.Context) {
    c.Header("X-Request-Id", "123456")
    c.Next()
  }
}

ログイン後にコピー

このミドルウェアは XX-Request-Id を追加します# リクエストに ##Header を追加し、制御を次のハンドラー関数に渡します。ルーティング処理関数では、c.GetHeader メソッドを通じてこのリクエストヘッダーの値を取得できます。

3. Jin フレームワークでのミドルウェアの使用

Gin フレームワークでは、ミドルウェアの使用は非常に簡単です。ミドルウェア関数を

Use、GET、POST、PUT、DELETE に渡すだけで済みます。他の方法でも可能です。例:

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

func main() {
    r := gin.Default()

    // 使用全局中间件
    r.Use(MyGlobalMiddleware())

    // 定义路由组，并使用局部中间件
    v1 := r.Group("/v1")
    {
        v1.Use(AddHeader())
        v1.GET("/hello", Hello)
    }

    r.Run(":8080")
}

func MyGlobalMiddleware() gin.HandlerFunc {
  return func(c *gin.Context) {
    // do something
    c.Next()
    // do something after
  }
}

func AddHeader() gin.HandlerFunc {
  return func(c *gin.Context) {
    c.Header("X-Request-Id", "123456")
    c.Next()
  }
}

func Hello(c *gin.Context) {
    headers := c.Request.Header
    requestId := headers.Get("X-Request-Id")
    c.JSON(200, gin.H{
        "message": "hello",
        "request_id": requestId,
    })
}

ログイン後にコピー

上記のコードでは、すべてのルートで動作するグローバルミドルウェア

MyGlobalMiddleware() を使用します。また、ローカルミドルウェア AddHeader() も使用します。これは、/v1/hello ルートの前でのみ機能します。 Hello 関数では、XX-Request-Id リクエストヘッダーの値を取得し、呼び出し元に返します。

このコードのデモンストレーションを通じて、Gin フレームワークでミドルウェアを使用する簡単で便利な方法がわかります。

4. 共通ミドルウェア

上記のカスタマイズされたミドルウェアに加えて、Gin フレームワークは多くの共通ミドルウェアも提供しています。以下では、より重要なミドルウェアのいくつかを簡単に紹介します:

ロガーミドルウェアは、アクセスログを出力するミドルウェアであり、リクエストが途中まで処理された場合に、リクエストされたURL、リクエストメソッド、リクエストなどの情報を出力します。リクエストヘッダーなど

Gin フレームワークでは、次のコードを使用して Logger ミドルウェアを導入できます。

r := gin.New()
r.Use(gin.Logger())

ログイン後にコピー

Logger ミドルウェアを導入すると、アクセスログで各リクエストの詳細情報を確認できます。

リカバリミドルウェアは、プログラムで例外が発生した場合に、プログラムを正常な動作に戻してエラーを出力するエラー処理ミドルウェアです。メッセージ。エラーメッセージ。

Gin フレームワークでは、次のコードを使用して Recovery ミドルウェアを導入できます。

r := gin.Default()
r.Use(gin.Recovery())

ログイン後にコピー

このミドルウェアを導入した後、プログラムで例外が発生した場合、プログラムは直接クラッシュしませんが、これを実行すると、問題を迅速に特定できるようにエラーメッセージが出力されます。

Cors ミドルウェアは、クロスドメインリクエストの処理に使用されます。別のドメイン名で API にリクエストを送信する必要がある場合は、 CORS によって検証されています。そうでない場合、リクエストは拒否されます。

Gin フレームワークでは、次のコードを使用して Cors ミドルウェアを導入できます:

r := gin.Default()
r.Use(cors.Default())

ログイン後にコピー

このミドルウェアを導入した後は、CORS 検証の失敗を気にすることなく、別のドメイン名で API にリクエストを送信できるようになります。

5. まとめ

この記事では主にGinフレームワークのミドルウェアの仕組みとその応用について紹介しますが、実際の開発においてミドルウェアは非常に重要な役割を果たします。ミドルウェアの仕組みを深く理解することで、ミドルウェアの機能をより活用し、開発効率やプログラムの保守性を向上させることができます。

共通ミドルウェアを導入することで、ログ出力、エラー処理、クロスドメインリクエストなどの機能をプログラムに追加し、実際のアプリケーションシナリオに適応させることもできます。

したがって、Gin フレームワークの開発プロセスでは、ミドルウェアの使い方をマスターすることが非常に重要なスキルとなります。

以上がGinフレームワークのミドルウェアとその応用について詳しく解説の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。