diff --git a/abstract/limit.go b/abstract/limit.go new file mode 100644 index 0000000..0dd3382 --- /dev/null +++ b/abstract/limit.go @@ -0,0 +1,23 @@ +// Package abstract ... +// +// Description : abstract ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-06-20 11:33 +package abstract + +import ( + "context" + "git.zhangdeman.cn/zhangdeman/rate_limit/define" +) + +// IRateLimit 流控实现接口约束 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 11:33 2024/6/20 +type IRateLimit interface { + AllowN(ctx context.Context, limitCfg *define.LimitConfig, tokenCnt int) (bool, error) // 申请N个令牌, N >= 0 + Reset(ctx context.Context, limitCfg *define.LimitConfig) error // 重置 +} diff --git a/define/limit.go b/define/limit.go new file mode 100644 index 0000000..7e9ad56 --- /dev/null +++ b/define/limit.go @@ -0,0 +1,20 @@ +// Package define ... +// +// Description : define ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-06-20 14:36 +package define + +// LimitConfig ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 15:17 2024/6/20 +type LimitConfig struct { + Key string `json:"key"` // 操作的key + Total int `json:"total"` // 令牌桶大小 + Rate int `json:"rate"` // 同步速率 + TimeInterval int64 `json:"time_interval"` // 同步的时间间隔, 单位 : s +} diff --git a/go.mod b/go.mod index 35220c3..926c626 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,34 @@ module git.zhangdeman.cn/zhangdeman/rate_limit go 1.22.4 + +require ( + git.zhangdeman.cn/zhangdeman/redis v0.0.0-20240620104455-27e193a0ea47 + github.com/go-redis/redis_rate/v10 v10.0.1 + github.com/redis/go-redis/v9 v9.5.3 +) + +require ( + git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240617073616-39e82fd033ed // indirect + git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20240311030808-e2a2e6a3c211 // indirect + git.zhangdeman.cn/zhangdeman/op_type v0.0.0-20240122104027-4928421213c0 // indirect + git.zhangdeman.cn/zhangdeman/serialize v0.0.0-20240618035451-8d48a6bd39dd // indirect + git.zhangdeman.cn/zhangdeman/util v0.0.0-20240618042405-6ee2c904644e // indirect + git.zhangdeman.cn/zhangdeman/wrapper v0.0.0-20240612083858-8d056baada2e // indirect + github.com/BurntSushi/toml v1.4.0 // indirect + github.com/axgle/mahonia v0.0.0-20180208002826-3358181d7394 // indirect + github.com/cespare/xxhash/v2 v2.3.0 // indirect + github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect + github.com/go-ini/ini v1.67.0 // indirect + github.com/mitchellh/go-homedir v1.1.0 // indirect + github.com/mozillazg/go-pinyin v0.20.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + github.com/spaolacci/murmur3 v1.1.0 // indirect + github.com/tidwall/gjson v1.17.1 // indirect + github.com/tidwall/match v1.1.1 // indirect + github.com/tidwall/pretty v1.2.1 // indirect + go.uber.org/multierr v1.11.0 // indirect + go.uber.org/zap v1.27.0 // indirect + golang.org/x/time v0.5.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..69ef50f --- /dev/null +++ b/go.sum @@ -0,0 +1,65 @@ +git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240617073616-39e82fd033ed h1:BGv+y6ZdtkxI4HeSIHun0QRrIzjLnUht0bKdyO2t6n4= +git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240617073616-39e82fd033ed/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k= +git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20240311030808-e2a2e6a3c211 h1:I/wOsRpCSRkU9vo1u703slQsmK0wnNeZzsWQOGtIAG0= +git.zhangdeman.cn/zhangdeman/easymap v0.0.0-20240311030808-e2a2e6a3c211/go.mod h1:SrtvrQRdzt+8KfYzvosH++gWxo2ShPTzR1m3VQ6uX7U= +git.zhangdeman.cn/zhangdeman/op_type v0.0.0-20240122104027-4928421213c0 h1:gUDlQMuJ4xNfP2Abl1Msmpa3fASLWYkNlqDFF/6GN0Y= +git.zhangdeman.cn/zhangdeman/op_type v0.0.0-20240122104027-4928421213c0/go.mod h1:VHb9qmhaPDAQDcS6vUiDCamYjZ4R5lD1XtVsh55KsMI= +git.zhangdeman.cn/zhangdeman/redis v0.0.0-20240620104455-27e193a0ea47 h1:Taq1XyvDgFM/xTSEw3cUOWh4krgqfEDIzcVrqQ7Z3UE= +git.zhangdeman.cn/zhangdeman/redis v0.0.0-20240620104455-27e193a0ea47/go.mod h1:OImVgoNTw9qWxGrgrym0wtEMdx0ekaH7vJJKIgSpdEg= +git.zhangdeman.cn/zhangdeman/serialize v0.0.0-20240618035451-8d48a6bd39dd h1:2Y37waOVCmVvx0Rp8VGEptE2/2JVMImtxB4dKKDk/3w= +git.zhangdeman.cn/zhangdeman/serialize v0.0.0-20240618035451-8d48a6bd39dd/go.mod h1:6+7whkCmb4sJDIfH3HxNuXRveaM0gCCNWd2uXZqNtIE= +git.zhangdeman.cn/zhangdeman/util v0.0.0-20240618042405-6ee2c904644e h1:Q973S6CcWr1ICZhFI1STFOJ+KUImCl2BaIXm6YppBqI= +git.zhangdeman.cn/zhangdeman/util v0.0.0-20240618042405-6ee2c904644e/go.mod h1:VpPjBlwz8U+OxZuxzHQBv1aEEZ3pStH6bZvT21ADEbI= +git.zhangdeman.cn/zhangdeman/wrapper v0.0.0-20240612083858-8d056baada2e h1:+PeWa2QdYBWnL32CfAAgy0dlaRCVNmYZDH4q+9w7Gfg= +git.zhangdeman.cn/zhangdeman/wrapper v0.0.0-20240612083858-8d056baada2e/go.mod h1:US/pcq2vstE3iyxIHf53w8IeXKkZys7bj/ozLWkRYeE= +github.com/BurntSushi/toml v1.4.0 h1:kuoIxZQy2WRRk1pttg9asf+WVv6tWQuBNVmK8+nqPr0= +github.com/BurntSushi/toml v1.4.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho= +github.com/axgle/mahonia v0.0.0-20180208002826-3358181d7394 h1:OYA+5W64v3OgClL+IrOD63t4i/RW7RqrAVl9LTZ9UqQ= +github.com/axgle/mahonia v0.0.0-20180208002826-3358181d7394/go.mod h1:Q8n74mJTIgjX4RBBcHnJ05h//6/k6foqmgE45jTQtxg= +github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs= +github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c= +github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA= +github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0= +github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= +github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc= +github.com/go-ini/ini v1.67.0 h1:z6ZrTEZqSWOTyH2FlglNbNgARyHG8oLW9gMELqKr06A= +github.com/go-ini/ini v1.67.0/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8= +github.com/go-redis/redis_rate/v10 v10.0.1 h1:calPxi7tVlxojKunJwQ72kwfozdy25RjA0bCj1h0MUo= +github.com/go-redis/redis_rate/v10 v10.0.1/go.mod h1:EMiuO9+cjRkR7UvdvwMO7vbgqJkltQHtwbdIQvaBKIU= +github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mozillazg/go-pinyin v0.20.0 h1:BtR3DsxpApHfKReaPO1fCqF4pThRwH9uwvXzm+GnMFQ= +github.com/mozillazg/go-pinyin v0.20.0/go.mod h1:iR4EnMMRXkfpFVV5FMi4FNB6wGq9NV6uDWbUuPhP4Yc= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/redis/go-redis/v9 v9.5.3 h1:fOAp1/uJG+ZtcITgZOfYFmTKPE7n4Vclj1wZFgRciUU= +github.com/redis/go-redis/v9 v9.5.3/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M= +github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI= +github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/tidwall/gjson v1.17.1 h1:wlYEnwqAHgzmhNUFfw7Xalt2JzQvsMx2Se4PcoFCT/U= +github.com/tidwall/gjson v1.17.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= +go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= +golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk= +golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/memory.go b/memory.go new file mode 100644 index 0000000..c61dc1c --- /dev/null +++ b/memory.go @@ -0,0 +1,54 @@ +// Package rate_limit ... +// +// Description : rate_limit ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-06-20 20:40 +package rate_limit + +import ( + "context" + "git.zhangdeman.cn/zhangdeman/rate_limit/define" + "golang.org/x/time/rate" + "sync" + "time" +) + +var ( + MemoryClient = &Memory{ + lock: &sync.RWMutex{}, + limiterTable: make(map[string]*rate.Limiter), + } +) + +// Memory ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 20:40 2024/6/20 +type Memory struct { + lock *sync.RWMutex + limiterTable map[string]*rate.Limiter +} + +func (m *Memory) AllowN(ctx context.Context, limitCfg *define.LimitConfig, tokenCnt int) (bool, error) { + limiter := m.getLimiter(limitCfg) + return limiter.AllowN(time.Now(), tokenCnt), nil +} + +func (m *Memory) Reset(ctx context.Context, limitCfg *define.LimitConfig) error { + m.lock.Lock() + defer m.lock.Unlock() + delete(m.limiterTable, limitCfg.Key) + return nil +} + +func (m *Memory) getLimiter(limitCfg *define.LimitConfig) *rate.Limiter { + m.lock.Lock() + defer m.lock.Unlock() + if _, exist := m.limiterTable[limitCfg.Key]; !exist { + m.limiterTable[limitCfg.Key] = rate.NewLimiter(rate.Limit(limitCfg.Rate), limitCfg.Total) + } + return m.limiterTable[limitCfg.Key] +} diff --git a/memory_test.go b/memory_test.go new file mode 100644 index 0000000..9dfdb94 --- /dev/null +++ b/memory_test.go @@ -0,0 +1,27 @@ +// Package rate_limit ... +// +// Description : rate_limit ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-06-20 20:55 +package rate_limit + +import ( + "context" + "fmt" + "git.zhangdeman.cn/zhangdeman/rate_limit/define" + "testing" +) + +func TestMemory_AllowN(t *testing.T) { + + for i := 0; i < 10; i++ { + fmt.Println(MemoryClient.AllowN(context.Background(), &define.LimitConfig{ + Key: "deman", + Total: 15, + Rate: 10, + TimeInterval: 10, + }, 8)) + } +} diff --git a/redis.go b/redis.go new file mode 100644 index 0000000..d12a2c7 --- /dev/null +++ b/redis.go @@ -0,0 +1,150 @@ +// Package rate_limit ... +// +// Description : rate_limit ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2023-03-09 11:31 +package rate_limit + +import ( + "context" + "git.zhangdeman.cn/zhangdeman/rate_limit/define" + "github.com/go-redis/redis_rate/v10" + redisInstance "github.com/redis/go-redis/v9" + "sync" + "time" +) + +var ( + RedisClient = &Redis{} +) + +// Redis ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 11:44 2024/6/20 +type Redis struct { + limiter *redis_rate.Limiter // limiter 限流实例 + redisClient *redisInstance.Client // redis 客户端实例 + lock *sync.RWMutex +} + +func (r *Redis) SetRedisClient(client *redisInstance.Client) { + r.redisClient = client + r.limiter = redis_rate.NewLimiter(r.redisClient) +} + +func (r *Redis) AllowN(ctx context.Context, limitCfg *define.LimitConfig, tokenCnt int) (bool, error) { + if limitCfg.Total <= 0 || limitCfg.Rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, limitCfg.Key, redis_rate.Limit{ + Rate: limitCfg.Rate, + Period: time.Duration(limitCfg.TimeInterval) * time.Second, + Burst: limitCfg.Total, + }, tokenCnt) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Reset(ctx context.Context, limitCfg *define.LimitConfig) error { + return r.limiter.Reset(ctx, limitCfg.Key) +} + +/*func (r *Redis) Second(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.PerSecond(total), rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Minute(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.PerMinute(total), rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Hour(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.PerHour(total), rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Day(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.Limit{ + Rate: rate, + Period: 24 * time.Hour, + Burst: total, + }, rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Month(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.Limit{ + Rate: rate, + Period: 24 * 30 * time.Hour, + Burst: total, + }, rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Year(ctx context.Context, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.Limit{ + Rate: rate, + Period: 24 * 30 * 365 * time.Hour, + Burst: total, + }, rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} + +func (r *Redis) Custom(ctx context.Context, timeInfo int64, key string, total, rate int) (bool, error) { + if total <= 0 || rate <= 0 { + return true, nil + } + res, err := r.limiter.AllowN(ctx, key, redis_rate.Limit{ + Rate: rate, + Period: time.Duration(timeInfo) * time.Second, + Burst: total, + }, rate) + if nil != err { + return false, err + } + return res.Allowed > 0, nil +} +*/ diff --git a/redis_test.go b/redis_test.go new file mode 100644 index 0000000..fc36fbc --- /dev/null +++ b/redis_test.go @@ -0,0 +1,37 @@ +// Package rate_limit ... +// +// Description : rate_limit ... +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 2024-06-20 18:01 +package rate_limit + +import ( + "context" + "fmt" + "git.zhangdeman.cn/zhangdeman/rate_limit/define" + wrapRedis "git.zhangdeman.cn/zhangdeman/redis" + wrapRedisDefine "git.zhangdeman.cn/zhangdeman/redis/define" + "testing" + "time" +) + +func TestRedis_AllowN(t *testing.T) { + _ = wrapRedis.Client.AddClient("test_rate_limit", &wrapRedisDefine.Options{ + Addr: "127.0.0.1:6379", + Password: "123456", + DB: 6, + }) + RedisClient.SetRedisClient(wrapRedis.Client.GetRealClient("test_rate_limit")) + for i := 0; i < 1000; i++ { + allow, err := RedisClient.AllowN(context.Background(), &define.LimitConfig{ + Key: "deman", + Total: 60, + Rate: 10, + TimeInterval: 60, + }, 8) + fmt.Println(allow, err) + time.Sleep(time.Second) + } +}