服务器之家

服务器之家 > 正文

使用 Redis 流实现消息队列的代码

时间:2019-11-28 15:03     来源/作者:问点事

在介绍了 Redis 流的基本功能之后, 现在是时候使用这些功能来构建一些实际的应用了。 消息队列作为流的典型应用之一, 具有非常好的示范性, 因此我们将使用 Redis 流的相关功能构建一个消息队列应用, 这个消息队列跟我们之前使用其他 Redis 数据结构构建的消息队列具有相似的功能。

代码清单 10-1 展示了一个具有基本功能的消息队列实现:

  • 代码最开头的是几个转换函数, 它们负责对程序的相关输入输出进行转换和格式化;
  • MessageQueue 类用于实现消息队列, 它的添加消息、移除消息以及返回消息数量三个方法分别使用了流的 XADD 命令、 XDEL 命令和 XLEN 命令;
  • 消息队列的两个获取方法 get_message() 和 get_by_range() 分别以两种形式调用了流的 XRANGE 命令;
  • 最后, 用于迭代消息的 iterate() 方法使用了 XREAD 命令对流进行迭代。

代码清单 10-1 使用 Redis 流实现的消息队列: /stream/message_queue.py

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def reconstruct_message_list(message_list):
  """
  为了让多条消息能够以更结构化的方式返回给调用者,
  将 Redis 返回的多条消息从原来的格式:
  [(id1, {k1:v1, k2:v2, ...}), (id2, {k1:v1, k2:v2, ...}), ...]
  转换成以下格式:
  [{id1: {k1:v1, k2:v2, ...}}, {id2: {k1:v1, k2:v2, ...}}, ...]
  """  result = []
  for id, kvs in message_list:
    result.append({id: kvs})
  return result
def get_message_from_nested_list(lst):
  """
  从嵌套列表中取出消息本体。
  """
  return lst[0][1]
class MessageQueue:
  """
  使用 Redis 流实现的消息队列。
  """
  def __init__(self, client, stream_key):
    self.client = client
    self.stream = stream_key
  def add_message(self, key_value_pairs):
    """
    将给定的键值对存入到消息里面,并返回相应的消息 ID 。
    """
    return self.client.xadd(self.stream, key_value_pairs)
  def get_message(self, message_id):
    """
    根据给定的消息 ID 返回相应的消息,如果消息不存在则返回 None 。
    """
    reply = self.client.xrange(self.stream, message_id, message_id)
    if len(reply) == 1:
      return get_message_from_nested_list(reply)
 
  def remove_message(self, message_id):
    """
    根据给定的消息 ID 删除相应的消息,如果消息不存在则忽略该动作。
    """
    self.client.xdel(self.stream, message_id)
 
  def len(self):
    """
    返回消息队列的长度。
    """
    return self.client.xlen(self.stream)
 
  def get_by_range(self, start_id, end_id, max_item=10):
    """
    根据给定的 ID 区间范围返回队列中的消息。
    """
    reply = self.client.xrange(self.stream, start_id, end_id, max_item)
    return reconstruct_message_list(reply)
 
  def iterate(self, start_id=0, max_item=10):
    """
    对消息队列进行迭代,返回最多 N 条大于给定 ID 的消息。
    """
    reply = self.client.xread({self.stream: start_id}, max_item)
    if len(reply) == 0:
      return list()
    else:
      messages = get_message_from_nested_list(reply)
      return reconstruct_message_list(messages)

对于这个消息队列实现, 我们可以通过执行以下代码, 创建出它的实例:

?
1
2
3
4
>>> from redis import Redis
>>> from message_queue import MessageQueue
>>> client = Redis(decode_responses=True)
>>> mq = MessageQueue(client, "mq")

然后通过执行以下代码, 向队列里面添加十条消息:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
>>> for i in range(10):
...  key = "key{0}".format(i)
...  value = "value{0}".format(i)
...  msg = {key:value}
...  mq.add_message(msg)
...
'1554113926280-0'
'1554113926280-1'
'1554113926281-0'
'1554113926281-1'
'1554113926281-2'
'1554113926281-3'
'1554113926281-4'
'1554113926281-5'
'1554113926281-6'
'1554113926282-0'

还可以根据 ID 获取指定的消息, 又或者使用 get_by_range() 方法同时获取多条消息:

?
1
2
3
4
5
6
>>> mq.get_message('1554113926280-0')
{'key0': 'value0'}
>>> mq.get_message('1554113926280-1')
{'key1': 'value1'}
>>> mq.get_by_range("-", "+", 3)
[{'1554113926280-0': {'key0': 'value0'}}, {'1554113926280-1': {'key1': 'value1'}}, {'1554113926281-0': {'key2': 'value2'}}]

又或者使用 iterate() 方法对消息队列进行迭代, 等等:

?
1
2
3
4
>>> mq.iterate(0, 3)
[{'1554113926280-0': {'key0': 'value0'}}, {'1554113926280-1': {'key1': 'value1'}}, {'1554113926281-0': {'key2': 'value2'}}]
>>> mq.iterate('1554113926281-0', 3)
[{'1554113926281-1': {'key3': 'value3'}}, {'1554113926281-2': {'key4': 'value4'}}, {'1554113926281-3': {'key5': 'value5'}}]

总结

以上所述是小编给大家介绍的使用 Redis 流实现消息队列的代码,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对服务器之家网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

原文链接:http://blog.huangz.me/2019/redis-message-queue.html

标签:

相关文章

热门资讯

玄元剑仙肉身有什么用 玄元剑仙肉身境界等级划分
玄元剑仙肉身有什么用 玄元剑仙肉身境界等级划分 2019-06-21
男生常说24816是什么意思?女生说13579是什么意思?
男生常说24816是什么意思?女生说13579是什么意思? 2019-09-17
配置IIS网站web服务器的安全策略配置解决方案
配置IIS网站web服务器的安全策略配置解决方案 2019-05-23
Nginx服务器究竟是怎么执行PHP项目
Nginx服务器究竟是怎么执行PHP项目 2019-05-24
华为nova5pro和p30pro哪个好 华为nova5pro和华为p30pro对比详情
华为nova5pro和p30pro哪个好 华为nova5pro和华为p30pro对比详情 2019-06-22
返回顶部