无法抓住我的头围棋率包

Question

我需要对 API 的请求进行速率限制，我正在考虑为此使用本机 golang.org/x/time/rate 包。为了稍微摆弄一下它的 API 并确保我的假设是正确的，我创建了这个测试，但我似乎在这里遗漏了一些东西：

package main

import (
    "github.com/stretchr/testify/require"
    "golang.org/x/time/rate"
    "sync"
    "testing"
)

func TestLimiter(t *testing.T) {
    limiter := rate.NewLimiter(rate.Limit(5),1)
    wg := sync.WaitGroup{}
    successful := 0

    for i:=1; i<=10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            if limiter.Allow() {
                successful++
            }
        }()
    }
    wg.Wait()

    require.Equal(t, 5, successful)
    
    // This test fails with
    // Expected :5
    // Actual   :1
}

谁能解释一下这是为什么？限速器不应该允许 5 req/s 吗？

Answer 1

首先，您有一场数据竞赛。多个 goroutine 写入 successful 而不同步：未定义的行为。

您可以使用sync/atomic 包进行简单安全的计数：

limiter := rate.NewLimiter(rate.Limit(5), 1)
wg := sync.WaitGroup{}
successful := int32(0)

for i := 1; i <= 10; i++ {
    wg.Add(1)
    go func() {
        defer wg.Done()
        if limiter.Allow() {
            atomic.AddInt32(&successful, 1)
        }
    }()
}
wg.Wait()

fmt.Println(successful)

这将输出：

1

为什么？因为您每秒允许 5 个事件，所以每 0.2 秒有 1 个事件。启动 10 个 goroutine 并检查将花费不到 0.2 秒，因此只允许一个事件。

如果你在循环中添加 200 毫秒的睡眠，那么所有的都将被允许并且输出将是 10:

for i := 1; i <= 10; i++ {
    time.Sleep(200 * time.Millisecond)
    wg.Add(1)
    go func() {
        defer wg.Done()
        if limiter.Allow() {
            atomic.AddInt32(&successful, 1)
        }
    }()
}

如果您添加 100 毫秒的睡眠时间，那么平均一半的时间将被允许，并且输出将为 5。

您想要的可能是允许 5 个突发事件/秒：

limiter := rate.NewLimiter(rate.Limit(5), 5)

在没有睡眠的情况下使用这个limiter，您还将获得5 的输出。这是因为允许 5 个事件而不达到速率限制，而没有睡眠则不允许其余的事件。