Iris のリクエストレート制限ミドルウェア-Golang-php.cn

Iris のリクエストレート制限ミドルウェア

Susan Sarandon

リリース： 2024-10-31 11:58:02

オリジナル

1015 人が閲覧しました

Request Rate Limiting Middleware for Iris

概要

レートミドルウェアは、Iris Web フレームワークにレート制限機能を提供します。これにより、開発者はアプリケーションへのリクエストのレートを制御し、公正な使用を保証し、悪用を防ぐことができます。このミドルウェアは、レート制限の一般的な方法であるトークンバケットアルゴリズムに基づいています。

インストール

レートミドルウェアを使用するには、それを Iris アプリケーションにインポートする必要があります:

import "github.com/kataras/iris/v12/middleware/rate"

ログイン後にコピー

使用法

基本的なセットアップ

レートリミッターを使用するには、Iris アプリケーションを作成し、ミドルウェアを登録する必要があります。以下は、レートリミッターを設定する方法の例です:

package main

import (
    "time"

    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/rate"
)

func main() {
    app := iris.New()
    app.Logger().SetLevel("debug")

    limit := rate.Limit(1, 5, rate.PurgeEvery(time.Minute, 5*time.Minute))
    app.Use(limit)

    app.Get("/", index)
    app.Get("/other", other)

    app.Listen(":8080")
}

func index(ctx iris.Context) {
    ctx.HTML("<h1>Index Page</h1>")
}

func other(ctx iris.Context) {
    ctx.HTML("<h1>Other Page</h1>")
}

ログイン後にコピー

この例では、最大バーストサイズ 5 で 1 秒あたり 1 つのリクエストが許可されます。また、5 分間表示されなかった古いエントリは 1 分ごとに削除されます。

rate.Every ヘルパーの使用

この例は、レートの使用方法を示しています。レートリミッターを設定するためのすべてのヘルパー:

package main

import (
    "time"

    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/rate"
)

func main() {
    app := iris.New()
    app.Logger().SetLevel("debug")

    // Use rate.Every helper to set up the rate limiter.
    limit := rate.Limit(rate.Every(time.Minute), 5)
    app.Use(limit)

    app.Get("/", index)
    app.Get("/other", other)

    app.Listen(":8080")
}

func index(ctx iris.Context) {
    ctx.HTML("<h1>Index Page</h1>")
}

func other(ctx iris.Context) {
    ctx.HTML("<h1>Other Page</h1>")
}

ログイン後にコピー

レート制限に API キーを使用する

この例は、クライアントのリモート IP アドレスの代わりに API キーを使用するレートリミッターを設定する方法を示しています。

package main

import (
    "time"

    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/rate"
)

func main() {
    app := iris.New()
    app.Logger().SetLevel("debug")

    // Use API key for rate limiting.
    app.Use(useAPIKey)

    limit := rate.Limit(rate.Every(time.Minute), 300, rate.PurgeEvery(5*time.Minute, 15*time.Minute))
    app.Use(limit)

    app.Get("/list", list)

    app.Listen(":8080")
}

func useAPIKey(ctx iris.Context) {
    apiKey := ctx.Header("X-API-Key")
    if apiKey == "" {
        ctx.StopWithStatus(iris.StatusForbidden)
        return
    }

    rate.SetIdentifier(ctx, apiKey)
    ctx.Next()
}

func list(ctx iris.Context) {
    ctx.JSON(iris.Map{"key": "value"})
}

ログイン後にコピー

カスタム超過ハンドラー

この例は、レート制限を超えたときに実行されるカスタムハンドラーを設定する方法を示しています。

package main

import (
    "time"

    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/rate"
)

func main() {
    app := iris.New()
    app.Logger().SetLevel("debug")

    // Set a custom exceed handler.
    limit := rate.Limit(1, 5, rate.ExceedHandler(func(ctx iris.Context) {
        ctx.StopWithStatus(429)
    }))
    app.Use(limit)

    app.Get("/", index)
    app.Get("/other", other)

    app.Listen(":8080")
}

func index(ctx iris.Context) {
    ctx.HTML("<h1>Index Page</h1>")
}

func other(ctx iris.Context) {
    ctx.HTML("<h1>Other Page</h1>")
}

ログイン後にコピー

カスタムクライアントデータ

この例は、各クライアントのカスタムデータを保存する方法を示しています。

package main

import (
    "time"

    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/rate"
)

func main() {
    app := iris.New()
    app.Logger().SetLevel("debug")

    // Store custom data for each client.
    limit := rate.Limit(1, 5, rate.ClientData(func(ctx iris.Context) any {
        return ctx.RemoteAddr()
    }))
    app.Use(limit)

    app.Get("/", index)
    app.Get("/other", other)

    app.Listen(":8080")
}

func index(ctx iris.Context) {
    ctx.HTML("<h1>Index Page</h1>")
}

func other(ctx iris.Context) {
    ctx.HTML("<h1>Other Page</h1>")
}

ログイン後にコピー

説明

レート制限: rate.Limit 関数は、新しいレートリミッターを作成するために使用されます。 3 つのパラメータを取ります:
- 制限: 1 秒あたりに許可されるリクエストの最大数。
- バースト: 最大バーストサイズ。
- オプション: 古いエントリをクリーンアップするための PurgeEvery などの追加オプション。
トークンバケットアルゴリズム: このアルゴリズムは、トークンのバケットを維持することによってリクエストのレートを制御します。各リクエストはトークンを消費し、トークンは固定レートでバケットに追加されます。バケットが空の場合、リクエストは拒否されます。