首页 > > > 用 Redis 做一个可靠的延迟队列
go get github.com/hdt3213/delayqueue 完成安装。package main
import ( "github.com/go-redis/redis/v8" "github.com/hdt3213/delayqueue" "strconv" "time")
func main() { redisCli := redis.NewClient(&redis.Options{ Addr: "127.0.0.1:6379", }) queue := delayqueue.NewQueue("example-queue", redisCli, func(payload string) bool { // 注册处理消息的回调函数 // 返回 true 表示已成功消费,返回 false 消息队列会重新投递次消息 return true }) // 发送延时消息 for i := ; i < 10; i++ { err := queue.SendDelayMsg(strconv.Itoa(i), time.Hour, delayqueue.WithRetryCount(3)) if err != nil { panic(err) } }
// 启动消费协程 done := queue.StartConsume() // 阻塞等待消费协程退出 <-done}
-- keys: pendingKey, readyKey-- argv: currentTimelocal msgs = redis.call('ZRangeByScore', KEYS[1], '0', ARGV[1]) -- 从 pending key 中找出已到投递时间的消息if (#msgs == ) then return endlocal args2 = {'LPush', KEYS[2]} -- 将他们放入 ready key 中for _,v in ipairs(msgs) do table.insert(args2, v) endredis.call(unpack(args2))redis.call('ZRemRangeByScore', KEYS[1], '0', ARGV[1]) -- 从 pending key 中删除已投递的消息ready2UnackScript 从 ready 或者 retry 中取出一条消息发送给消费者并放入 unack 中,类似于 RPopLPush:
-- keys: readyKey/retryKey, unackKey-- argv: retryTimelocal msg = redis.call('RPop', KEYS[1])if (not msg) then return endredis.call('ZAdd', KEYS[2], ARGV[1], msg)return msgunack2RetryScript 从 retry 中找出所有已到重试时间的消息并把它们移动到 unack 中:
-- keys: unackKey, retryCountKey, retryKey, garbageKey-- argv: currentTimelocal msgs = redis.call('ZRangeByScore', KEYS[1], '0', ARGV[1]) -- 找到已到重试时间的消息if (#msgs == ) then return endlocal retryCounts = redis.call('HMGet', KEYS[2], unpack(msgs)) -- 查询剩余重试次数for i,v in ipairs(retryCounts) do local k = msgs[i] if tonumber(v) > then -- 剩余次数大于 0 redis.call("HIncrBy", KEYS[2], k, -1) -- 减少剩余重试次数 redis.call("LPush", KEYS[3], k) -- 添加到 retry key 中 else -- 剩余重试次数为 0 redis.call("HDel", KEYS[2], k) -- 删除重试次数记录 redis.call("SAdd", KEYS[4], k) -- 添加到垃圾桶,等待后续删除 endendredis.call('ZRemRangeByScore', KEYS[1], '0', ARGV[1]) -- 将已处理的消息从 unack key 中删除
因为 redis 要求 lua 脚本必须在执行前在 KEYS 参数中声明自己要访问的 key, 而我们将每个 msg 有一个独立的 key,我们在执行 unack2RetryScript 之前是不知道哪些 msg key 需要被删除。所以 lua 脚本只将需要删除的消息记在 garbage key 中,脚本执行完后再通过 del 命令将他们删除:
func (q *DelayQueue) garbageCollect() error { ctx := context.Background() msgIds, err := q.redisCli.SMembers(ctx, q.garbageKey).Result() if err != nil { return fmt.Errorf("smembers failed: %v", err) } if len(msgIds) == { return nil } // allow concurrent clean msgKeys := make([]string, , len(msgIds)) for _, idStr := range msgIds { msgKeys = append(msgKeys, q.genMsgKey(idStr)) } err = q.redisCli.Del(ctx, msgKeys...).Err() if err != nil && err != redis.Nil { return fmt.Errorf("del msgs failed: %v", err) } err = q.redisCli.SRem(ctx, q.garbageKey, msgIds).Err() if err != nil && err != redis.Nil { return fmt.Errorf("remove from garbage key failed: %v", err) } return nil}之前提到的 lua 脚本都是原子性执行的,不会有其它命令插入其中。gc 函数由 3 条 redis 命令组成,在执行过程中可能会有其它命令插入执行过程中,不过考虑到一条消息进入垃圾回收流程之后不会复活所以不需要保证 3 条命令原子性。
ack 只需要将消息彻底删除即可:
func (q *DelayQueue) ack(idStr string) error { ctx := context.Background() err := q.redisCli.ZRem(ctx, q.unAckKey, idStr).Err() if err != nil { return fmt.Errorf("remove from unack failed: %v", err) } // msg key has ttl, ignore result of delete _ = q.redisCli.Del(ctx, q.genMsgKey(idStr)).Err() q.redisCli.HDel(ctx, q.retryCountKey, idStr) return nil}否定确认只需要将 unack key 中消息的重试时间改为现在,随后执行的 unack2RetryScript 会立即将它移动到 retry key
func (q *DelayQueue) nack(idStr string) error { ctx := context.Background() // update retry time as now, unack2Retry will move it to retry immediately err := q.redisCli.ZAdd(ctx, q.unAckKey, &redis.Z{ Member: idStr, Score: float64(time.Now().Unix()), }).Err() if err != nil { return fmt.Errorf("negative ack failed: %v", err) } return nil}消息队列的核心逻辑是每秒执行一次的 consume 函数,它负责调用上述脚本将消息转移到正确的集合中并回调 consumer 来消费消息:
func (q *DelayQueue) consume() error { // 执行 pending2ready,将已到时间的消息转移到 ready err := q.pending2Ready() if err != nil { return err } // 循环调用 ready2Unack 拉取消息进行消费 var fetchCount uint for { idStr, err := q.ready2Unack() if err == redis.Nil { // consumed all break } if err != nil { return err } fetchCount++ ack, err := q.callback(idStr) if err != nil { return err } if ack { err = q.ack(idStr) } else { err = q.nack(idStr) } if err != nil { return err } if fetchCount >= q.fetchLimit { break } } // 将 nack 或超时的消息放入重试队列 err = q.unack2Retry() if err != nil { return err } // 清理已达到最大重试次数的消息 err = q.garbageCollect() if err != nil { return err } // 消费重试队列 fetchCount = for { idStr, err := q.retry2Unack() if err == redis.Nil { // consumed all break } if err != nil { return err } fetchCount++ ack, err := q.callback(idStr) if err != nil { return err } if ack { err = q.ack(idStr) } else { err = q.nack(idStr) } if err != nil { return err } if fetchCount >= q.fetchLimit { break } } return nil}折叠
至此一个简单可靠的延时队列就做好了,何不赶紧开始试用呢😘😋?
作者:finley
来源:www.cnblogs.com/Finley/p/16400287.html
版权申明:内容来源网络,仅供分享学习,版权归原创者所有。
来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/26723288/viewspace-3118086/ ,如需转载,请注明出处,否则将追究法律责任。