limiter

package

v2.2.1 Latest Latest Go to latest Published: Apr 10, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Limiter interface {
	// Limit 限制、限流，是否触发限流。
	// 返回True就是触发限流。
	Limit(ctx context.Context, key string) (bool, error)
}

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

RedisSlideWindowKLimiter Redis滑动窗口限流器

func NewRedisSlideWindowKLimiter(cmd redis.Cmdable, interval time.Duration, rate int) *RedisSlideWindowKLimiter

NewRedisSlideWindowKLimiter 创建一个Redis滑动窗口限流器

func NewRedisSlideWindowKLimiterWithPrefix(cmd redis.Cmdable, prefix string, interval time.Duration, rate int) *RedisSlideWindowKLimiter

NewRedisSlideWindowKLimiterWithPrefix 创建带自定义前缀的Redis滑动窗口限流器

func (b *RedisSlideWindowKLimiter) GetConfig() (time.Duration, int)

GetConfig 获取限流器配置

func (b *RedisSlideWindowKLimiter) GetPrefix() string

GetPrefix 获取Redis key前缀

func (b *RedisSlideWindowKLimiter) Limit(ctx context.Context, key string) (bool, error)

Limit 检查是否触发限流（使用自动生成的请求ID）

func (b *RedisSlideWindowKLimiter) LimitWithCustomKey(ctx context.Context, fullKey string) (bool, error)

LimitWithCustomKey 使用自定义完整key进行检查（不添加前缀）

func (b *RedisSlideWindowKLimiter) LimitWithCustomKeyAndRequestID(ctx context.Context, fullKey, requestID string) (bool, error)

LimitWithCustomKeyAndRequestID 使用自定义完整key和请求ID进行检查

func (b *RedisSlideWindowKLimiter) LimitWithRequestID(ctx context.Context, key, requestID string) (bool, error)

LimitWithRequestID 检查是否触发限流（使用指定的请求ID）

func (b *RedisSlideWindowKLimiter) SetPrefix(prefix string)

SetPrefix 设置Redis key前缀

Path	Synopsis
mocks Package limitermocks is a generated GoMock package.	Package limitermocks is a generated GoMock package.