レートリミッター

RateLimiter は、特定の IP または識別子からサーバーへ送信されるリクエスト数を一定期間内で制限するレートリミッターミドルウェアを提供します。

デフォルトでは、インメモリ store がリクエストを追跡します。デフォルトのインメモリ実装は正確性に重点を置いており、大量の同時リクエストや多数の異なる識別子（>16k）には最適ではない場合があります。

すべてのコアミドルウェアは middleware パッケージに含まれています：

import "github.com/labstack/echo/v5/middleware"

使い方

アプリケーションにレート制限を追加するには、RateLimiter ミドルウェアを追加します。次の例では、デフォルトのインメモリ store を使ってアプリケーションを 20 requests/sec に制限します。

e.Use(middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(20.0)))

カスタム設定

config := middleware.RateLimiterConfig{
  Skipper: middleware.DefaultSkipper,
  Store: middleware.NewRateLimiterMemoryStoreWithConfig(
    middleware.RateLimiterMemoryStoreConfig{Rate: 10, Burst: 30, ExpiresIn: 3 * time.Minute},
  ),
  IdentifierExtractor: func(c *echo.Context) (string, error) {
    id := c.RealIP()
    return id, nil
  },
  ErrorHandler: func(c *echo.Context, err error) error {
    return c.JSON(http.StatusForbidden, nil)
  },
  DenyHandler: func(c *echo.Context, identifier string, err error) error {
    return c.JSON(http.StatusTooManyRequests, nil)
  },
}

e.Use(middleware.RateLimiterWithConfig(config))

エラー

var (
  // ErrRateLimitExceeded denotes an error raised when the rate limit is exceeded.
  ErrRateLimitExceeded = echo.NewHTTPError(http.StatusTooManyRequests, "rate limit exceeded")
  // ErrExtractorError denotes an error raised when the extractor function is unsuccessful.
  ErrExtractorError = echo.NewHTTPError(http.StatusForbidden, "error while extracting identifier")
)

設定

RateLimiterConfig · github.com/labstack/echo/[email protected]

フィールドの説明は英語のソースコードのコメントから生成されています。

パッケージのソースコードのフィールド
フィールド	型	説明	ソース
`Skipper`	`Skipper`	—	L39
`BeforeFunc`	`BeforeFunc`	—	L40
`IdentifierExtractor`	`Extractor`	IdentifierExtractor uses *echo.Context to extract the identifier for a visitor	L42
`Store`	`RateLimiterStore`	Store defines a store for the rate limiter	L44
`ErrorHandler`	`func(c *echo.Context, err error) error`	ErrorHandler provides a handler to be called when IdentifierExtractor returns an error	L46
`DenyHandler`	`func(c *echo.Context, identifier string, err error) error`	DenyHandler provides a handler to be called when RateLimiter denies access	L48

パッケージのソースコードの関数
型	ソース
`func RateLimiter(store RateLimiterStore) echo.MiddlewareFunc`	L86
`func RateLimiterWithConfig(config RateLimiterConfig) echo.MiddlewareFunc`	L119

RateLimiterMemoryStoreConfig · github.com/labstack/echo/[email protected]

フィールドの説明は英語のソースコードのコメントから生成されています。

パッケージのソースコードのフィールド
フィールド	型	説明	ソース
`Rate`	`float64`	—	L245
`Burst`	`int`	—	L246
`ExpiresIn`	`time.Duration`	—	L247

パッケージのソースコードの関数
型	ソース
`func NewRateLimiterMemoryStore(rateLimit float64) (store *RateLimiterMemoryStore)`	L200
`func NewRateLimiterMemoryStoreWithConfig(config RateLimiterMemoryStoreConfig) (store *RateLimiterMemoryStore)`	L225

デフォルト設定

// DefaultRateLimiterConfig defines default values for RateLimiterConfig.
var DefaultRateLimiterConfig = RateLimiterConfig{
  Skipper: DefaultSkipper,
  IdentifierExtractor: func(c *echo.Context) (string, error) {
    id := c.RealIP()
    return id, nil
  },
  ErrorHandler: func(c *echo.Context, err error) error {
    return &echo.HTTPError{
      Code:     ErrExtractorError.Code,
      Message:  ErrExtractorError.Message,
      Internal: err,
    }
  },
  DenyHandler: func(c *echo.Context, identifier string, err error) error {
    return &echo.HTTPError{
      Code:     ErrRateLimitExceeded.Code,
      Message:  ErrRateLimitExceeded.Message,
      Internal: err,
    }
  },
}