go官方自带限流神器time/rate详细教程

golang.org/x/time/rate 是 Go 语言官方提供的一个限流库，用于在程序中限制特定操作的速率。该库使用了令牌桶算法，可以通过设置一个速率限制r（即每秒可以执行的操作数）和一个容量b（即令牌桶的大小）来控制操作的速率。下面是该库的详细使用教程。

1. Allow(l Limit) bool:
   该方法用于检查是否可以处理一个事件（或一个令牌），返回一个布尔值。如果令牌桶中有足够的令牌以满足要求，则返回true；否则返回false。

示例代码：

package main

import (
	"fmt"
	"golang.org/x/time/rate"
	"time"
)

func main() {
	r := rate.NewLimiter(1, 5) // 每秒放置1个令牌，最多存储5个令牌
	for i := 0; i < 10; i++ {
		if r.Allow() {
			fmt.Println("Handle event", i)
		} else {
			fmt.Println("Rate limited", i)
		}
	}
}

2. AllowN(l Limit, n int) bool:
该方法与Allow方法类似，但可以同时处理n个事件（或令牌），返回一个布尔值。如果令牌桶中有足够的令牌以满足要求，则返回true；否则返回false。

示例代码：

package main

import (
	"fmt"
	"golang.org/x/time/rate"
	"time"
)

func main() {
	r := rate.NewLimiter(1, 5) // 每秒放置1个令牌，最多存储5个令牌
	for i := 0; i < 10; i++ {
		if r.AllowN(time.Now(), 2) { // 每次处理2个事件
			fmt.Println("Handle events", i, i+1)
		} else {
			fmt.Println("Rate limited", i, i+1)
		}
		time.Sleep(time.Second)
	}
}

3. Burst() int:
   该方法返回令牌桶的容量，即最大的令牌数量。

4. Limit() Limit:
   该方法返回令牌桶的限制速率。

5. Reserve(l Limit) *Reservation:
   该方法返回一个Reservation对象。Reservation对象表示一个持续时间段，表示一个事件（或令牌）的预订。使用该对象可以等待预订的时间段，然后再处理事件（或令牌）。

示例代码：

package main

import (
	"fmt"
	"golang.org/x/time/rate"
	"time"
)

func main() {
	r := rate.NewLimiter(1, 5) // 每秒放置1个令牌，最多存储5个令牌
	for i := 0; i < 10; i++ {
		res := r.Reserve() // 预订一个时间段
		if res.OK() {
			fmt.Println("Handle event", i)
			time.Sleep(res.Delay()) // 等待预订的时间段
		} else {
			fmt.Println("Rate limited", i)
		}
	}
}

6. ReserveN(l Limit, n int) *Reservation:
   该方法与Reserve方法类似，但可以同时预订n个事件（或令牌）。返回一个Reservation对象。(具体不在重复，代码可参考Reserve)

7. SetBurst(b int):
   该方法用于动态设置令牌桶的容量，即最大的令牌数量。

8. SetBurstAt(t time.Time, b int):
   该方法用于在给定的时间设置令牌桶的容量。

9. SetLimit(l Limit):
   该方法用于动态设置令牌桶的限制速率。

10. SetLimitAt(t time.Time, l Limit):
    该方法用于在给定的时间设置令牌桶的限制速率。

11. Tokens() float64:
    该方法返回令牌桶中当前的令牌数量。

12. TokensAt(t time.Time) float64:
    该方法返回在给定的时间令牌桶中的令牌数量。

13. Wait(t time.Time) bool:
    该方法等待直到指定的时间t再处理事件（或令牌）。返回一个布尔值，如果在指定的时间段内有足够的令牌，则返回true；否则返回false。

示例代码：

package main

import (
	"fmt"
	"golang.org/x/time/rate"
	"time"
)

func main() {
	r := rate.NewLimiter(1, 5) // 每秒放置1个令牌，最多存储5个令牌
	for i := 0; i < 10; i++ {
		if r.Wait(time.Now().Add(time.Second)) { // 等待1秒钟
			fmt.Println("Handle event", i)
		} else {
			fmt.Println("Rate limited", i)
		}
	}
}

14. WaitN(t time.Time, n int) bool:
    该方法与Wait方法类似，但可以同时等待n个事件（或令牌）。返回一个布尔值，如果在指定的时间段内有足够的令牌，则返回true；否则返回false。

示例代码：

package main

import (
	"fmt"
	"golang.org/x/time/rate"
	"time"
)

func main() {
	r := rate.NewLimiter(1, 5) // 每秒放置1个令牌，最多存储5个令牌
	for i := 0; i < 10; i++ {
		if r.WaitN(time.Now().Add(time.Second), 2) { // 等待1秒钟且同时等待2个事件
			fmt.Println("Handle events", i, i+1)
		} else {
			fmt.Println("Rate limited", i, i+1)
		}
	}
}

以上就是golang.org/x/time/rate包下一些常用方法的详细说明，并附带部分相应的示例代码。这些方法可以帮助你在Go语言中实现频率或速率限制，以确保程序的稳定性和可靠性。

列举几个应用场景：

1. 限制 API 请求频率：当使用第三方 API 或服务时，为了避免超出配额或触发请求限制，可以使用 rate 包来限制每秒、每分钟或每小时的请求次数。

2. 防止暴力破解：在需要用户身份验证的系统中，可以使用 rate 包来限制登录尝试的频率，以防止暴力破解。

3. 控制并发请求：在高并发环境下，为了避免系统过载，可以使用 rate 包来限制并发请求的数量。

4. 平稳限流：在系统负载过高时，为了保证服务的可用性，可以使用 rate 包来平稳地限制请求的速率，避免系统崩溃。

   带您领略万水千山