Skip to content

Auto Subscribe

Auto Subscribeは、EMQXがサポートする拡張MQTT機能です。Auto Subscriptionを有効にすると、ユーザーは複数のEMQXルールを設定できます。クライアントがEMQXに正常に接続されると、EMQXはクライアントのサブスクライブ処理を自動的に完了し、クライアントはもはやSUBSCRIBEリクエストを送信する必要がなくなります。

EMQX 5.0以前では、この機能はProxy Subscriptionと呼ばれていました。

DashboardでAuto Subscribeを設定する

  1. EMQXダッシュボードを開きます。左のナビゲーションメニューでManagement -> Auto Subscribeをクリックします。

  2. Auto Subscribeページで、右上の**+ Add**ボタンをクリックします。

  3. ポップアップダイアログで、Topicテキストボックスにテスト用トピックa/1を入力します。他の設定はデフォルトのままにします。

    • Topic: クライアントが自動的にサブスクライブするトピックを入力します。プレースホルダーを使って動的にトピックを構築することも可能です。詳細はプレースホルダーをご覧ください。

    • QoS: トピックのサービス品質を指定します。選択肢は012です。

    • No local: 選択肢はFalseまたはTrueです。

    • Retain as Published: 指定したトピックで送信されたメッセージを保持するかどうかを指定します。選択肢はFalseまたはTrueです。

    • Retained Handling: 選択肢は012です。

      Auto SubscribeのDashboard設定画面

    ダイアログのAddボタンをクリックします。これで自動サブスクライブトピックa/1が正常に作成されます。

    Auto Subscribeの成功画面

これで自動サブスクライブ機能が有効になりました。新しいサブスクライバーは、ブローカーに接続すると自動的にトピックa/1をサブスクライブします。

MQTTX DesktopでAuto Subscriptionを試す

トピックa/1DashboardでAuto Subscribeを設定するで自動サブスクライブトピックとして設定されています。以下の手順では、クライアントがブローカーに接続すると自動的にトピックa/1をサブスクライブする様子を示します。

前提条件

MQTTX Desktopを使った基本的なパブリッシュおよびサブスクライブ操作の理解。

  1. EMQXとMQTTX Desktopを起動します。New Connectionをクリックして、パブリッシャーとしてクライアント接続を作成します。

    • NameフィールドにDemoと入力します。
    • Hostにローカルホスト127.0.0.1を入力します(このデモの例として)。
    • 他の設定はデフォルトのままにしてConnectをクリックします。

    TIP

    MQTT接続の作成に関する詳細な手順はMQTTX Desktopをご参照ください。

    新規接続の一般設定画面
  2. もう一つのMQTTクライアント接続をSubscriberという名前で作成します。

  3. ConnectionsペインでクライアントDemoを選択し、トピックにa/1を入力してこのトピックにメッセージを送信します。

    • クライアントSubscriberは新たにサブスクライブを作成しなくても自動的にメッセージを受信します。

    • クライアントDemoも新しい接続としてメッセージを受信します。

      TIP

      パブリッシュ/サブスクライブパターンでは、クライアントは送信者とサブスクライバーの両方になることが可能です。

  4. EMQXダッシュボードに移動し、左のナビゲーションメニューからMonitoring -> Subscriptionsをクリックします。トピックa/1に自動的にサブスクライブされた2つのサブスクリプションが表示されます。

    Auto Subscribeのダッシュボード表示

MQTTX CLIでAuto Subscriptionを試す

前提条件

MQTTX CLIを使った基本的なパブリッシュおよびサブスクライブ操作の理解。

  1. クライアントIDをemqx_cとして新しい接続を作成します。

    bash
    mqttx conn -i emqx_c
  2. EMQXダッシュボードに移動し、左のナビゲーションメニューからMonitoring -> Subscriptionsをクリックします。クライアントemqx_cがトピックa/1をサブスクライブしていることが表示されます。

    emqx_cのAuto Subscribe表示

プレースホルダー

Auto Subscribeはプレースホルダーをサポートし、トピックを動的に構築できます。プレースホルダーの形式は${}です。サポートされる変数は以下の通りです。

  • ${clientid}: クライアントID
  • ${username}: クライアントのユーザー名
  • ${host}: クライアントがEMQXに接続した際のIPアドレス

例えば、クライアントIDがemqx_cで設定されたトピックがa/${clientid}の場合、クライアントはEMQXに接続後、自動的にトピックa/emqx_cをサブスクライブします。