EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

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

スキーマレジストリの例 - 外部HTTPサーバー ​

このページでは、スキーマレジストリとルールエンジンが、カスタムロジックを持つ外部HTTPサーバーを使用してメッセージのエンコードおよびデコードをサポートする方法を示します。

場合によっては、EMQXがネイティブにサポートしていないカスタムのエンコードやデコードロジックを適用する必要があります。EMQXでは、ルール内の schema_encode および schema_decode 関数を通じて外部HTTPサービスを呼び出すことで、この処理を外部に委任できます。

外部HTTP API仕様 ​

外部HTTPサーバーは、EMQXの schema_encode および schema_decode 関数からのエンコードおよびデコード要求を受け取る単一のエンドポイントを公開する必要があります。EMQXは、このエンドポイントを POST（デフォルト）または GET メソッドのいずれかで呼び出せます。

リクエスト形式 ​

POSTリクエスト ​

リクエストボディは以下のフィールドを持つJSONオブジェクトです：

  • payload：ルールエンジンの schema_encode または schema_decode 関数に渡されるBase64エンコードされた文字列値。
  • type：評価される関数に応じて encode または decode の文字列。
  • schema_name：EMQXで設定されたこの外部HTTPスキーマの名前を識別する文字列。
  • opts：EMQXで設定可能な任意の文字列で、追加のオプションを提供し、HTTPサーバーにそのまま渡されます。

GETリクエスト ​

スキーマのメソッドが GET に設定されている場合、EMQXは同じフィールドをURLクエリパラメータとして送信します：

  • payload：パディングなしのURLセーフBase64エンコード。
  • type：encode または decode の文字列。
  • schema_name：EMQXで設定されたこの外部HTTPスキーマの名前を識別する文字列。
  • opts：変更なしで渡される任意の文字列。

スキーマURLにすでにクエリパラメータが含まれている場合、EMQXはこれら4つのパラメータを既存のクエリ文字列に追加します。

レスポンス形式 ​

  • サーバーはHTTPステータスコード 200 で応答する必要があります。
  • レスポンスボディは結果を表すBase64エンコードされた文字列を含む必要があります。このBase64値はEMQXに返す際にさらにJSONエンコードしてはいけません。

スキーマ設定リファレンス ​

ダッシュボードで外部HTTPスキーマを作成するとき、以下のフィールドが利用可能です：

フィールド必須説明
NameはいEMQX内でスキーマを一意に識別する名前。
TypeはいExternal HTTP に設定します。
URLはい外部HTTPサーバーのエンドポイントの完全なURL。例：http://server:9500/serde
Methodはいエンドポイント呼び出しに使用するHTTPメソッド。デフォルトは POST。外部サービスがクエリ文字列でリクエストフィールドを期待する場合のみ GET を使用してください。
Paramsいいえすべてのリクエストの opts フィールドとして渡される任意の文字列。サービスへの追加オプションや設定値を送るために使用します。
Headersいいえすべてのリクエストに含まれるHTTPヘッダー。content-type: application/json ヘッダーはデフォルトで追加されます。認証トークンなどの追加ヘッダーは Add をクリックして設定します。
Enable TLSいいえ外部HTTPサーバーがTLS接続を必要とする場合にオンにします。詳細は TLS for External Resource Access を参照してください。

利用例 ​

デバイスがバイナリメッセージをパブリッシュし、そのペイロードをカスタムのXOR演算でエンコードまたはデコードしたい場合を想定します。このセクションでは、シンプルな外部HTTPサービスを構築し、EMQXにカスタムのエンコード／デコードロジックを統合する方法を示します。

外部HTTPサービスの構築 ​

以下の例は、PythonとFlaskを使ってシンプルなHTTPサーバーを作成し実行する方法を示します。このサーバーは POST または GET リクエストを受け付け、受信したペイロードをデコードし、XOR演算を適用します。

外部HTTPサーバーのサンプルコード

Flask がインストールされていることを確認してください：

sh
pip install Flask==3.1.0

サンプルコード：

python
from flask import Flask, request
import base64

app = Flask(__name__)


def decode_payload(payload64):
    if request.method == "GET":
        # EMQXはGETペイロードをパディングなしのURLセーフBase64で送信します。
        payload64 += "=" * (-len(payload64) % 4)
        return base64.urlsafe_b64decode(payload64)
    return base64.b64decode(payload64)


@app.route("/serde", methods=["POST", "GET"])
def serde():
    # POSTはJSONボディを使用し、GETはクエリパラメータを使用します。
    body = request.args if request.method == "GET" else request.get_json(force=True)
    print("incoming request:", body)
    payload64 = body.get("payload")
    payload = decode_payload(payload64)
    secret = 122
    response = bytes(b ^ secret for b in payload)
    # レスポンスもBase64エンコードする必要があります
    response64 = base64.b64encode(response)
    return response64

サーバーを実行するには：

sh
# サーバーが同じディレクトリの `myapp.py` というファイルにあると仮定しています
flask --app myapp --debug run -h 0.0.0.0 -p 9500

EMQXで外部HTTPスキーマを作成 ​

  1. ダッシュボードで左側のナビゲーションメニューから Smart Data Hub -> Schema Registry を選択します。

  2. Internal タブページで Create をクリックします。

  3. 以下のパラメータで外部HTTPサーバースキーマを作成します：

    • Name：myhttp

    • Type：External HTTP

    • URL：サーバーが稼働している完全なURI。例：http://server:9500/serde

    • Method：POST または GET を選択。デフォルトは POST。外部サービスがクエリ文字列でリクエストフィールドを期待する場合のみ GET を使用してください。

  4. Create をクリックします。

スキーマを適用するルールを作成 ​

EMQXのルールエンジンを使って、メッセージのエンコード・デコードにスキーマを適用するルールを作成します。

  1. ダッシュボードでナビゲーションメニューから Integration -> Rules を選択します。

  2. Rules ページの右上にある Create をクリックします。

  3. 作成したスキーマを使って以下のルールSQL文を書きます：

    sql
    SELECT
  schema_encode('myhttp', payload) as encoded,
  schema_decode('myhttp', encoded) as decoded
FROM
  "t/external_http"

    schema_encode('myhttp', payload) と schema_decode('myhttp', encoded) の両方が設定した外部HTTPサーバーを呼び出し、指定されたペイロードをエンコード／デコードします。

  4. Add Action をクリックし、Action フィールドのドロップダウンリストから Republish を選択します。

  5. Topic フィールドに送信先トピックとして external_http/out と入力します。

  6. Payload フィールドにメッセージコンテンツテンプレートとして ${.} と入力します。

  7. Add をクリックしてアクションをルールに追加します。

    このアクションはデコードされたメッセージをJSON形式でトピック external_http/out に送信します。${.} はルールの出力全体の値に実行時に置き換わる変数プレースホルダーです。

  8. Save をクリックしてルール作成を完了します。

ルール実行結果の確認 ​

  1. ダッシュボードで Diagnose -> WebSocket Client を選択します。

  2. 現在のEMQXインスタンスの接続情報を入力します。

    • ローカルでEMQXを実行している場合はデフォルト値を使用できます。
    • 認証設定などでEMQXのデフォルト設定を変更している場合は、ユーザー名とパスワードを入力してください。

  3. Connect をクリックしてMQTTクライアントとしてEMQXインスタンスに接続します。

  4. Subscription エリアの Topic フィールドに external_http/out と入力し、Subscribe をクリックします。

  5. Publish エリアの Topic フィールドに t/external_http と入力し、任意のペイロードを記入して Publish をクリックします。

  6. WebSocket側でトピック external_http/out のメッセージが受信されることを確認します。例えば、ペイロードが hello の場合：

    json
    {"encoded":"\u0012\u001F\u0016\u0016\u0015","decoded":"hello"}