导航：首页 > 互联网科技 >

EMQ X Redis数据持久化怎么实现

发表于：2024-11-25 作者：千家信息网编辑

千家信息网最后更新 2024年11月25日，今天小编给大家分享一下EMQ X Redis数据持久化怎么实现的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下

千家信息网最后更新 2024年11月25日EMQ X Redis数据持久化怎么实现

今天小编给大家分享一下EMQ X Redis数据持久化怎么实现的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。

EMQ X 数据持久化简介

数据持久化的主要使用场景包括将客户端上下线状态，订阅主题信息，消息内容，消息抵达后发送消息回执等操作记录到 Redis、MySQL、PostgreSQL、MongoDB、Cassandra、AWS DynamoDB 等各类数据库中供外部服务快速查询或在服务宕机/客户端异常离线时保留当前运行状态，连接恢复时恢复到之前状态；持久化亦可用于客户端代理订阅，设备客户端上线时，持久化模块直接从数据库加载预设的主题并完成代理订阅，降低系统设计复杂度和减少客户端订阅通信开销。

用户也可以通过订阅相关主题的方式来实现类似的功能，但是在企业版中内置的这些持久化的支持执行效率更高、可靠性更强，大大降低了开发者的工作量并提升了系统稳定性。

数据持久化是 EMQ X 的重要功能，仅在企业版支持。

持久化设计

持久化原理是配置事件钩子触发时调用处理函数（action）,处理函数获取到相应的数据后按照配置的指令进行处理，实现数据的增、删、改、查。相同事件钩子在不同数据库中可用参数是一样的，但处理函数（action）因数据库特性不同有所差异。整个持久化工作模式和流程如下：

一对一消息存储

Publish 端发布一条消息；
Backend 将消息记录数据库中；
Subscribe 端订阅主题；
Backend 从数据库中获取该主题的消息；
发送消息给 Subscribe 端；
Subscribe 端确认后 Backend 从数据库中移除该消息；

一对多消息存储

PUB 端发布一条消息；
Backend 将消息记录在数据库中；
SUB1 和 SUB2 订阅主题；
Backend 从数据库中获取该主题的消息；
发送消息给 SUB1 和 SUB2；
Backend 记录 SUB1 和 SUB2 已读消息位置，下次获取消息从该位置开始。

Redis 数据持久化

本文以实际例子来说明如何通过 Redis 来存储相关的信息。

Redis 是完全开源免费遵守 BSD 协议的高性能 key-value 数据库。

相比其他 key-value 缓存产品 Redis 有以下特点：

Redis 性能极高，单机支持十万级别的读写速度。
Redis 支持数据的持久化，可以将内存中的数据保存在磁盘中，重启的时候可以再次加载进行使用。
Redis 不仅仅支持简单的 key-value 类型的数据，同时还提供 list，set，zset，hash 等数据结构的存储。
Redis 支持数据的备份，即 master-slave 模式的数据备份。

读者可以参考 Redis 官方的 Quick Start 来安装 Redis（写本文的时候，Redis 版本为5.0），通过 redis-server 命令来启动 Redis 服务器。

配置 EMQ X 服务器

通过 RPM 方式安装的 EMQ X，Redis 相关的配置文件位于 /etc/emqx/plugins/emqx_backend_redis.conf，如果只是测试 Redis 持久化的功能，大部分配置不需要做更改。唯一需要更改的地方可能是 Redis 服务器的地址：如果读者安装的 Redis 不与 EMQ X 在同一服务器上，请指定正确的 Redis 服务器的地址与端口。如下所示：

## Redis Server 127.0.0.1:6379, Redis Sentinel: 127.0.0.1:26379backend.redis.pool1.server = 127.0.0.1:6379

保持剩下部分的配置文件不变，然后启动该插件：

emqx_ctl plugins load emqx_backend_redis

客户端在线状态存储

客户端上下线时，更新在线状态、上下线时间、节点客户端列表至 Redis 数据库。

尽管 EMQ X 本身提供了设备在线状态 API，但在需要频繁获取客户端在线状态、上下线时间的场景下，直接从数据库获取该记录比调用 EMQ X API 更高效。

配置项

打开配置文件，配置 Backend 规则：

## 上线backend.redis.hook.client.connected.1    =  { "action": { "function": "on_client_connected" }, "pool": "pool1"}## 下线backend.redis.hook.client.disconnected.1 = {"action": {"function": "on_client_disconnected"}, "pool": "pool1"}

使用示例

浏览器打开 http://127.0.0.1:18083 EMQ X 管理控制台，在工具 -> Websocket 中新建一个客户端连接，指定 clientid 为 sub_client:

打开 redis-cli 命令行窗口，执行命令 keys *，结果如下所示，读者可以看到在 Redis 中存储了两个 key：

127.0.0.1:6379> keys *1) "mqtt:node:emqx@127.0.0.1"2) "mqtt:client:sub_client"

连接列表

插件以 mqtt:node:{node_name} 格式的 key 记录节点下客户端列表及连接时间戳信息，等效操作：

## redis key 为 mqtt:node:{node_name}HMSET mqtt:node:emqx@127.0.0.1 sub_client 1542272836

字段说明：

## 节点下在线设备信息127.0.0.1:6379> HGETALL mqtt:node:emqx@127.0.0.11) "sub_client1" # clientid2) "1542272836" # 上线时间时间戳3) "sub_client"4) "1542272836"

连接详细信息

插件以 mqtt:client:{client_id} 格式的 key 记录客户端在线状态、上线时间，等效操作：

## redis key 为 mqtt:client:{client_id}HMSET mqtt:client:sub_client state 1 online_at 1542272854

字段说明：

## 客户端在线状态127.0.0.1:6379> HGETALL mqtt:client:sub_client1) "state"2) "0" # 0 离线 1 在线3) "online_at"4) "1542272854" # 上线时间戳5) "offline_at"6) "undefined" # 离线时间戳

客户端代理订阅

客户端上线时，存储模块直接从数据库读取预设待订阅列表，代理加载订阅主题。在客户端需要通过预定主题通信（接收消息）场景下，应用能从数据层面设定 / 改变代理订阅列表。

配置项

打开配置文件，配置 Backend 规则：

## hook: client.connected## action/function: on_subscribe_lookupbackend.redis.hook.client.connected.2    = {"action": {"function": "on_subscribe_lookup"}, "pool": "pool1"}

使用示例

当 sub_client 设备上线时，需要为其订阅 sub_client/upstream 与 sub_client/downlink 两个 QoS 1 的主题：

插件以 mqtt:sub:{client_id} 格式 key 在 Redis 中初始化代理订阅 Hash：

## redis key 为 mqtt:sub:{client_id}## HSET key {topic} {qos}127.0.0.1:6379> HSET mqtt:sub:sub_client sub_client/upstream 1(integer) 0127.0.0.1:6379> HSET mqtt:sub:sub_client sub_client/downlink 1(integer) 0

EMQ X 管理控制台 WebSocket 页面，以 clientid sub_client 新建一个客户端连接，切换至订阅页面，可见当前客户端自动订阅了 sub_client/upstream 与 sub_client/downlink 两个 QoS 1 的主题：

切换回管理控制台 WebSocket 页面，向 sub_client/downlink 主题发布消息，可在消息订阅列表收到发布的消息。

持久化发布消息

配置项

打开配置文件，配置 Backend 规则，支持使用 topic 参数进行消息过滤，此处使用 # 通配符存储任意主题消息：

## hook: message.publish## action/function: on_message_publishbackend.redis.hook.message.publish.1 = {"topic": "#", "action": {"function": "on_message_publish"}, "pool": "pool1"}

使用示例

在 EMQ X 管理控制台 WebSocket 页面中，使用 clientid sub_client 建立连接，向主题 upstream_topic 发布多条消息。针对每条消息， EMQ X 将持久化消息列表、消息详情两条记录。

消息列表

EMQ X 将消息列表以 message id 持久化至 mqtt:msg:{topic} Redis 集合中：

## 获取 upstream_topic 主题集合中所有 message id127.0.0.1:6379> ZRANGE mqtt:msg:upstream_topic 0 -11) "2VFsyhDm0cPIQvnY9osj"2) "2VFszTClyjpVtLDLrn1u"3) "2VFszozkwkYOcbEy8QN9"4) "2VFszpEc7DfbEqC97I3g"5) "2VFszpSzRviADmcOeuXd"6) "2VFszpm3kvvLkJTcdmGU"7) "2VFt0kuNrOktefX6m4nP"127.0.0.1:6379>

消息详情

每条消息详情将以 mqtt:msg:{message_id} 格式的 key 存储在 Redis Hash 中：

## 获取 message id 为 2VFt0kuNrOktefX6m4nP 的消息详情127.0.0.1:6379> HGETALL mqtt:msg:2VFt0kuNrOktefX6m4nP 1) "id" 2) "2VFt0kuNrOktefX6m4nP" ## message id 3) "from" 4) "sub_client" ## client id 5) "qos" 6) "2" 7) "topic" 8) "up/upstream_topic" 9) "payload"10) "{ "cmd": "reboot" }"11) "ts"12) "1542338754" ## pub 时间戳13) "retain"14) "false"

获取离线消息

配置项

打开配置文件，配置 Backend 规则：

## hook: session.subscribed## action/function: on_message_fetch_for_queue、on_message_fetch_for_pubsub## 一对一离线消息backend.redis.hook.session.subscribed.1  = {"topic": "queue/#", "action": {"function": "on_message_fetch_for_queue"}, "pool": "pool1"}## 一对多离线消息backend.redis.hook.session.subscribed.2  = {"topic": "pubsub/#", "action": {"function": "on_message_fetch_for_pubsub"}, "pool": "pool1"}

使用示例

MQTT 离线消息需满足以下条件：

以 clean_session = false 连接
订阅 QoS > 0
发布 QoS > 0

在 EMQ X 管理控制台中以如下配置建立连接，

持久化 Retain 消息

配置项

打开配置文件，配置 Backend 规则：

## hook: message.publish## action/function: on_client_connected、on_message_retainbackend.redis.hook.message.publish.2     = {"topic": "#", "action": {"function": "on_message_retain"}, "pool": "pool1"}backend.redis.hook.message.publish.3     = {"topic": "#", "action": {"function": "on_retain_delete"}, "pool": "pool1"}

消息列表

EMQ X 将消息列表以 message id 持久化至 mqtt:retain:{topic} Redis Hash 中：

## 获取 upstream_topic 主题集合中所有 message id127.0.0.1:6379> ZRANGE mqtt:retain:upstream_topic 0 -11) "2VFsyhDm0cPIQvnY9osj"127.0.0.1:6379>

消息详情

每条消息详情将以 mqtt:msg:{message_id} 格式的 key 存储在 Redis Hash 中：

## 获取 message id 为 2VFt0kuNrOktefX6m4nP 的消息详情127.0.0.1:6379> HGETALL mqtt:msg:2VFt0kuNrOktefX6m4nP 1) "id" 2) "2VFt0kuNrOktefX6m4nP" ## message id 3) "from" 4) "sub_client" ## client id 5) "qos" 6) "2" 7) "topic" 8) "up/upstream_topic" 9) "payload"10) "{ "cmd": "reboot" }"11) "ts"12) "1542338754" ## pub 时间戳13) "retain"14) "false"

以上就是"EMQ X Redis数据持久化怎么实现"这篇文章的所有内容，感谢各位的阅读！相信大家阅读完这篇文章都有很大的收获，小编每天都会为大家更新不同的知识，如果还想学习更多的知识，请关注行业资讯频道。

很赞哦！