-
go time/rate 接口-账户/IP 限流
-
接口限流
-
按账户/IP/Token限流
-
定时加载配置
time/rate 原理
time/rate 是go提供的官方限流工具
原理: 令牌桶,以一个恒定的速度往桶里放入令牌,而如果请求需要被处理,则需要先从桶里获取一个令牌,当桶里没有令牌可取时,则拒绝服务
我首先想到的方案初始化定时任务,每隔多长时间往桶里放一令牌。但是相比之下,time/rate的实现方式就是更优雅了
关键变量:
-
令牌放入桶的速度 limit 每秒产生多少token
-
桶的容量 burst
已知变量:
-
最后一次消耗令牌的时间 last
简化公式:
当前可用令牌数,tokens := (now - last).Seconds() * limit
完整代码是:
// advance calculates and returns an updated state for lim resulting from the passage of time.
// lim is not changed.
func (lim *Limiter) advance(now time.Time) (newNow time.Time, newLast time.Time, newTokens float64) {
last := lim.last
if now.Before(last) {
last = now
}
// Avoid making delta overflow below when last is very old.
// 这里限制令牌数不超过burst,lim.tokens 是上一次结余
maxElapsed := lim.limit.durationFromTokens(float64(lim.burst) - lim.tokens)
elapsed := now.Sub(last)
if elapsed > maxElapsed {
elapsed = maxElapsed
}
// Calculate the new number of tokens, due to time that passed.
delta := lim.limit.tokensFromDuration(elapsed)
tokens := lim.tokens + delta // 上一次结余 + 时间增量
if burst := float64(lim.burst); tokens > burst {
tokens = burst
}
return now, last, tokens
}
比起定时器来说是不是很优雅?这里有个比较绕的点:limit 的单位,n/s, 每秒多少个令牌
// Every converts a minimum time interval between events to a Limit.
func Every(interval time.Duration) Limit {
if interval <= 0 {
return Inf
}
return 1 / Limit(interval.Seconds())
}
计算可用tokens的公式就更好理解了,用 (now (当前时间) - last(上一次消耗令牌的时间) ).Seconds() * limit 就是增量令牌数了
time/rate 改造
time/rate 只是给出了最基础的实现,绝大部分的需求
-
接口 > IP/user 多层限流
-
动态加载配置
-
在响应中给出剩余请求次数,下一次重置时间
其实 time/rate 的成本是非常低的,所以我们只需要多层map结构就可以满足, 每次初始化一个 rate.Limiter 就可以满足
type ApiKeyRateLimit interface {
Load()
GetLimiter(api, key string) (limiter *Limiter, ok bool)
}
type ApiKeyRateLimitImpl struct {
hub map[string]map[string]*rate.Limiter
}
动态加载配置,可以使用etcd订阅配置,我实现的是定时从数据库里捞配置
type ApiAccountRateLimit struct {
ctx context.Context
lim rate.ApiKeyRateLimit
}
func NewApiAccountRateLimit(ctx context.Context, limit rate.ApiKeyRateLimit) *ApiAccountRateLimit {
r := &ApiAccountRateLimit{
ctx: ctx,
lim: limit,
}
go r.load()
return r
}
func (h *ApiAccountRateLimit) Hook() gin.HandlerFunc {
return func(ctx *gin.Context) {
path := ctx.Request.URL.Path
acctId, ok := ctx.Get(consts.OpenapiAccountId)
if !ok {
ctx.JSON(http.StatusOK, gin.H{"code": http.StatusUnauthorized, "message": http.StatusText(http.StatusUnauthorized)})
ctx.Abort()
return
}
limiter, ok := h.lim.GetLimiter(path, acctId.(string))
if !ok {
ctx.JSON(http.StatusOK, gin.H{"code": http.StatusUnauthorized, "message": http.StatusText(http.StatusUnauthorized)})
ctx.Abort()
}
// 这里time/rat没有放出Advance,需要改一下
_, _, tokens := limiter.Advance(time.Now())
burst := limiter.Burst()
ctx.Header("X-RateLimit-Limit", strconv.Itoa(burst))
ctx.Header("X-RateLimit-Remaining", strconv.Itoa(int(tokens)))
if !limiter.Allow() {
ctx.JSON(http.StatusOK, gin.H{"code": http.StatusTooManyRequests, "message": http.StatusText(http.StatusTooManyRequests)})
ctx