Apps lokal mit dem Emulator testen

Zum lokalen Entwickeln und Testen Ihrer Anwendung können Sie den Pub/Sub-Emulator verwenden, der eine lokale Emulation des Pub/Sub-Produktionsdienstes bereitstellt. Sie führen den Pub/Sub-Emulator über die Google Cloud CLI aus.

Wenn Sie die Anwendung mit dem Emulator ausführen möchten, starten Sie ihn zuerst und legen Sie die Umgebungsvariablen fest. Ihre Anwendung muss mit dem Emulator und nicht mit dem Pub/Sub-Produktionsdienst kommunizieren. Die erstellten Ressourcen und im Emulator veröffentlichte Nachrichten werden für die Dauer der Emulatorsitzung aufrechterhalten.

Hinweis: Zum Testen von Push-Abos im Emulator können Sie unverschlüsselte Push-Endpunkte (http) verwenden, wie in den folgenden Beispielen gezeigt. In der Produktion sind nur sichere Push-Endpunkte (https) zulässig.

Hinweise

Sie müssen die folgenden Voraussetzungen erfüllen, bevor Sie den Pub/Sub-Emulator verwenden:

• Richten Sie eine Python-Entwicklungsumgebung ein.

• Installieren Sie ein JDK.

• Installieren Sie die Google Cloud CLI.

• Erstellen Sie eine Anwendung mit den Cloud-Clientbibliotheken.

Emulator installieren

Installieren Sie den Emulator über eine Eingabeaufforderung:

gcloud components install pubsub-emulator
gcloud components update

Emulator als Container-Image installieren

Laden Sie das gCloud Docker-Image herunter und installieren Sie es, um den Emulator als Container zu installieren und auszuführen.

Emulator starten

Starten Sie den Emulator, indem Sie pubsub start über eine Eingabeaufforderung aufrufen. Bevor Sie den Befehl ausführen, ersetzen Sie PUBSUB_PROJECT_ID durch eine gültige Google Cloud-Projekt-ID. Zeichenfolge. Der String muss kein echtes Google Cloud-Projekt darstellen, da der Pub/Sub-Emulator lokal ausgeführt wird.

gcloud beta emulators pubsub start --project=PUBSUB_PROJECT_ID [options]

Eine vollständige Liste der Flags finden Sie unter gcloud beta emulators pubsub start.

Nach dem Starten des Emulators wird eine Meldung wie die folgende angezeigt:

...
[pubsub] This is the Pub/Sub fake.
[pubsub] Implementation may be incomplete or differ from the real system.
...
[pubsub] INFO: Server started, listening on 8085

Diese Meldung zeigt an, dass der Pub/Sub-Server auf dem Emulatorendpunkt auf Ihrem lokalen Computer und nicht auf dem Google Cloud-Endpunkt ausgeführt wird. Alle Vorgänge finden lokal statt, darunter:

• Erstellen eines Themas oder Abos
• Verlagswesen
• Wird abonniert

Hinweis: Der Emulator überwacht Port 8085 standardmäßig auf Ihrem IPv6-localhost (::1). Sie können festlegen, dass der Emulator den Port 8085 auf allen IP-Adressen in Ihrem System überwacht, indem Sie --host-port=0.0.0.0:8085 festlegen. Wenn IPv6 in Ihrem System deaktiviert ist, können Sie IPv4 (127.0.0.1) durch Festlegen von --host-port=127.0.0.1:8085 angeben.

Umgebungsvariablen festlegen

Nachdem Sie den Emulator gestartet haben, müssen Sie die Umgebungsvariablen festlegen, damit Ihre Anwendung eine Verbindung zum Emulator statt zu Pub/Sub herstellt. Legen Sie die Umgebungsvariablen auf dem Computer fest, auf dem auch die Anwendung ausgeführt wird.

Sie müssen die Umgebungsvariablen bei jedem Start des Emulators festlegen. Die Umgebungsvariablen hängen von dynamisch zugewiesenen Portnummern ab, die sich beim Neustart des Emulators ändern können.

Variablen automatisch einstellen

Wenn die Anwendung und der Emulator auf demselben Computer ausgeführt werden, können Sie die Umgebungsvariablen automatisch festlegen:

Linux/MacOS

Führen Sie env-init mit Befehlsersetzung aus:

$(gcloud beta emulators pubsub env-init)

Windows

Erstellen Sie eine Batchdatei und verwenden Sie bei der Ausführung die Ausgabe von env-init:

gcloud beta emulators pubsub env-init > set_vars.cmd && set_vars.cmd

Ihre Anwendung stellt jetzt eine Verbindung zum Pub/Sub-Emulator her.

Variablen manuell einstellen

Wenn die Anwendung und der Emulator auf unterschiedlichen Computern ausgeführt werden, legen Sie die Umgebungsvariablen manuell fest:

1. Führen Sie den Befehl env-init aus:

    gcloud beta emulators pubsub env-init

2. Legen Sie auf dem Computer, auf der Ihre Anwendung ausgeführt wird, die Umgebungsvariable PUBSUB_EMULATOR_HOST und den Wert entsprechend der Ausgabe des Befehls env-init fest. Durch diese Konfiguration wird Ihre Anwendung mit dem Emulator verbunden. Optional können Sie die Umgebungsvariable PUBSUB_PROJECT_ID für das Projekt festlegen, das Sie für den Emulator verwenden möchten. Beispiel:

   Linux / macOS

   export PUBSUB_EMULATOR_HOST=[::1]:8432
   export PUBSUB_PROJECT_ID=my-project-id

   Windows

   set PUBSUB_EMULATOR_HOST=[::1]:8432
   set PUBSUB_PROJECT_ID=my-project-id

Ihre Anwendung stellt jetzt eine Verbindung zum Pub/Sub-Emulator her.

Hinweis:Wenn Sie den lokalen Entwicklungsserver Python App Engine Standard verwenden, müssen Sie diese Umgebungsvariable in der Befehlszeile so übergeben:

dev_appserver.py app.yaml --env_var PUBSUB_EMULATOR_HOST=${PUBSUB_EMULATOR_HOST}

dev_appserver.py ist in [PATH_TO_CLOUD_SDK]/google-cloud-sdk/bin/dev_appserver.py enthalten.

Emulator verwenden

Wenn Sie den Emulator verwenden möchten, muss eine Anwendung mit den Cloud-Clientbibliotheken erstellt worden sein. Der Emulator unterstützt weder die Google Cloud Console noch gcloud pubsub-Befehle.

Im folgenden Beispiel wird die Verwendung des Emulators und einer Anwendung veranschaulicht, die die Python-Cloud-Clientbibliothek zur Durchführung verschiedener Vorgänge verwendet. Beispiele für diese Vorgänge sind das Erstellen eines Themas, das Veröffentlichen von Nachrichten und das Lesen von Nachrichten.

Führen Sie die folgenden Schritte auf dem Computer aus, auf dem Sie die Umgebungsvariablen für den Emulator festgelegt haben:

1. Rufen Sie die Pub/Sub Python-Beispiele von GitHub ab. Klonen Sie dafür das vollständige Python-Repository.

2. Wechseln Sie in Ihrem geklonten Repository zum Verzeichnis samples/snippets. Sie führen den Rest dieser Schritte in diesem Verzeichnis aus.

3. Installieren Sie aus dem Verzeichnis samples/snippets die Abhängigkeiten, die Sie zum Ausführen des Beispiels benötigen:

   pip install -r requirements.txt
   

4. Erstellen Sie ein Thema:

    python publisher.py PUBSUB_PROJECT_ID create TOPIC_ID
   

5. (Optional) Wenn Sie keinen lokalen Push-Endpunkt zum Testen von Push-Abos im Emulator haben, führen Sie die folgenden Schritte aus, um eins für http://[::1]:3000/messages zu erstellen.

   1. Installieren Sie JSON Server.

      npm install -g json-server
      

   2. Starten Sie den JSON-Server.

      json-server --port 3000 --watch db.json
      

      Dabei enthält db.json den folgenden Startcode:

      {
         "messages": []
      }
      

   3. Notieren Sie sich im nächsten Schritt http://[::1]:3000/messages für PUSH_ENDPOINT.

6. Erstellen Sie ein Abo für das Thema:

   • Erstellen Sie ein Pull-Abo:

     python subscriber.py PUBSUB_PROJECT_ID create TOPIC_ID SUBSCRIPTION_ID
     

   • Push-Abo erstellen:

     python subscriber.py PUBSUB_PROJECT_ID create-push TOPIC_ID SUBSCRIPTION_ID \
     PUSH_ENDPOINT
     

7. Veröffentlichen Sie Nachrichten zum Thema:

    python publisher.py PUBSUB_PROJECT_ID publish TOPIC_ID
   

8. Lesen Sie die zu dem Thema veröffentlichten Nachrichten:

   • Nachrichten aus Ihrem Pull-Abo abrufen:

     python subscriber.py PUBSUB_PROJECT_ID receive SUBSCRIPTION_ID
     

   • Beobachten Sie die an Ihren lokalen Push-Endpunkt zugestellten Nachrichten. Nachrichten sehen beispielsweise so aus:

     {
       "messages": [
           {
               "subscription": "projects/PUBSUB_PROJECT_ID/subscriptions/SUBSCRIPTION_ID",
               "message": {
                   "data": "TWVzc2FnZSBudW1iZXIgMQ==",
                   "messageId": "10",
                   "attributes": {}
               },
               "id": 1
           },
           ...
       ]
     }
     

Umgebungsvariablen aufrufen

In allen Sprachen außer Java und C# wird von den Pub/Sub-Clientbibliotheken anstelle von Pub/Sub automatisch die in der lokalen Instanz ausgeführte API aufgerufen, wenn Sie PUBSUB_EMULATOR_HOST wie unter Umgebungsvariablen festlegen beschrieben festgelegt haben.

Bei C#- und Java-Clientbibliotheken müssen Sie jedoch den Code ändern, um den Emulator zu verwenden:

C#

Folgen Sie der Einrichtungsanleitung für C# in der Pub/Sub-Kurzanleitung zur Verwendung von Clientbibliotheken, bevor Sie dieses Beispiel ausprobieren. Weitere Informationen finden Sie in der Referenzdokumentation zur Pub/Sub C# API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Pub/Sub zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

using Google.Api.Gax;
using Google.Cloud.PubSub.V1;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class EmulatorSupportSample
{
    public async Task WithEmulatorAsync(string projectId, string topicId, string subscriptionId)
    {
        // Use EmulatorDetection.EmulatorOrProduction to create service clients that will
        // that will connect to the PubSub emulator if the PUBSUB_EMULATOR_HOST environment
        // variable is set, but will otherwise connect to the production environment.

        // Create the PublisherServiceApiClient using the PublisherServiceApiClientBuilder
        // and setting the EmulatorDection property.
        PublisherServiceApiClient publisherService = await new PublisherServiceApiClientBuilder
        {
            EmulatorDetection = EmulatorDetection.EmulatorOrProduction
        }.BuildAsync();

        // Use the client as you'd normally do, to create a topic in this example.
        TopicName topicName = new TopicName(projectId, topicId);
        publisherService.CreateTopic(topicName);

        // Create the SubscriberServiceApiClient using the SubscriberServiceApiClientBuilder
        // and setting the EmulatorDection property.
        SubscriberServiceApiClient subscriberService = await new SubscriberServiceApiClientBuilder
        {
            EmulatorDetection = EmulatorDetection.EmulatorOrProduction
        }.BuildAsync();

        // Use the client as you'd normally do, to create a subscription in this example.
        SubscriptionName subscriptionName = new SubscriptionName(projectId, subscriptionId);
        subscriberService.CreateSubscription(subscriptionName, topicName, pushConfig: null, ackDeadlineSeconds: 60);

        // Create the PublisherClient using PublisherClientBuilder to set the EmulatorDetection property.
        PublisherClient publisher = await new PublisherClientBuilder
        {
            TopicName = topicName,
            EmulatorDetection = EmulatorDetection.EmulatorOrProduction
        }.BuildAsync();
        // Use the client as you'd normally do, to send a message in this example.
        await publisher.PublishAsync("Hello, Pubsub");
        await publisher.ShutdownAsync(TimeSpan.FromSeconds(15));

        // Create the SubscriberClient using SubscriberClientBuild to set the EmulatorDetection property.
        SubscriberClient subscriber = await new SubscriberClientBuilder
        {
            SubscriptionName = subscriptionName,
            EmulatorDetection = EmulatorDetection.EmulatorOrProduction
        }.BuildAsync();
        List<PubsubMessage> receivedMessages = new List<PubsubMessage>();

        // Use the client as you'd normally do, to listen for messages in this example.
        await subscriber.StartAsync((msg, cancellationToken) =>
        {
            receivedMessages.Add(msg);
            Console.WriteLine($"Received message {msg.MessageId} published at {msg.PublishTime.ToDateTime()}");
            Console.WriteLine($"Text: '{msg.Data.ToStringUtf8()}'");
            // In this example we stop the subscriber when the message is received.
            // You may leave the subscriber running, and it will continue to received published messages
            // if any.
            // This is non-blocking, and the returned Task may be awaited.
            subscriber.StopAsync(TimeSpan.FromSeconds(15));
            // Return Reply.Ack to indicate this message has been handled.
            return Task.FromResult(SubscriberClient.Reply.Ack);
        });
    }
}

Java

Folgen Sie der Einrichtungsanleitung für Java in der Pub/Sub-Kurzanleitung zur Verwendung von Clientbibliotheken, bevor Sie dieses Beispiel ausprobieren. Weitere Informationen finden Sie in der Referenzdokumentation zur Pub/Sub Java API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Pub/Sub zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

String hostport = System.getenv("PUBSUB_EMULATOR_HOST");
ManagedChannel channel = ManagedChannelBuilder.forTarget(hostport).usePlaintext().build();
try {
  TransportChannelProvider channelProvider =
      FixedTransportChannelProvider.create(GrpcTransportChannel.create(channel));
  CredentialsProvider credentialsProvider = NoCredentialsProvider.create();

  // Set the channel and credentials provider when creating a `TopicAdminClient`.
  // Similarly for SubscriptionAdminClient
  TopicAdminClient topicClient =
      TopicAdminClient.create(
          TopicAdminSettings.newBuilder()
              .setTransportChannelProvider(channelProvider)
              .setCredentialsProvider(credentialsProvider)
              .build());

  TopicName topicName = TopicName.of("my-project-id", "my-topic-id");
  // Set the channel and credentials provider when creating a `Publisher`.
  // Similarly for Subscriber
  Publisher publisher =
      Publisher.newBuilder(topicName)
          .setChannelProvider(channelProvider)
          .setCredentialsProvider(credentialsProvider)
          .build();
} finally {
  channel.shutdown();
}

Emulator beenden

Drücken Sie zum Beenden des Emulators Strg+C.

Nachdem Sie den Emulator beendet haben, führen Sie den folgenden Befehl aus, um die Umgebungsvariable PUBSUB_EMULATOR_HOST zu entfernen, damit Ihre Anwendung eine Verbindung zu Pub/Sub herstellt:

Linux / macOS

unset PUBSUB_EMULATOR_HOST

Windows

set PUBSUB_EMULATOR_HOST=

Befehlszeilenargumente des Emulators

Weitere Informationen zu Befehlszeilenargumenten für den Pub/Sub-Emulator finden Sie unter gcloud beta emulators pubsub.

Unterstützte Features

Der Emulator unterstützt die folgenden Pub/Sub-Features:

• Nachrichten veröffentlichen
• Nachrichten von Push- und Pull-Abos empfangen
• Nachrichten in eine Reihenfolge bringen
• Nachrichten wiedergeben
• Nachrichten an Themen für unzustellbare Nachrichten weiterleiten
• Richtlinien für Wiederholungsversuche bei der Nachrichtenübermittlung
• Schemaunterstützung für Avro

Bekannte Einschränkungen

• UpdateTopic- und UpdateSnapshot-RPCs werden nicht unterstützt.
• IAM-Vorgänge werden nicht unterstützt.
• Die konfigurierbare Nachrichtenaufbewahrung wird nicht unterstützt. Alle Nachrichten werden auf unbestimmte Zeit aufbewahrt.
• Der Ablauf von Abos wird nicht unterstützt. Abos laufen nicht ab.
• Filtern wird nicht unterstützt.
• Schemaunterstützung für Protokollzwischenspeicher
• BigQuery-Abos können erstellt werden, senden jedoch keine Nachrichten an BigQuery.
• Das Suchen nach einem Zeitstempel für geordnete Abos wird nicht unterstützt.

Wenn Sie Probleme melden möchten, reichen Sie einen öffentlichen Issue Tracker ein.

Nächste Schritte

• Informationen zur Verwendung des Pub/Sub-Emulators mit Minikube finden Sie in diesem Blogpost.