速率限制

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

注意

如果提供的 rate 是浮点数，Burst 会被视为 rate 向下取整后的值。

自定义配置

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

提示

要实现自己的 store，请满足 RateLimiterStore 接口，并把它传给 RateLimiterConfig。

配置

RateLimiterConfig · github.com/labstack/echo/v5@5196b9b

字段说明由英文源码注释生成。

包源码中的字段

字段	类型	说明	源码
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/v5@5196b9b

字段说明由英文源码注释生成。

包源码中的字段

字段	类型	说明	源码
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,
    }
  },
}