用 Redis 做一个可靠的延迟队列

程序员的成长之路

互联网/程序员/技术/资料共享 

来自：cnblogs.com/Finley/p/16400287.html

• 当订单一直处于未支付状态时，如何及时的关闭订单，并退还库存？
• 新创建店铺，N天内没有上传商品，系统如何知道该信息，并发送激活短信？

• 持久化: 服务重启或崩溃不能丢失任务
• 确认重试机制: 任务处理失败或超时应该有重试
• 定时尽量精确

• 提供 ACK 和重试机制
• 只需要 Redis 和消费者即可运行，无需其它组件
• 提供 At-Least-One 投递语义、并保证消息不会并发消费

https://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 := 0; i < 10; i++ {
  err := queue.SendDelayMsg(strconv.Itoa(i), time.Hour, delayqueue.WithRetryCount(3))
  if err != nil {
   panic(err)
  }
 }

 // 启动消费协程
 done := queue.StartConsume()
 // 阻塞等待消费协程退出
 <-done
}

原理详解

• msgKey: 为了避免两条内容完全相同的消息造成意外的影响，我们将每条消息放到一个字符串类型的键中，并分配一个 UUID 作为它的唯一标识。其它数据结构中只存储 UUID 而不存储完整的消息内容。每个 msg 拥有一个独立的 key 而不是将所有消息放到一个哈希表是为了利用 TTL 机制避免
• pendingKey: 有序集合类型，member 为消息 ID, score 为投递时间的 unix 时间戳。
• readyKey: 列表类型，需要投递的消息 ID。
• unAckKey: 有序集合类型，member 为消息 ID, score 为重试时间的 unix 时间戳。
• retryKey: 列表类型，已到重试时间的消息 ID
• garbageKey: 集合类型，用于暂存已达重试上线的消息 ID
• retryCountKey: 哈希表类型，键为消息 ID, 值为剩余的重试次数

• 都是原子性的
• 不会重复处理同一条消息
• 操作前后消息队列始终处于正确的状态

pending2ReadyScript

-- keys: pendingKey, readyKey
-- argv: currentTime
local msgs = redis.call('ZRangeByScore', KEYS[1], '0', ARGV[1])  -- 从 pending key 中找出已到投递时间的消息
if (#msgs == 0) then return end
local args2 = {'LPush', KEYS[2]} -- 将他们放入 ready key 中
for _,v in ipairs(msgs) do
 table.insert(args2, v) 
end
redis.call(unpack(args2))
redis.call('ZRemRangeByScore', KEYS[1], '0', ARGV[1])  -- 从 pending key 中删除已投递的消息

ready2UnackScript

-- keys: readyKey/retryKey, unackKey
-- argv: retryTime
local msg = redis.call('RPop', KEYS[1])
if (not msg) then return end
redis.call('ZAdd', KEYS[2], ARGV[1], msg)
return msg

unack2RetryScript

-- keys: unackKey, retryCountKey, retryKey, garbageKey
-- argv: currentTime
local msgs = redis.call('ZRangeByScore', KEYS[1], '0', ARGV[1])  -- 找到已到重试时间的消息
if (#msgs == 0) then return end
local retryCounts = redis.call('HMGet', KEYS[2], unpack(msgs)) -- 查询剩余重试次数
for i,v in ipairs(retryCounts) do
 local k = msgs[i]
 if tonumber(v) > 0 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) -- 添加到垃圾桶，等待后续删除
 end
end
redis.call('ZRemRangeByScore', KEYS[1], '0', ARGV[1])  -- 将已处理的消息从 unack key 中删除

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) == 0 {
  return nil
 }
 // allow concurrent clean
 msgKeys := make([]string, 0, 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
}

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
}

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

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 = 0
 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
}

推荐阅读：

知乎：不到 20 人的 IT 公司该去吗？

替代ELK：ClickHouse+Kafka+FlieBeat

互联网初中高级大厂面试题(9个G)
内容包含Java基础、JavaWeb、MySQL性能优化、JVM、锁、百万并发、消息队列、高性能缓存、反射、Spring全家桶原理、微服务、Zookeeper......等技术栈！
⬇戳阅读原文领取！                                  朕已阅