Stomp 协议网关

Stomp 网关基于 Stomp v1.2 版本实现，并兼容 Stomp v1.0 和 v1.1 的标准。

快速开始

EMQX 5.0 中，可以通过 Dashboard 配置并启用 Stomp 网关。

也可以通过 HTTP API 或 emqx.conf 来启用，例如：

curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateway/stomp' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "stomp",
  "enable": true,
  "mountpoint": "stomp/",
  "listeners": [
    {
      "type": "tcp",
      "name": "default",
      "bind": "61613",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

gateway.stomp {

  mountpoint = "stomp/"

  listeners.tcp.default {
    bind = 61613
    acceptors = 16
    max_connections = 1024000
    max_conn_rate = 1000
  }
}

TIP

通过配置文件进行配置网关，需要在每个节点中进行配置；通过 Dashboard 或者 HTTP API 管理则会在整个集群中生效。

Stomp 网关支持 TCP、SSL 类型的监听器，其完整可配置的参数列表可以参考 EMQX 开源版配置手册和 EMQX 企业版配置手册中的网关配置 - 监听器。

认证

由于 Stomp 协议的连接报文已定义了用户名和密码的概念，所以它支持以下多种认证器类型，例如：

• 内置数据库认证
• MySQL 认证
• MongoDB 认证
• PostgreSQL 认证
• Redis 认证
• HTTP Server 认证
• JWT 认证
• LDAP 认证

Stomp 网关使用 STOMP 协议的 CONNECT 或 STOMP 报文中的信息来生成客户端的认证信息。默认情况下：

• Client ID：为随机生成的字符串。
• Username：为 CONNECT 或 STOMP 报文 Headers 中的 login 字段的值。
• Password：为 CONNECT 或 STOMP 报文 Headers 中的 passcode 字段的值。

例如，通过 HTTP API 或 emqx.conf 为 Stomp 网关创建一个内置数据库认证：

curl -X 'POST' \
  'http://127.0.0.1:18083/api/v5/gateway/stomp/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "backend": "built_in_database",
  "mechanism": "password_based",
  "password_hash_algorithm": {
    "name": "sha256",
    "salt_position": "suffix"
  },
  "user_id_type": "username"
}'

gateway.stomp {

  authentication {
    backend = built_in_database
    mechanism = password_based
    password_hash_algorithm {
      name = sha256
      salt_position = suffix
    }
    user_id_type = username
  }
}

与 MQTT 协议不同，网关仅支持创建一个认证器，而不是认证器列表（或认证链）。当不启用任何认证器时，表示允许所有的 Stomp 客户端都具有接入的权限。

其他类型的认证器的配置格式参考：安全- 认证器。

发布订阅

Stomp 协议完全兼容发布订阅的消息模式，Stomp 网关使用：

• Stomp 协议的 SEND 报文作为消息发布。其主题为 SEND 报文中的 destination 字段，消息内容为 SEND 报文的消息体内容，QoS 固定为 0。
• Stomp 协议的 SUBSCRIBE 报文作为订阅请求。其主题为 SUBSCRIBE 报文中的 destination 字段，QoS 固定为 0。且支持 MQTT 协议中定义的通配符。
• Stomp 协议的 UNSUBSCRIBE 报文作为取消订阅请求。其主题为 UNSUBSCRIBE 报文中的destination 字段。

网关内无独立的发布订阅的权限控制，其对主题的权限控制需要统一在 授权（Authorization） 中管理。

用户层接口

• 详细配置说明参考：网关配置 - Stomp 网关（开源版）和网关配置 - Stomp 网关（企业版）
• 详细 HTTP API 接口参考：HTTP API - 网关（开源版）和 HTTP API - 网关（企业版）

客户端库

• erlang-stomp-client
• stomp.py