消息队列（Redis）

[`yudao-spring-boot-starter-mq` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-framework/yudao-spring-boot-starter-mq/)技术组件，基于 Redis 实现分布式消息队列：

* 使用 [Stream **(opens new window)**](http://www.redis.cn/topics/streams-intro.html) 特性，提供【集群】消费的能力。
* 使用 [Pub/Sub **(opens new window)**](http://www.redis.cn/topics/pubsub.html) 特性，提供【广播】消费的能力。

疑问：什么是【广播】消费？什么是【集群】消费？

参见[《阿里云 —— 集群消费和广播消费 》 **(opens new window)**](https://help.aliyun.com/zh/apsaramq-for-rocketmq/cloud-message-queue-rocketmq-4-x-series/developer-reference/clustering-consumption-and-broadcasting-consumption)文档

## [#](https://doc.iocoder.cn/message-queue/redis/#_1-%E9%9B%86%E7%BE%A4%E6%B6%88%E8%B4%B9)1. 集群消费

集群消费，是指消息发送到 Redis 时，有且只会被一个消费者（应用 JVM 实例）收到，然后消费成功。如下图所示：

![集群消费](/media/202404/2024-04-25_2046570.7477270566716935.png)

友情提示：

如果你需要使用到【集群】消费，必须使用 Redis 5.0.0 以上版本，因为 Stream 特性是在该版本之后才引入噢！

### [#](https://doc.iocoder.cn/message-queue/redis/#_1-1-%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF)1.1 使用场景

集群消费在项目中的使用场景，主要是提供可靠的、可堆积的异步任务的能力。例如说：

* 短信模块，使用它[异步 **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/mq/consumer/sms/SmsSendConsumer.java)发送短信。
* 邮件模块，使用它[异步 **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/mq/consumer/mail/MailSendConsumer.java)发送邮件。

相比 [《开发指南 —— 异步任务》](https://doc.iocoder.cn/async-task) 来说，Spring Async 在 JVM 实例重启时，会导致未执行完的任务丢失。而集群消费，因为消息是存储在 Redis 中，所以不会存在该问题。

### [#](https://doc.iocoder.cn/message-queue/redis/#_1-2-%E5%AE%9E%E7%8E%B0%E6%BA%90%E7%A0%81)1.2 实现源码

集群消费基于 Redis Stream 实现：

* 实现 AbstractRedisStreamMessage 抽象类，定义【集群】消息。
* 使用 RedisMQTemplate 的 `#send(message)` 方法，发送消息。
* 实现 AbstractRedisStreamMessageListener 接口，消费消息。

最终使用 YudaoRedisMQAutoConfiguration 配置类，扫描所有的 AbstractRedisStreamMessageListener 监听器，初始化对应的消费者。如下图所示：

![YudaoRedisMQAutoConfiguration](/media/202404/2024-04-25_2046570.03227830718436775.png)

### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-%E5%AE%9E%E6%88%98%E6%A1%88%E4%BE%8B)1.3 实战案例

以【短信发送】举例子，改造使用 Redis 作为消息队列，同时也是讲解集群消费的使用。如下图所示：

![实战案例](/media/202404/2024-04-25_2046570.8178878884755947.png)

#### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-0-%E5%BC%95%E5%85%A5%E4%BE%9D%E8%B5%96)1.3.0 引入依赖

在 `yudao-module-system-biz` 模块中，引入 `yudao-spring-boot-starter-mq` 技术组件。如下所示：

```xml
<dependency>
    <groupId>cn.iocoder.boot</groupId>
    <artifactId>yudao-spring-boot-starter-mq</artifactId>
</dependency>
```

#### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-1-message-%E6%B6%88%E6%81%AF)1.3.1 Message 消息

在 `message` 包下，修改 SmsSendMessage 类，短信发送消息。代码如下：

```java
@Data
public class SmsSendMessage extends AbstractRedisStreamMessage { // 重点：需要继承 AbstractRedisStreamMessage 类

/**
     * 短信日志编号
     */
    @NotNull(message = "短信日志编号不能为空")
    private Long logId;
    /**
     * 手机号
     */
    @NotNull(message = "手机号不能为空")
    private String mobile;
    /**
     * 短信渠道编号
     */
    @NotNull(message = "短信渠道编号不能为空")
    private Long channelId;
    /**
     * 短信 API 的模板编号
     */
    @NotNull(message = "短信 API 的模板编号不能为空")
    private String apiTemplateId;
    /**
     * 短信模板参数
     */
    private List<KeyValue<String, Object>> templateParams;

}
```

#### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-2-smsproducer-%E7%94%9F%E4%BA%A7%E8%80%85)1.3.2 SmsProducer 生产者

在 `producer` 包下，修改 SmsProducer 类，Sms 短信相关消息的生产者。代码如下：

```java
@Slf4j
@Component
public class SmsProducer {

@Resource
    private RedisMQTemplate redisMQTemplate; // 重点：注入 RedisMQTemplate 对象

/**
     * 发送 {@link SmsSendMessage} 消息
     *
     * @param logId 短信日志编号
     * @param mobile 手机号
     * @param channelId 渠道编号
     * @param apiTemplateId 短信模板编号
     * @param templateParams 短信模板参数
     */
    public void sendSmsSendMessage(Long logId, String mobile,
                                   Long channelId, String apiTemplateId, List<KeyValue<String, Object>> templateParams) {
        SmsSendMessage message = new SmsSendMessage().setLogId(logId).setMobile(mobile);
        message.setChannelId(channelId).setApiTemplateId(apiTemplateId).setTemplateParams(templateParams);
        redisMQTemplate.send(message); // 重点：使用 RedisMQTemplate 发送消息
    }

}
```

#### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-3-smssendconsumer-%E6%B6%88%E8%B4%B9%E8%80%85)1.3.3 SmsSendConsumer 消费者

在 `consumer` 包下，修改 SmsSendConsumer 类，SmsSendMessage 的消费者。代码如下：

```java
@Component
@Slf4j
public class SmsSendConsumer extends AbstractRedisStreamMessageListener<SmsSendMessage> { // 重点：继承 AbstractRedisStreamMessageListener 类，并填写对应的 Message 类

@Resource
    private SmsSendService smsSendService;

@Override // 重点：实现 onMessage 方法
    public void onMessage(SmsSendMessage message) {
        log.info("[onMessage][消息内容({})]", message);
        smsSendService.doSendSms(message);
    }

}
```

#### [#](https://doc.iocoder.cn/message-queue/redis/#_1-3-4-%E7%AE%80%E5%8D%95%E6%B5%8B%E8%AF%95)1.3.4 简单测试

① Debug 启动后端项目，可以在 SmsProducer 和 SmsSendConsumer 上面打上断点，稍微调试下。

② 打开 `SmsTemplateController.http` 文件，使用 IDEA httpclient 发起请求，发送短信。如下图所示：

![简单测试](/media/202404/2024-04-25_2046570.5871815472768507.png)

如果 IDEA 控制台看到 `[onMessage][消息内容 ` 日志内容，说明消息的发送和消费成功。

## [#](https://doc.iocoder.cn/message-queue/redis/#_2-%E5%B9%BF%E6%92%AD%E6%B6%88%E8%B4%B9)2. 广播消费

广播消费，是指消息发送到 Redis 时，所有消费者（应用 JVM 实例）收到，然后消费成功。如下图所示：

![集群消费](/media/202404/2024-04-25_2046570.6981362483375186.png)

### [#](https://doc.iocoder.cn/message-queue/redis/#_2-1-%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF)2.1 使用场景

例如说，在应用中，缓存了数据字典等配置表在内存中，可以通过 Redis 广播消费，实现每个应用节点都消费消息，刷新本地内存的缓存。

又例如说，我们基于 WebSocket 实现了 IM 聊天，在我们给用户主动发送消息时，因为我们不知道用户连接的是哪个提供 WebSocket 的应用，所以可以通过 Redis 广播消费。每个应用判断当前用户是否是和自己提供的 WebSocket 服务连接，如果是，则推送消息给用户。

### [#](https://doc.iocoder.cn/message-queue/redis/#_2-2-%E5%AE%9E%E7%8E%B0%E6%BA%90%E7%A0%81)2.2 实现源码

广播消费基于 Redis Pub/Sub 实现：

* 实现 AbstractChannelMessage 抽象类，定义【广播】消息。
* 使用 RedisMQTemplate 的 `#send(message)` 方法，发送消息。
* 实现 AbstractRedisChannelMessageListener 接口，消费消息。

最终使用 YudaoRedisMQAutoConfiguration 配置类，扫描所有的 AbstractRedisChannelMessageListener 监听器，初始化对应的消费者。如下图所示：

![YudaoRedisMQAutoConfiguration](/media/202404/2024-04-25_2046570.4504617501114786.png)

### [#](https://doc.iocoder.cn/message-queue/redis/#_2-3-%E5%AE%9E%E6%88%98%E6%A1%88%E4%BE%8B)2.3 实战案例

参见 [《开发指南 —— 本地缓存》](https://doc.iocoder.cn/local-cache)