ratelimit

type Algorithm string

type Config struct {
	// Enabled 是否启用限流
	Enabled bool `koanf:"enabled"`
	// Whitelist 白名单路径（前缀匹配），命中则完全跳过限流
	Whitelist []string `koanf:"whitelist"`
	// WhiteIps 白名单 IP，命中则完全跳过限流
	WhiteIps []string `koanf:"whiteIps"`
	// IdleTimeout 空闲限流器回收时间（秒），默认 600
	IdleTimeout int `koanf:"idleTimeout"`
	// Headers 是否在响应头中输出 X-RateLimit-* 信息
	Headers bool `koanf:"headers"`
	// Rules 独立规则列表
	Rules []Rule `koanf:"rules"`
	// contains filtered or unexported fields
}

type Dimension string

type Manager struct {
	// contains filtered or unexported fields
}

type Rule struct {
	// Name 规则名，用于限流器 key 前缀与统计展示；为空时自动以路径生成
	Name string `koanf:"name"`
	// Path 匹配路径。支持三种写法：
	//   精确匹配   /api/v1/user/info
	//   前缀匹配   /api/v1/sms/*
	//   Gin 路由    /api/v1/user/:id
	// 为空表示匹配所有路径
	Path string `koanf:"path"`
	// Methods 匹配的 HTTP 方法，为空表示不限方法
	Methods []string `koanf:"methods"`
	// Algorithm 限流算法，默认 token_bucket
	Algorithm Algorithm `koanf:"algorithm"`
	// Dimension 限流维度，默认 global
	Dimension Dimension `koanf:"dimension"`
	// HeaderKey Dimension 为 header 时读取的请求头名称
	HeaderKey string `koanf:"headerKey"`
	// Rate 令牌桶：每秒生成令牌数；滑动窗口：一个窗口内允许的请求数
	Rate float64 `koanf:"rate"`
	// Burst 令牌桶容量（可突发的最大请求数），为 0 时取 Rate 向上取整
	Burst int `koanf:"burst"`
	// Window 滑动窗口时长（秒），默认 1
	Window int `koanf:"window"`
	// WindowMs 滑动窗口时长（毫秒），优先于 Window
	WindowMs int `koanf:"windowMs"`
	// MaxConcurrent concurrency 算法的最大并发请求数
	MaxConcurrent int `koanf:"maxConcurrent"`
	// Wait 触发限流时是否排队等待而非立即拒绝
	Wait bool `koanf:"wait"`
	// WaitTimeoutMs 排队等待的最长时间（毫秒），超时后拒绝
	WaitTimeoutMs int `koanf:"waitTimeoutMs"`
	// Code 被限流时返回的业务状态码，默认 errcode.TOO_MANY_REQUESTS
	Code int `koanf:"code"`
	// Message 被限流时返回的提示信息
	Message string `koanf:"message"`
	// HttpStatus 被限流时的 HTTP 状态码，默认 200（框架统一用业务码表达错误）
	HttpStatus int `koanf:"httpStatus"`
	// contains filtered or unexported fields
}