Pub/Sub メッセージの作成と応答

Google Cloud Pub/Sub は、アプリケーション間で信頼できる多対多の非同期メッセージングを行います。パブリッシャー アプリケーションはメッセージを「トピック」に送信し、その他のアプリケーションはそのトピックにサブスクライブしてメッセージを受信できます。

このドキュメントでは、Google Cloud クライアント ライブラリを使用して、フレキシブル環境で動作するアプリで Google Cloud Pub/Sub メッセージを送受信する方法について説明します。

前提条件

  • App Engine の Python 用「Hello, World!」の説明に従って環境とプロジェクトを設定し、App Engine の Python アプリの構造について理解します。
  • このドキュメントで説明しているサンプル アプリケーションを実行するために必要なので、プロジェクト ID をメモして保存します。

    サンプルアプリのクローンの作成

    サンプルアプリをローカルマシンにコピーし、pubsub ディレクトリに移動します。

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples
    cd python-docs-samples/appengine/flexible/pubsub
    

    トピックとサブスクリプションを作成する

    トピックとサブスクリプションを作成します。Pub/Sub サーバーがリクエストを送信するエンドポイントも指定します。

    gcloud beta pubsub topics create YOUR_TOPIC_NAME
    gcloud beta pubsub subscriptions create YOUR_SUBSCRIPTION_NAME \
        --topic YOUR_TOPIC_NAME \
        --push-endpoint \
        https://YOUR_PROJECT_ID.appspot.com/pubsub/push?token=YOUR_TOKEN \
        --ack-deadline 10
    

    YOUR_TOKEN は、ランダムなシークレット トークンで置き換えます。push エンドポイントがこれを使用してリクエストを検証します。

    app.yaml を編集する

    app.yaml を編集して、プロジェクト ID、トピック、検証トークンの環境変数を設定します。

    env_variables:
        PUBSUB_TOPIC: your-topic
        # This token is used to verify that requests originate from your
        # application. It can be any sufficiently random string.
        PUBSUB_VERIFICATION_TOKEN: 1234abc

    コードをレビューする

    サンプルアプリでは、Google Cloud Client ライブラリを使用しています。

    このサンプルアプリでは、app.yaml ファイルに設定された値を使用して環境変数を設定します。push リクエスト ハンドラは、これらの値を使用して、Pub/Sub からのリクエストで、信頼できる送信元から送信されていることを確認します。

    app.config['PUBSUB_VERIFICATION_TOKEN'] = \
        os.environ['PUBSUB_VERIFICATION_TOKEN']
    app.config['PUBSUB_TOPIC'] = os.environ['PUBSUB_TOPIC']
    

    このサンプルアプリは、グローバル リストを使用して、このインスタンスで受信したメッセージを保存します。

    MESSAGES = []
    

    pubsub_push() メソッドは、push されたメッセージを受信し、それらを MESSAGES グローバル リストに追加します。

    @app.route('/pubsub/push', methods=['POST'])
    def pubsub_push():
        if (request.args.get('token', '') !=
                current_app.config['PUBSUB_VERIFICATION_TOKEN']):
            return 'Invalid request', 400
    
        envelope = json.loads(request.data.decode('utf-8'))
        payload = base64.b64decode(envelope['message']['data'])
    
        MESSAGES.append(payload)
    
        # Returning any 2xx status indicates successful receipt of the message.
        return 'OK', 200

    index() メソッドは、App Engine ウェブアプリと連携して新しいメッセージを公開し、受信したメッセージを表示します。

    @app.route('/', methods=['GET', 'POST'])
    def index():
        if request.method == 'GET':
            return render_template('index.html', messages=MESSAGES)
    
        data = request.form.get('payload', 'Example payload').encode('utf-8')
    
        publisher = pubsub_v1.PublisherClient()
        topic_path = publisher.topic_path(
            current_app.config['PROJECT'],
            current_app.config['PUBSUB_TOPIC'])
    
        publisher.publish(topic_path, data=data)
    
        return 'OK', 200

    サンプルをローカルで実行する

    ローカルで実行する場合、Google Cloud SDK を使用して Google Cloud API を使用するための認証を行うことができます。前提条件で説明したように環境が設定されている場合は、この認証を行う gcloud init コマンドがすでに実行されています。

    依存関係をインストールします。virtualenv を使用することをおすすめします。

    Mac OS / Linux

    1. プロジェクトの外部のディレクトリに分離孤立した Python 環境を作成し、それを有効化します。
      virtualenv env
      source env/bin/activate
    2. プロジェクト ディレクトリに移動し、依存関係をインストールします。
      cd YOUR_PROJECT
      pip install  -r requirements.txt

    Windows

    Cloud SDK をインストールしている場合は、すでに Python 2.7 がインストールされているはずです。これは通常、C:\python27_x64\(64 ビットシステムの場合)にインストールされています。Powershell を使用して Python パッケージを実行します。

    1. インストールされた Powershell を探します。
    2. Powershell へのショートカットを右クリックし、管理者として Powershell を起動します。
    3. python コマンドを実行してみます。見つからない場合は、環境の PATH に Python フォルダを追加します。
      $env:Path += ";C:\python27_x64\"
    4. プロジェクトの外部のディレクトリに分離孤立した Python 環境を作成し、それを有効化します。
      python -m virtualenv env
      env\Scripts\activate
    5. プロジェクト ディレクトリに移動し、依存関係をインストールします。
      cd YOUR_PROJECT
      python -m pip install -r requirements.txt

    次に、アプリケーションを起動する前に環境変数を設定します。

    export GOOGLE_CLOUD_PROJECT=[your-project-id]
    export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
    export PUBSUB_TOPIC=[your-topic]
    python main.py
    

    プッシュ通知をシミュレートする

    アプリケーションは、ローカルでメッセージを送信できますが、push メッセージを受信することはできません。push メッセージをシミュレートするには、ローカル プッシュ通知エンドポイントに HTTP リクエストを送信します。このサンプルには、sample_message.json というファイルが含まれています。

    curl または httpie を使用して、HTTP POST リクエストを送信できます。

    curl -i -H "Content-Type: application/json" --data @sample_message.json "localhost:8080/pubsub/push?token=[your-token]"
    

    または

    http POST ":8080/pubsub/push?token=[your-token]" < sample_message.json
    

    レスポンス:

    HTTP/1.0 200 OK
    Content-Length: 2
    Content-Type: text/html; charset=utf-8
    Date: Mon, 10 Aug 2015 17:52:03 GMT
    Server: Werkzeug/0.10.4 Python/2.7.10
    
    OK
    

    リクエストの完了後、localhost:8080 を更新すると、受信メッセージのリストにメッセージが表示されます。

    App Engine で実行する

    gcloud コマンドライン ツールを使用してデモアプリを App Engine にデプロイするには、app.yaml が存在するディレクトリから次のコマンドを実行します。

    gcloud app deploy
    

    これで、https://[YOUR_PROJECT_ID].appspot.com のアプリケーションにアクセスできます。フォームを使用してメッセージを送信できますが、通知を受信するアプリケーションのインスタンスが常に同じとは限りません。複数のメッセージを送信してページを更新すると、受信メッセージを確認できます。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python 用 App Engine フレキシブル環境に関するドキュメント