編寫及回應 Pub/Sub 訊息

Cloud Pub/Sub 在應用程式之間提供可靠且多對多的非同步訊息傳遞功能。發佈者應用程式能將訊息傳送到「主題」,其他應用程式訂閱該主題後就能收到訊息。

本文件說明如何使用 Google Cloud 用戶端程式庫,透過彈性環境中執行的應用程式傳送及接收 Cloud Pub/Sub 訊息。

必備條件

  • 請依照 App Engine 上 Java 適用的「Hello, World!」操作說明設定您的環境和專案,並瞭解如何在 App Engine 中建構 Java 應用程式。
  • 請記下並儲存您的專案 ID;您需要這項資訊才能執行本文所述的範例應用程式。

複製範例應用程式

將範例應用程式複製到您的本機電腦,然後前往 pubsub 目錄:

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

建立主題和訂閱

建立主題和訂閱,其中包括指定 Pub/Sub 伺服器傳送要求的目的地端點:

gcloud pubsub topics create YOUR_TOPIC_NAME
gcloud 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。推送端點會使用這個憑證來驗證要求。

設定環境變數

編輯 app.yaml 檔案以針對您的主題和驗證憑證設定環境變數:

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

程式碼審查

範例應用程式使用 Google Cloud 用戶端程式庫

範例應用程式會使用您在 app.yaml 檔案中設定的值來設定環境變數。推送要求處理常式會使用這些值,確認要求是來自 Pub/Sub 和可信任的來源:

String pubsubVerificationToken = System.getenv("PUBSUB_VERIFICATION_TOKEN");

範例應用程式會維護一個 Cloud Datastore 資料庫執行個體,以便儲存訊息。PubSubPush Servlet 可接收已推送的訊息並將訊息新增至 messageRepository 資料庫執行個體:

@WebServlet(value = "/pubsub/push")
public class PubSubPush extends HttpServlet {

  @Override
  public void doPost(HttpServletRequest req, HttpServletResponse resp)
      throws IOException, ServletException {
    String pubsubVerificationToken = System.getenv("PUBSUB_VERIFICATION_TOKEN");
    // Do not process message if request token does not match pubsubVerificationToken
    if (req.getParameter("token").compareTo(pubsubVerificationToken) != 0) {
      resp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
      return;
    }
    // parse message object from "message" field in the request body json
    // decode message data from base64
    Message message = getMessage(req);
    try {
      messageRepository.save(message);
      // 200, 201, 204, 102 status codes are interpreted as success by the Pub/Sub system
      resp.setStatus(HttpServletResponse.SC_OK);
    } catch (Exception e) {
      resp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
    }
  }

PubSubPublish Servlet 會與 App Engine 網頁應用程式互動,以發布新訊息並顯示收到的訊息:

@WebServlet(name = "Publish with PubSub", value = "/pubsub/publish")
public class PubSubPublish extends HttpServlet {

  @Override
  public void doPost(HttpServletRequest req, HttpServletResponse resp)
      throws IOException, ServletException {
    Publisher publisher = this.publisher;
    try {
      String topicId = System.getenv("PUBSUB_TOPIC");
      // create a publisher on the topic
      if (publisher == null) {
        publisher = Publisher.newBuilder(
            ProjectTopicName.of(ServiceOptions.getDefaultProjectId(), topicId))
            .build();
      }
      // construct a pubsub message from the payload
      final String payload = req.getParameter("payload");
      PubsubMessage pubsubMessage =
          PubsubMessage.newBuilder().setData(ByteString.copyFromUtf8(payload)).build();

      publisher.publish(pubsubMessage);
      // redirect to home page
      resp.sendRedirect("/");
    } catch (Exception e) {
      resp.sendError(HttpStatus.SC_INTERNAL_SERVER_ERROR, e.getMessage());
    }
  }

在本機執行範例

在本機執行應用程式範例時,您可以透過 Cloud SDK 提供驗證,以便使用 Google Cloud API。如果您是根據必備條件一節中的指示設定環境,您應該已執行可提供這項驗證的 gcloud init 指令。

mvn clean package

接著設定環境變數,然後啟動應用程式:

export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
mvn jetty:run

模擬推播通知

應用程式可在本機傳送訊息,但是無法在本機接收推送訊息。然而,您可以向本機推播通知端點提出 HTTP 要求,藉此模擬推送訊息。範例包括 sample_message.json 檔案。

您可以使用 curlhttpie 傳送 HTTP POST 要求:

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

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

回應:

HTTP/1.1 200 OK
Date: Wed, 26 Apr 2017 00:03:28 GMT
Content-Length: 0
Server: Jetty(9.3.8.v20160314)

完成要求後,您可以重新整理 localhost:8080,並在收到訊息的清單中查看訊息。

在 App Engine 上執行

如要使用 gcloud 指令列工具將示範應用程式部署到 App Engine,請於 app.yaml 檔案所在的目錄執行下列指令:

mvn appengine:deploy

您現在可以在 https://[YOUR_PROJECT_ID].appspot.com 存取應用程式,並可以使用表單提交訊息,但是系統無法保證應用程式的哪個執行個體會收到通知。此外,您也可以傳送多則訊息、重新整理頁面以查看收到的訊息。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Java 適用的 App Engine 彈性環境文件