EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

STOMPゲートウェイ ​

EMQX STOMPゲートウェイは、STOMPとMQTTプロトコル間の橋渡しを行うメッセージングプロトコルトランスレーターであり、これらのプロトコルを使用するクライアント同士の通信を可能にします。

このSTOMPゲートウェイは、クライアントとサーバーに対して軽量かつシンプルなメッセージングソリューションを提供し、さまざまなメッセージング環境でのメッセージ交換を実現します。TCPおよびSSLタイプのリスナーをサポートしているため、STOMPゲートウェイは柔軟で多用途なメッセージングシステム構築ツールです。

TIP

STOMPゲートウェイはStomp v1.2をベースにしており、STOMP v1.0およびv1.1仕様と互換性があります。

STOMPゲートウェイの有効化 ​

EMQX 5では、STOMPゲートウェイはダッシュボード、REST API、および設定ファイル base.hocon を通じて設定および有効化できます。本節では、ダッシュボードを用いた設定手順を例に説明します。

EMQXダッシュボードの左側ナビゲーションメニューで Management -> Gateways をクリックします。Gateways ページにはサポートされているすべてのゲートウェイが一覧表示されます。STOMP を見つけ、Actions 列の Setup をクリックすると、Initialize STOMP ページに遷移します。

TIP

EMQXをクラスターで運用している場合、ダッシュボードやREST APIを通じて行った設定はクラスター全体に影響します。特定のノードのみ設定を変更したい場合は、base.hoconで設定してください。

設定を簡略化するために、EMQXはGatewaysページのすべての必須フィールドにデフォルト値を用意しています。大幅なカスタマイズが不要な場合は、STOMPゲートウェイをわずか3クリックで有効化できます。

  1. Basic Configuration タブで Next をクリックし、すべてのデフォルト設定を受け入れます。
  2. 次に Listeners タブに遷移し、EMQXはポート 61613 にUDPリスナーを事前設定しています。ここでも Next をクリックして設定を確定します。
  3. 最後に Enable ボタンをクリックしてSTOMPゲートウェイを有効化します。

ゲートウェイの有効化が完了すると、Gateways ページに戻り、STOMPゲートウェイのステータスが Enabled と表示されていることを確認できます。

STOMPゲートウェイが有効化された状態

EMQX 5.0では、STOMPゲートウェイはダッシュボードを通じて設定および有効化できます。

上記の設定はREST APIでも行えます。

例:

bash
curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateways/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
    }
  ]
}'

STOMPクライアントとの連携 ​

クライアントライブラリ ​

STOMPゲートウェイを構築した後は、STOMPクライアントツールを使って接続をテストし、正常に動作しているか確認できます。例えば、stomp.pyなどがあります。

パブリッシュ／サブスクライブ ​

STOMPプロトコルはPUB/SUBメッセージングモデルに完全対応しており、STOMPゲートウェイでは以下のように動作します。

  • STOMPプロトコルの SEND メッセージをメッセージのパブリッシュに使用します。SEND メッセージの destination フィールドがトピックを指定し、メッセージ内容は SEND メッセージのボディに含まれます。QoSは固定で0です。
  • STOMPプロトコルの SUBSCRIBE メッセージをサブスクライブ要求に使用します。SUBSCRIBE メッセージの destination フィールドがトピックを指定します。QoSは固定で0、MQTTプロトコルで定義されるワイルドカードをサポートします。
  • STOMPプロトコルの UNSUBSCRIBE メッセージをサブスクライブ解除要求に使用します。UNSUBSCRIBE メッセージの destination フィールドがトピックを指定します。

STOMPゲートウェイのカスタマイズ ​

デフォルト設定に加え、EMQXはさまざまな設定オプションを提供しており、特定のビジネス要件に合わせて調整できます。本節では、Gateways ページで利用可能な各種フィールドについて詳しく解説します。

基本設定 ​

Basic Configuration タブでは、許容する最大ヘッダー数、ヘッダー長の最大値、統計情報の有効化設定、ゲートウェイのMountPoint文字列の設定が可能です。以下に各フィールドの詳細を示します。

  1. Max Header: 許容する最大STOMPヘッダー数を設定します。デフォルトは 10。

  2. Max Each Header Length: ヘッダー値の最大文字列長を設定します。デフォルトは 1024。

  3. Max Body Length: STOMPパケットの最大バイト数を設定します。デフォルトは 65536。

  4. Idle Timeout: 非アクティブ状態が続いた場合に接続を切断するまでの最大待機時間（秒）を設定します。

  5. Enable Statistics: ゲートウェイが統計情報を収集・報告するかどうかを設定します。デフォルトは true。選択肢は true または false。

  6. MountPoint: パブリッシュやサブスクライブ時にすべてのトピックの前に付加される文字列を設定します。これにより異なるプロトコル間でのメッセージルーティングの分離が可能です。例: stomp/。

    注意: このトピックプレフィックスはゲートウェイ側で管理されるため、クライアントはパブリッシュやサブスクライブ時に明示的にこのプレフィックスを付加する必要はありません。

リスナーの追加 ​

ポート 61613 で名前が default のtcpリスナーがすでに設定されており、最大16のアセプターをプールで管理し、最大1,024,000の同時接続をサポートしています。より詳細な設定を行うには Settings をクリックし、リスナーを削除するには Delete をクリック、新しいリスナーを追加するには + Add Listener をクリックしてください。

TIP

STOMPゲートウェイはTCPおよびSSLタイプのリスナーのみをサポートしています。

Add Listener をクリックすると Add Listener ページが開き、以下の設定項目を入力できます。

基本設定

  • Name: リスナーの一意識別子を設定します。
  • Type: プロトコルタイプを選択します。STOMPの場合は tcp または ssl のいずれかです。
  • Bind: リスナーが接続を受け付けるポート番号を設定します。
  • MountPoint（任意）: パブリッシュやサブスクライブ時にすべてのトピックの前に付加される文字列を設定し、異なるプロトコル間でのメッセージルーティング分離を実現します。

リスナー設定

  • Acceptor: アセプタープールのサイズを設定します。デフォルトは 16。
  • Max Connections: リスナーが処理可能な最大同時接続数を設定します。デフォルトは 1024000。
  • Max Connection Rate: リスナーが1秒あたりに受け入れ可能な新規接続の最大レートを設定します。デフォルトは 1000。
  • Proxy Protocol: EMQXがロードバランサーの背後にある場合に、プロトコルV1/V2を有効にします。
  • Proxy Protocol Timeout: プロキシプロトコルパッケージを待機する最大時間（秒）を設定し、非アクティブ状態で接続を切断します。デフォルトは 3秒。

TCP設定

  • ActiveN: ソケットの {active, N} オプションを設定します。これはソケットが能動的に処理可能な受信パケット数を示します。詳細はErlang Documentation - setopts/2を参照してください。
  • Buffer: 受信および送信パケットを格納するバッファサイズをKB単位で設定します。
  • TCP_NODELAY: 接続に対して TCP_NODELAY フラグを有効にするかどうかを設定します。これはクライアントが前回のデータのアックを待たずに追加データを送信できるかを制御します。デフォルトは false。選択肢は true または false。
  • SO_REUSEADDR: ポート番号のローカル再利用を許可するかどうかを設定します。
  • Send Timeout: プロキシプロトコルパッケージを待機する最大時間（秒）を設定し、非アクティブ状態で接続を切断します。デフォルトは 15秒。
  • Send Timeout: 送信タイムアウト時に接続を切断するかどうかを設定します。

SSL設定（SSLリスナーのみ）

TLS検証を有効にするかどうかをトグルスイッチで設定できます。ただし、その前に関連する TLS Cert、TLS Key、および CA Cert の情報をファイルの内容を入力するか、Select File ボタンでアップロードして設定する必要があります。詳細はSSL/TLS接続の有効化を参照してください。

続いて以下の設定を行えます。

  • SSL Versions: サポートするSSLバージョンを設定します。デフォルトは tlsv1.3、tlsv1.2、tlsv1.1、tlsv1。
  • Fail If No Peer Cert: クライアントが空の証明書を送信した場合に接続を拒否するかどうかを設定します。デフォルトは false。選択肢は true または false。
  • Intermediate Certificate Depth: ピア証明書に続く有効な証明書パスに含められる自己発行でない中間証明書の最大数を設定します。デフォルトは 10。
  • Key Password: プライベートキーがパスワード保護されている場合に使用するユーザーパスワードを設定します。

認証の設定 ​

STOMPプロトコルの接続メッセージにはユーザー名とパスワードの概念が既に定義されているため、STOMPゲートウェイは以下のような多様な認証方式をサポートしています。

STOMPゲートウェイはSTOMPプロトコルの CONNECT または STOMP メッセージ内の情報を用いてクライアントの認証フィールドを生成します。

  • クライアントID: ランダムに生成される文字列
  • ユーザー名: CONNECT または STOMP メッセージヘッダーの login フィールドの値
  • パスワード: CONNECT または STOMP メッセージヘッダーの passcode フィールドの値

また、REST APIを使ってSTOMPゲートウェイ用の組み込みデータベース認証を作成することも可能です。

例:

bash
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"
}'

TIP

MQTTプロトコルとは異なり、ゲートウェイは認証器の作成のみをサポートし、認証器リスト（認証チェーン）はサポートしていません。

認証器が有効化されていない場合、すべてのSTOMPクライアントはログインが許可されます。