Webinar
数字社交:EMQ 与 JAGAT 探讨社交行业数据潜能 →

MQTT 保留消息是什么?如何使用?

EMQX Team
2022-10-11
MQTT 保留消息是什么?如何使用?

什么是 MQTT 保留消息?

发布者发布消息时,如果 Retained 标记被设置为 true,则该消息即是 MQTT 中的保留消息(Retained Message)。MQTT 服务器会为每个主题存储最新一条保留消息,以方便消息发布后才上线的客户端在订阅主题时仍可以接收到该消息。

如下图,当客户端订阅主题时,如果服务端存在该主题匹配的保留消息,则该保留消息将被立即发送给该客户端。

MQTT 保留消息

何时使用 MQTT 保留消息?

发布订阅模式虽然能让消息的发布者与订阅者充分解耦,但也存在一个缺点,即订阅者无法主动向发布者请求消息。订阅者何时收到消息完全依赖于发布者何时发布消息,这在某些场景中就产生了不便。

借助保留消息,新的订阅者能够立即获取最近的状态,而不需要等待无法预期的时间,例如:

  • 智能家居设备的状态只有在变更时才会上报,但是控制端需要在上线后就能获取到设备的状态;
  • 传感器上报数据的间隔太长,但是订阅者需要在订阅后立即获取到最新的数据;
  • 传感器的版本号、序列号等不会经常变更的属性,可在上线后发布一条保留消息告知后续的所有订阅者。

MQTT 保留消息的使用

若要使用 MQTT 保留消息,只需在消息发布时将 Retained 状态设置为 true 即可。接下来我们以开源的跨平台 MQTT 5.0 桌面客户端工具 - MQTTX 为例,演示如何使用 MQTT 保留消息。

打开 MQTTX 后如下所示,需点击 New Connection 按钮创建一个 MQTT 连接。

创建 MQTT 连接 1

创建页面如下,我们只需填写一个连接名称(Name),其他参数保持默认。Host 将默认为 EMQX Cloud 提供的公共 MQTT 服务器。连接参数填写完成后,点击右上角的 Connect 按钮创建 MQTT 连接。

创建 MQTT 连接 2

连接成功后将会看到连接名称旁边的状态为绿色。然后我们在右下角消息输入框向主题 sensor/t1 发送一条普通的消息。

MQTT 连接成功

接下来我们选中右下角的 Retain 标记,并向主题 sensor/t2 发送两条保留消息。

发送 MQTT 保留消息

然后点击页面中间的 New Subscription 按钮创建订阅。

订阅 MQTT 主题 1

如下,我们订阅通配符主题 sensor/+,该通配符主题将会匹配主题 sensor/t1sensor/t2

关于通配符主题的更多细节,请查看博客通过案例理解 MQTT 主题与通配符

订阅 MQTT 主题 2

最后,我们将会看到该订阅能成功收到第二条保留消息,sensor/t1 的普通消息及 sensor/t2 的第一条保留消息都未收到。可见 MQTT 服务器只会为每个主题存储最新一条保留消息。

接收 MQTT 保留消息

关于 MQTT 保留消息的 Q&A

如何判断一条消息是否是保留消息?

当客户端订阅了有保留消息的主题后,即会收到该主题的保留消息,可通过消息中的保留标志位判断是否是保留消息。需要注意的是,在保留消息发布前订阅主题,将不会收到保留消息。需要待保留消息发布后,重新订阅该主题,才会收到保留消息。

如下图,我们先订阅主题 sensor/t2,然后向该主题发布一条保留消息,该订阅会立即收到一条消息,但是该消息并不是保留消息。当我们删除该订阅,再次重新订阅 sensor/t2 主题时,立即收到了刚刚发布的保留消息。

MQTT 保留消息

保留消息将保存多久?如何删除?

服务器只会为每个主题保存最新一条保留消息,保留消息的保存时间与服务器的设置有关。若服务器设置保留消息存储在内存,则 MQTT 服务器重启后消息即会丢失;若存储在磁盘,则服务器重启后保留消息仍然存在。

保留消息虽然存储在服务端中,但它并不属于会话的一部分。也就是说,即便发布这个保留消息的会话已结束,保留消息也不会被删除。删除保留消息有以下几种方式:

  • 客户端往某个主题发送一个 Payload 为空的保留消息,服务端就会删除这个主题下的保留消息;
  • 在 MQTT 服务器上删除,比如 EMQX MQTT 服务器提供了在 Dashboard 上删除保留消息的功能;
  • MQTT 5.0 新增了消息过期间隔属性,发布时可使用该属性设置消息的过期时间,不管消息是否为保留消息,都将会在过期时间后自动被删除。

EMQX 中的 MQTT 保留消息

EMQX 是一款全球下载量超千万的大规模分布式物联网 MQTT 服务器,自 2013 年在 GitHub 发布开源版本以来,获得了来自 50 多个国家和地区的 20000 余家企业用户的广泛认可,累计连接物联网关键设备超过 1 亿台。

不久前,EMQX 发布了 5.0 版本,该版本通过一个 23 节点的集群达成了 1 亿 MQTT 连接+每秒 100 万消息吞吐,这使得 EMQX 5.0 成为目前为止全球最具扩展性的 MQTT 服务器。

EMQX 5.0 支持在内置的 Dashboard 中查看、设置保留消息。感兴趣的读者可通过如下 Docker 命令安装 EMQX 5.0 开源版进行体验。

docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:latest

EMQX 安装成功后,使用浏览器访问 http://127.0.0.1:18083/ 即可体验 EMQX 5.0 全新 Dashboard。

默认用户名为 admin,密码为 public

登录成功后,可在左侧菜单 System -> Settings 中修改显示语言为中文。如下图,可点击功能配置->MQTT 菜单查看已保留的消息列表,同时也可以查看保留消息的 Payload 或者删除某条保留消息。

查看 MQTT 保留消息

点击保留消息下的设置菜单,可看到 EMQX 支持在 Dashboard 中设置保留消息的存储类型(内存或磁盘)、最大保留消息数、保留消息有效期等参数,点击保存后所有更改将会立即生效。

设置 MQTT 保留消息

结语

本文对 MQTT 保留消息进行了介绍及使用演示,用户可以参考本文更好地利用 MQTT 保留消息解决订阅后无法立即获取最近数据的问题。除此之外,MQTT 协议还具备更多实用特性,读者可查看 EMQ 提供的 MQTT 入门与进阶系列文章进行深入了解,探索 MQTT 的更多高级应用,开启 MQTT 应用及服务开发。

免费试用 EMQX Cloud
全托管的 MQTT 消息云服务
开始试用 →

推荐阅读

2022-11-2Zibo Zhou
MQTT 持久会话与 Clean Session 详解

本文介绍了 MQTT 持久会话的作用,并通过桌面客户端演示了 Clean Session 的使用。开发者可借助持久会话实现离线消息的接收及降低订阅开销。

2020-3-31EMQX Team
EMQX MQTT 5.0 服务器的保留消息与消息过期间隔

EMQX Broker 的 MQTT 保留消息功能是由 emqx_retainer 插件实现,该插件默认开启,通过修改 emqx_retainer 插件的配置,可以调整 EMQX Broker 储存保留消息的位置,限制接收保留消息数量和 Payload 最大长度,以及调整保留消息的过期时间。