Redis队列与Stream

Redis5.0 最大的新特性就是多出了一个数据结构 Stream，它是一个新的强大的支持多播的可持久化的消息队列，作者声明Redis Stream地借鉴了 Kafka 的设计。

Stream总述

Redis Stream 的结构如上图所示,每一个Stream都有一个消息链表，将所有加入的消息都串起来，每个消息都有一个唯一的 ID 和对应的内容。==消息是持久化的，Redis 重启后，内容还在。 ==

==每个 Stream 都有唯一的名称，它就是 Redis 的 key，在我们首次使用xadd指令追加消息时自动创建。 ==

每个 Stream 都可以挂多个消费组，每个消费组会有个游标last_delivered_id在 Stream 数组之上往前移动，表示当前消费组已经消费到哪条消息了。每个消费组都有一个 Stream 内唯一的名称，消费组不会自动创建，它需要单独的指令xgroup create进行创建，需要指定从 Stream 的某个消息 ID 开始消费，这个 ID 用来初始化last_delivered_id变量。

每个消费组 (Consumer Group) 的状态都是独立的，相互不受影响。也就是说同一份 Stream 内部的消息会被每个消费组都消费到。

同一个消费组 (Consumer Group) 可以挂接多个消费者 (Consumer)，这些消费者之间是竞争关系，任意一个消费者读取了消息都会使游标last_delivered_id往前移动。每个消费者有一个组内唯一名称。

消费者 (Consumer) 内部会有个状态变量pending_ids，它记录了当前已经被客户端读取,但是还没有 ack的消息。如果客户端没有 ack，这个变量里面的消息 ID 会越来越多，一旦某个消息被 ack，它就开始减少。这个 pending_ids 变量在 Redis 官方被称之为PEL，也就是Pending Entries List，这是一个很核心的数据结构，它用来确保客户端至少消费了消息一次，而不会在网络传输的中途丢失了没处理。

消息 ID 的形式是timestampInMillis-sequence，例如1527846880572-5，它表示当前的消息在毫米时间戳1527846880572时产生，并且是该毫秒内产生的第 5 条消息。消息 ID 可以由服务器自动生成，也可以由客户端自己指定，但是形式必须是整数-整数，而且必须是后面加入的消息的 ID 要大于前面的消息 ID。
消息内容就是键值对，形如 hash 结构的键值对，这没什么特别之处。

常用操作命令

生产端

xadd 追加消息
xdel 删除消息，这里的删除仅仅是设置了标志位，不会实际删除消息。
xrange 获取消息列表，会自动过滤已经删除的消息
xlen 消息长度
del 删除 Stream

xadd streamtest * name mark age 18

streamtest 表示当前这个队列的名字，也就是我们一般意义上Redis中的key，* 号表示服务器自动生成 ID，后面顺序跟着==“name mark age 18”，是我们存入当前streamtest 这个队列的消息，采用的也是 key/value的存储形式==

返回值1626705954593-0 则是生成的消息 ID，由两部分组成：时间戳-序号。时间戳时毫秒级单位，是生成消息的Redis服务器时间，它是个64位整型。序号是在这个毫秒时间点内的消息序号。它也是个64位整型。

为了保证消息是有序的，因此Redis生成的ID是单调递增有序的。由于ID中包含时间戳部分，为了避免服务器时间错误而带来的问题（例如服务器时间延后了），Redis的每个Stream类型数据都维护一个latest_generated_id属性，用于记录最后一个消息的ID。若发现当前时间戳退后（小于latest_generated_id所记录的），则采用时间戳不变而序号递增的方案来作为新消息ID（这也是序号为什么使用int64的原因，保证有足够多的的序号），从而保证ID的单调递增性质。
如果不是非常特别的需求，强烈建议使用Redis的方案生成消息ID，因为这种时间戳+序号的单调递增的ID方案，几乎可以满足全部的需求，但ID是支持自定义的。

xrange streamtest - +
其中-表示最小值 , + 表示最大值

或者我们可以指定消息 ID 的列表：

xdel streamtest 1626706380924-0
xlen streamtest

del streamtest 删除整个 Stream

消费端

单消费者

虽然Stream中有消费者组的概念，但是可以在不定义消费组的情况下进行 Stream 消息的独立消费，当 Stream 没有新消息时，甚至可以阻塞等待。Redis 设计了一个单独的消费指令xread，可以将 Stream 当成普通的消息队列 (list) 来使用。使用 xread 时，我们可以完全忽略消费组 (Consumer Group) 的存在，就好比 Stream 就是一个普通的列表 (list)

xread count 1 streams stream2 0-0
“count 1”表示从 Stream 读取1条消息，缺省当然是头部，“streams”可以理解为Redis关键字，“stream2”指明了要读取的队列名称，“0-0”指从头开始

xread count 2 streams stream2 1626710882927-0
也可以指定从streams的消息Id开始(不包括命令中的消息id)

xread count 1 streams stream2 $
$代表从尾部读取，上面的意思就是从尾部读取最新的一条消息,此时默认不返回任何消息

所以最好以阻塞的方式读取尾部最新的一条消息，直到新的消息的到来
xread block 0 count 1 streams stream2 $
block后面的数字代表阻塞时间，单位毫秒

此时我们新开一个客户端，往stream2中写入一条消息

可以看到阻塞解除了，返回了新的消息内容，而且还显示了一个等待时间，这里我们等待了127.87s

一般来说客户端如果想要使用 xread 进行顺序消费，一定要记住当前消费到哪里了，也就是返回的消息 ID。下次继续调用 xread 时，将上次返回的最后一个消息 ID 作为参数传递进去，就可以继续消费后续的消息。

消费组

创建消费组
Stream 通过xgroup create指令创建消费组 (Consumer Group)，需要传递起始消息 ID 参数用来初始化last_delivered_id变量。
xgroup create stream2 cg1 0-0
“stream2”指明了要读取的队列名称，“cg1”表示消费组的名称，“0-0”表示从头开始消费

xgroup create stream2 cg2 $
$ 表示从尾部开始消费，只接受新消息，当前 Stream 消息会全部忽略

现在我们可以用xinfo命令来看看stream2的情况：
xinfo stream stream2

xinfo groups stream2

消息消费

有了消费组，自然还需要消费者，Stream 提供了 xreadgroup 指令可以进行消费组的组内消费，需要提供消费组名称、消费者名称和起始消息 ID。
它同 xread 一样，也可以阻塞等待新消息。读到新消息后，对应的消息 ID 就会进入消费者的PEL(正在处理的消息) 结构里，客户端处理完毕后使用 xack 指令通知服务器，本条消息已经处理完毕，该消息 ID 就会从 PEL 中移除。
xreadgroup GROUP cg1 c1 count 1 streams stream2 >
“GROUP”属于关键字，“cg1”是消费组名称，“c1”是消费者名称，“count 1”指明了消费数量，> 号表示从当前消费组的 last_delivered_id 后面开始读，每当消费者读取一条消息，last_delivered_id 变量就会前进

前面我们定义cg1的时候是从头开始消费的，自然就获得Stream2中第一条消息
再执行一次上面的命令

自然就读取到了下条消息。
我们将Stream2中的消息读取完
xreadgroup GROUP cg1 c1 count 2 streams stream2 >
很自然就没有消息可读了， xreadgroup GROUP cg1 c1 count 1 streams stream2 >

然后设置阻塞等待
xreadgroup GROUP cg1 c1 block 0 count 1 streams stream2 >

我们新开一个客户端，发送消息到stream2
xadd stream2 * name lison score 98

回到原来的客户端，发现阻塞解除，收到新消息

我们来观察一下观察消费组状态

如果同一个消费组有多个消费者，我们还可以通过 xinfo consumers 指令观察每个消费者的状态
xinfo consumers stream2 cg1

可以看到目前c1这个消费者有 5 条待ACK的消息，空闲了441340 ms 没有读取消息。
如果我们确认一条消息
xack stream2 cg1 1626751586744-0
就可以看到待确认消息变成了4条

xack允许带多个消息id，比如

同时Stream还提供了命令XPENDIING 用来获消费组或消费内消费者的未处理完毕的消息，每个Pending的消息有4个属性：
消息ID
所属消费者
IDLE，已读取时长
delivery counter，消息被读取次数
命令XCLAIM用以进行消息转移的操作，将某个消息转移到自己的Pending列表中。需要设置组、转移的目标消费者和消息ID，同时需要提供IDLE（已被读取时长），只有超过这个时长，才能被转移。
更多的Redis的Stream命令请大家参考Redis官方文档：
https://redis.io/topics/streams-intro
https://redis.io/commands
同时Redis文档中，在每个命令的详情页右边会显示“Related commands”，可以通过这个列表快速了解相关的命令和进入具体命令的详情页。

Redis队列几种实现的总结

基于List的 LPUSH+BRPOP 的实现

足够简单，消费消息延迟几乎为零，但是需要处理空闲连接的问题。
如果线程一直阻塞在那里，Redis客户端的连接就成了闲置连接，闲置过久，服务器一般会主动断开连接，减少闲置资源占用，这个时候blpop和brpop或抛出异常，所以在编写客户端消费者的时候要小心，如果捕获到异常需要重试。
其他缺点包括：
做消费者确认ACK麻烦，不能保证消费者消费消息后是否成功处理的问题（宕机或处理异常等），通常需要维护一个Pending列表，保证消息处理确认；不能做广播模式，如pub/sub，消息发布/订阅模型；不能重复消费，一旦消费就会被删除；不支持分组消费。

@Component
public class ListVer{public final static String RS_LIST_MQ_NS = "rlm:";@Autowiredprivate JedisPool jedisPool;/*消费者接受消息*/public List<String> get(String key) {Jedis jedis = null;try {jedis = jedisPool.getResource();return jedis.brpop(0,RS_LIST_MQ_NS +key);} catch (Exception e) {throw new RuntimeException("接受消息失败！");} finally {jedis.close();}}/*生产者发送消息*/public void put(String key, String message) {Jedis jedis = null;try {jedis = jedisPool.getResource();jedis.lpush(RS_LIST_MQ_NS+key,message);} catch (Exception e) {throw new RuntimeException("发送消息失败！");} finally {jedis.close();}}
}

基于Sorted-Set的实现

多用来实现延迟队列，当然也可以实现有序的普通的消息队列，但是消费者无法阻塞的获取消息，只能轮询，不允许重复消息。

@Component
public class ZSetVer {public final static String RS_ZS_MQ_NS = "rzsm:";@Autowiredprivate JedisPool jedisPool;/*生产者，消息的发送，实际生产中，相关参数，比如订单信息，过期时间等应该传入，可以考虑将订单信息json化存入redis*/public void producer() {Jedis jedis = null;try {jedis = jedisPool.getResource();for (int i = 0; i < 5; i++) {String order_id = "000000000"+i;double score = System.currentTimeMillis()+(i*1000);jedis.zadd(RS_ZS_MQ_NS+"orderId",score, order_id);System.out.println("生产订单: " + order_id + " 当前时间："+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));System.out.println((3 + i) + "秒后执行");}} catch (Exception e) {throw new RuntimeException("生产消息失败！");} finally {jedis.close();}}//消费者，取订单public void consumerDelayMessage() {Jedis jedis = null;try {jedis = jedisPool.getResource();while (true) {Set<String> order = jedis.zrangeByScore(RS_ZS_MQ_NS+"orderId", 0,System.currentTimeMillis(), 0,1);if (order == null || order.isEmpty()) {System.out.println("当前没有等待的任务");try {TimeUnit.MICROSECONDS.sleep(1000);} catch (InterruptedException e) {e.printStackTrace();}continue;}String s = order.iterator().next();if (jedis.zrem(RS_ZS_MQ_NS+"orderId", s)>0) {/*业务处理*/System.out.println(s);}}} catch (Exception e) {throw new RuntimeException("消费消息失败！");} finally {jedis.close();}}

PUB/SUB，订阅/发布模式

优点：
典型的广播模式，一个消息可以发布到多个消费者；多信道订阅，消费者可以同时订阅多个信道，从而接收多类消息；消息即时发送，消息不用等待消费者读取，消费者会自动接收到信道发布的消息。
缺点：
消息一旦发布，不能接收。换句话就是发布时若客户端不在线，则消息丢失，不能寻回；不能保证每个消费者接收的时间是一致的；若消费者客户端出现消息积压，到一定程度，会被强制断开，导致消息意外丢失。通常发生在消息的生产远大于消费速度时；可见，Pub/Sub 模式不适合做消息存储，消息积压类的业务，而是擅长处理广播，即时通讯，即时反馈的业务。

@Component
public class PSVer extends JedisPubSub {public final static String RS_PS_MQ_NS = "rpsm:";@Autowiredprivate JedisPool jedisPool;@Overridepublic void onMessage(String channel, String message) {System.out.println("Accept "+channel+" message:"+message);}@Overridepublic void onSubscribe(String channel, int subscribedChannels) {System.out.println("Subscribe "+channel+" count:"+subscribedChannels);}public void pub(String channel, String message) {Jedis jedis = null;try {jedis = jedisPool.getResource();jedis.publish(RS_PS_MQ_NS+channel,message);System.out.println("发布消息到"+RS_PS_MQ_NS+channel+" message="+message);} catch (Exception e) {throw new RuntimeException("发布消息失败！");} finally {jedis.close();}}public void sub(String... channels) {Jedis jedis = null;try {jedis = jedisPool.getResource();jedis.subscribe(this,channels);} catch (Exception e) {throw new RuntimeException("订阅频道失败！");} finally {jedis.close();}}}

基于Stream类型的实现

基本上已经有了一个消息中间件的雏形，可以考虑在生产过程中使用，当然真正要在生产中应用，要做的事情还很多，比如消息队列的管理和监控就需要花大力气去实现，而专业消息队列都已经自带或者存在着很好的第三方方案和插件。

@Component
public class StreamVer {public final static String RS_STREAM_MQ_NS = "rsm:";@Autowiredprivate JedisPool jedisPool;/*** 发布消息到Stream* @param key* @param message* @return*/public StreamEntryID produce(String key,Map<String,String> message){Jedis jedis = null;try {jedis = jedisPool.getResource();StreamEntryID id = jedis.xadd(RS_STREAM_MQ_NS+key, StreamEntryID.NEW_ENTRY, message);System.out.println("发布消息到"+RS_STREAM_MQ_NS+key+" 返回消息id="+id.toString());return id;} catch (Exception e) {throw new RuntimeException("发布消息失败！");} finally {jedis.close();}}/*** 创建消费群组,消费群组不可重复创建* @param key* @param groupName* @param lastDeliveredId*/public void createCustomGroup(String key, String groupName, String lastDeliveredId){Jedis jedis = null;try {StreamEntryID id = null;if (lastDeliveredId==null){lastDeliveredId = "0-0";}id = new StreamEntryID(lastDeliveredId);jedis = jedisPool.getResource();/*makeStream表示没有时是否自动创建stream，但是如果有，再自动创建会异常*/jedis.xgroupCreate(RS_STREAM_MQ_NS+key,groupName,id,false);System.out.println("创建消费群组成功："+groupName);} catch (Exception e) {throw new RuntimeException("创建消费群组失败！",e);} finally {jedis.close();}}/*** 消息消费* @param key* @param customerName* @param groupName* @return*/public List<Map.Entry<String, List<StreamEntry>>> consume(String key, String customerName,String groupName){Jedis jedis = null;try {jedis = jedisPool.getResource();/*消息消费时的参数*/XReadGroupParams xReadGroupParams = new XReadGroupParams().block(0).count(1);Map<String, StreamEntryID> streams = new HashMap<>();streams.put(RS_STREAM_MQ_NS+key,StreamEntryID.UNRECEIVED_ENTRY);List<Map.Entry<String, List<StreamEntry>>> result= jedis.xreadGroup(groupName, customerName, xReadGroupParams, streams);System.out.println(groupName+"从"+RS_STREAM_MQ_NS+key+"接受消息, 返回消息："+result);return result;} catch (Exception e) {throw new RuntimeException("消息消费失败！",e);} finally {jedis.close();}}/*** 消息确认* @param key* @param groupName* @param msgId*/public void ackMsg(String key, String groupName,StreamEntryID msgId){if (msgId==null) throw new RuntimeException("msgId为空！");Jedis jedis = null;try {jedis = jedisPool.getResource();System.out.println(jedis.xack(key,groupName,msgId));System.out.println(RS_STREAM_MQ_NS+key+"，消费群组"+groupName+" 消息已确认");} catch (Exception e) {throw new RuntimeException("消息确认失败！",e);} finally {jedis.close();}}/*检查消费者群组是否存在，辅助方法* */public boolean checkGroup(String key, String groupName){Jedis jedis = null;try {jedis = jedisPool.getResource();List<StreamGroupInfo> xinfoGroupResult = jedis.xinfoGroup(RS_STREAM_MQ_NS+key);for(StreamGroupInfo groupinfo : xinfoGroupResult) {if(groupName.equals(groupinfo.getName())) return true;}return false;} catch (Exception e) {throw new RuntimeException("检查消费群组失败！",e);} finally {jedis.close();}}public final static int MQ_INFO_CONSUMER = 1;public final static int MQ_INFO_GROUP = 2;public final static int MQ_INFO_STREAM = 0;/*** 消息队列信息查看* @param type*/public void MqInfo(int type,String key, String groupName){Jedis jedis = null;try {jedis = jedisPool.getResource();if(type==MQ_INFO_CONSUMER){List<StreamConsumersInfo> xinfoConsumersResult = jedis.xinfoConsumers(RS_STREAM_MQ_NS+key, groupName);System.out.println(RS_STREAM_MQ_NS+key+" 消费者信息:" + xinfoConsumersResult);for( StreamConsumersInfo consumersinfo : xinfoConsumersResult) {System.out.println("-ConsumerInfo:" + consumersinfo.getConsumerInfo());System.out.println("--Name:" + consumersinfo.getName());System.out.println("--Pending:" + consumersinfo.getPending());System.out.println("--Idle:" + consumersinfo.getIdle());}}else if (type==MQ_INFO_GROUP){List<StreamGroupInfo> xinfoGroupResult = jedis.xinfoGroup(RS_STREAM_MQ_NS+key);System.out.println(RS_STREAM_MQ_NS+key+"消费者群组信息:" + xinfoGroupResult);for(StreamGroupInfo groupinfo : xinfoGroupResult) {System.out.println("-GroupInfo:" + groupinfo.getGroupInfo());System.out.println("--Name:" + groupinfo.getName());System.out.println("--Consumers:" + groupinfo.getConsumers());System.out.println("--Pending:" + groupinfo.getPending());System.out.println("--LastDeliveredId:" + groupinfo.getLastDeliveredId());}}else{StreamInfo xinfoStreamResult = jedis.xinfoStream(RS_STREAM_MQ_NS+key);System.out.println(RS_STREAM_MQ_NS+key+"队列信息:" + xinfoStreamResult);System.out.println("-StreamInfo:" + xinfoStreamResult.getStreamInfo());System.out.println("--Length:" + xinfoStreamResult.getLength());System.out.println("--RadixTreeKeys:" + xinfoStreamResult.getRadixTreeKeys());System.out.println("--RadixTreeNodes():" + xinfoStreamResult.getRadixTreeNodes());System.out.println("--Groups:" + xinfoStreamResult.getGroups());System.out.println("--LastGeneratedId:" + xinfoStreamResult.getLastGeneratedId());System.out.println("--FirstEntry:" + xinfoStreamResult.getFirstEntry());System.out.println("--LastEntry:" + xinfoStreamResult.getLastEntry());}} catch (Exception e) {throw new RuntimeException("消息队列信息检索失败！",e);} finally {jedis.close();}}}

与Java的集成

可以参见cn.tuling.redis.redismq.StreamVer

消息队列问题

从我们上面对Stream的使用表明，Stream已经具备了一个消息队列的基本要素，生产者API、消费者API，消息Broker，消息的确认机制等等，所以在使用消息中间件中产生的问题，这里一样也会遇到。

Stream 消息太多怎么办?（会限制长度 干掉老信息）

要是消息积累太多，Stream 的链表岂不是很长，内容会不会爆掉?xdel 指令又不会删除消息，它只是给消息做了个标志位。
Redis 自然考虑到了这一点，所以它提供了一个定长 Stream 功能。在 xadd 的指令提供一个定长长度 maxlen，就可以将老的消息干掉，确保最多不超过指定长度。

消息如果忘记 ACK 会怎样?（堆积在PEL中）

Stream 在每个消费者结构中保存了正在处理中的消息 ID 列表 PEL，如果消费者收到了消息处理完了但是没有回复 ack，就会导致 PEL 列表不断增长，如果有很多消费组的话，那么这个 PEL 占用的内存就会放大。所以消息要尽可能的快速消费并确认。

PEL 如何避免消息丢失?

在客户端消费者读取 Stream 消息时，Redis 服务器将消息回复给客户端的过程中，客户端突然断开了连接，消息就丢失了。但是 PEL 里已经保存了发出去的消息 ID。待客户端重新连上之后，可以再次收到 PEL 中的消息 ID 列表。不过此时 xreadgroup 的起始消息 ID 不能为参数>，而必须是任意有效的消息 ID，一般将参数设为 0-0，表示读取所有的 PEL 消息以及自last_delivered_id之后的新消息。

死信问题

如果某个消息，不能被消费者处理，也就是不能被XACK，这是要长时间处于Pending列表中，即使被反复的转移给各个消费者也是如此。此时该消息的delivery counter（通过XPENDING可以查询到）就会累加，当累加到某个我们预设的临界值时，我们就认为是坏消息（也叫死信，DeadLetter，无法投递的消息），由于有了判定条件，我们将坏消息处理掉即可，删除即可。删除一个消息，使用XDEL语法，注意，这个命令并没有删除Pending中的消息，因此查看Pending，消息还会在，可以在执行执行XDEL之后，XACK这个消息标识其处理完毕。

Stream 的高可用

Stream 的高可用是建立主从复制基础上的，它和其它数据结构的复制机制没有区别，也就是说在 Sentinel 和 Cluster 集群环境下 Stream 是可以支持高可用的。不过鉴于 Redis 的指令复制是异步的，在 failover 发生时，Redis 可能会丢失极小部分数据，这点 Redis 的其它数据结构也是一样的。
分区 Partition

分区 Partition

Redis 的服务器没有原生支持分区能力，如果想要使用分区，那就需要分配多个 Stream，然后在客户端使用一定的策略来生产消息到不同的 Stream。

Stream小结

Stream 的消费模型借鉴了 Kafka 的消费分组的概念，它弥补了 Redis Pub/Sub 不能持久化消息的缺陷。但是它又不同于 kafka，Kafka 的消息可以分 partition，而 Stream 不行。如果非要分 parition 的话，得在客户端做，提供不同的 Stream 名称，对消息进行 hash 取模来选择往哪个 Stream 里塞。
总的来说，如果是中小项目和企业，在工作中已经使用了Redis，在业务量不是很大，而又需要消息中间件功能的情况下，可以考虑使用Redis的Stream功能。但是如果并发量很高，资源足够支持下，还是以专业的消息中间件，比如RocketMQ、Kafka等来支持业务更好。