Stomp 协议网关
Stomp 网关基于 Stomp v1.2 版本实现,并兼容 Stomp v1.0 和 v1.1 的标准。
快速开始
EMQX 5.0 中,可以通过 Dashboard 配置并启用 Stomp 网关。
也可以通过 REST API 或 base.hocon 来启用,例如:
TIP
通过配置文件进行配置网关,需要在每个节点中进行配置;通过 Dashboard 或者 REST API 管理则会在整个集群中生效。
Stomp 网关支持 TCP、SSL 类型的监听器,其完整可配置的参数列表可以参考 EMQX 企业版配置手册中的网关配置 - 监听器。
限制 Stomp 事务 6.0.5+
可以使用 gateway.stomp.transaction 限制每个 Stomp 连接保留的事务状态。未配置事务限制时,EMQX 使用以下默认值:
| 配置项 | 默认值 | 说明 |
|---|---|---|
max_transactions | 100 | 单个连接可以同时打开的最大事务数。 |
max_actions_per_transaction | 1000 | 单个事务可以缓存的 SEND、ACK 和 NACK 帧的最大数量。 |
max_retained_bytes | 16777216 字节 | 单个连接中所有打开事务可以保留的总字节数上限。 |
timeout | 60s | 事务超时时间。事务到期后,EMQX 会将其丢弃。该值必须大于 0。 |
如果连接超过配置的事务数、缓存帧数或保留字节数限制,EMQX 将发送 Stomp ERROR 帧并关闭连接。
认证
由于 Stomp 协议的连接报文已定义了用户名和密码的概念,所以它支持以下多种认证器类型,例如:
Stomp 网关使用 STOMP 协议的 CONNECT 或 STOMP 报文中的信息来生成客户端的认证信息。默认情况下:
- Client ID:为随机生成的字符串。
- Username:为 CONNECT 或 STOMP 报文 Headers 中的
login字段的值。 - Password:为 CONNECT 或 STOMP 报文 Headers 中的
passcode字段的值。
例如,通过 REST API 或 base.hocon 为 Stomp 网关创建一个内置数据库认证:
与 MQTT 协议不同,网关仅支持创建一个认证器,而不是认证器列表(或认证链)。当不启用任何认证器时,表示允许所有的 Stomp 客户端都具有接入的权限。
其他类型的认证器的配置格式参考:安全- 认证器。
发布订阅
Stomp 协议完全兼容发布订阅的消息模式,Stomp 网关使用:
- Stomp 协议的 SEND 报文作为消息发布。其主题为 SEND 报文中的
destination字段,消息内容为 SEND 报文的消息体内容,QoS 固定为 0。 - Stomp 协议的 SUBSCRIBE 报文作为订阅请求。其主题为 SUBSCRIBE 报文中的
destination字段,QoS 固定为 0。且支持 MQTT 协议中定义的通配符。 - Stomp 协议的 UNSUBSCRIBE 报文作为取消订阅请求。其主题为 UNSUBSCRIBE 报文中的
destination字段。
网关内无独立的发布订阅的权限控制,其对主题的权限控制需要统一在 授权(Authorization) 中管理。
用户层接口
- 详细配置说明参考:网关配置 - Stomp 网关
- 详细 REST API 接口参考:REST API - 网关