Recevoir des messages provenant d'abonnements Lite

Cette page explique comment recevoir des messages à partir d'abonnements Lite. Vous pouvez recevoir des messages avec la bibliothèque cliente Pub/Sub Lite pour Java.

Les abonnements Lite connectent les sujets Lite aux applications des abonnés. Les abonnés reçoivent des messages des abonnements Lite. Les abonnés reçoivent tous les messages que les applications de l'éditeur envoient au sujet Lite, y compris les messages que les éditeurs envoient avant de créer l'abonnement Lite.

Avant de recevoir des messages d'un abonnement Lite, créez un sujet Lite, créez un abonnement Lite au sujet Lite et publiez des messages dans le sujet Lite.

Recevoir des messages

Pour recevoir des messages d'un abonnement Lite, demandez des messages à partir de l'abonnement Lite. La bibliothèque cliente se connecte automatiquement aux partitions du sujet Lite associé à l'abonnement Lite.

L'exemple suivant montre comment recevoir des messages provenant d'abonnements Lite :

Java

Avant d'exécuter cet exemple, suivez les instructions de configuration de Java dans la section Bibliothèques clientes de Pub/Sub Lite.

import com.google.cloud.pubsub.v1.AckReplyConsumer;
import com.google.cloud.pubsub.v1.MessageReceiver;
import com.google.cloud.pubsublite.CloudRegion;
import com.google.cloud.pubsublite.CloudZone;
import com.google.cloud.pubsublite.ProjectNumber;
import com.google.cloud.pubsublite.SubscriptionName;
import com.google.cloud.pubsublite.SubscriptionPath;
import com.google.cloud.pubsublite.SubscriptionPaths;
import com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings;
import com.google.cloud.pubsublite.cloudpubsub.Subscriber;
import com.google.cloud.pubsublite.cloudpubsub.SubscriberSettings;
import com.google.pubsub.v1.PubsubMessage;
import io.grpc.StatusException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class SubscriberExample {

  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String cloudRegion = "your-cloud-region";
    char zoneId = 'b';
    // Choose an existing subscription for the subscribe example to work.
    String subscriptionId = "your-subscription-id";
    long projectNumber = Long.parseLong("123456789");

    subscriberExample(cloudRegion, zoneId, projectNumber, subscriptionId);
  }

  public static void subscriberExample(
      String cloudRegion, char zoneId, long projectNumber, String subscriptionId)
      throws StatusException {

    SubscriptionPath subscriptionPath =
        SubscriptionPaths.newBuilder()
            .setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
            .setProjectNumber(ProjectNumber.of(projectNumber))
            .setSubscriptionName(SubscriptionName.of(subscriptionId))
            .build();

    // The message stream is paused based on the maximum size or number of messages that the
    // subscriber has already received, whichever condition is met first.
    FlowControlSettings flowControlSettings =
        FlowControlSettings.builder()
            // 10 MiB. Must be greater than the allowed size of the largest message (1 MiB).
            .setBytesOutstanding(10 * 1024 * 1024L)
            // 1,000 outstanding messages. Must be >0.
            .setMessagesOutstanding(1000L)
            .build();

    MessageReceiver receiver =
        (PubsubMessage message, AckReplyConsumer consumer) -> {
          System.out.println("Id : " + message.getMessageId());
          System.out.println("Data : " + message.getData().toStringUtf8());
          consumer.ack();
        };

    SubscriberSettings subscriberSettings =
        SubscriberSettings.newBuilder()
            .setSubscriptionPath(subscriptionPath)
            .setReceiver(receiver)
            // Flow control settings are set at the partition level.
            .setPerPartitionFlowControlSettings(flowControlSettings)
            .build();

    Subscriber subscriber = Subscriber.create(subscriberSettings);

    // Start the subscriber. Upon successful starting, its state will become RUNNING.
    subscriber.startAsync().awaitRunning();

    System.out.println("Listening to messages on " + subscriptionPath.value() + "...");

    try {
      System.out.println(subscriber.state());
      // Wait 90 seconds for the subscriber to reach TERMINATED state. If it encounters
      // unrecoverable errors before then, its state will change to FAILED and an
      // IllegalStateException will be thrown.
      subscriber.awaitTerminated(90, TimeUnit.SECONDS);
    } catch (TimeoutException t) {
      // Shut down the subscriber. This will change the state of the subscriber to TERMINATED.
      subscriber.stopAsync().awaitTerminated();
      System.out.println("Subscriber is shut down: " + subscriber.state());
    }
  }
}

La bibliothèque cliente établit des connexions bidirectionnelles en streaming avec chacune des partitions du sujet Lite.

  1. L'abonné demande des connexions aux partitions.

  2. Le service Pub/Sub Lite envoie les messages à l'abonné.

Une fois que l'abonné a traité le message, celui-ci doit en accuser réception. La bibliothèque cliente traite et interprète les messages de manière asynchrone dans un rappel. Pour limiter le nombre de messages non confirmés que l'abonné peut stocker en mémoire, configurez les paramètres de contrôle de flux.

Si plusieurs abonnés reçoivent des messages provenant du même abonnement Lite, le service Pub/Sub Lite connecte chaque abonné à une proportion égale de partitions. Par exemple, si deux abonnés utilisent le même abonnement Lite et que l'abonnement Lite est associé à un sujet Lite avec deux partitions, chaque abonné reçoit les messages de l'une des partitions.

Accuser réception des messages

Pour confirmer un message, envoyez l'accusé de réception à l'abonnement Lite.

Java

Pour envoyer un accusé de réception, utilisez la méthode AckReplyConsumer.ack().

Accusez réception de chaque message. Les abonnés reçoivent en premier le plus ancien message non confirmé, puis les messages suivants. Si un abonné ignore un message, accuse réception des messages suivants, puis se reconnecte, il reçoit le message non confirmé et chaque message ayant été confirmé après celui-ci.

Les abonnements Lite n'ont pas de délai d'accusé de réception et le service Pub/Sub Lite ne renvoie pas les messages non confirmés via une connexion en streaming ouverte.

Utiliser le contrôle de flux

Une fois que le service Pub/Sub Lite a distribué des messages aux abonnés, les abonnés stockent les messages non confirmés en mémoire. Vous pouvez limiter le nombre de messages restants que les abonnés peuvent stocker en mémoire à l'aide des paramètres de contrôle de flux. Les paramètres de contrôle de flux s'appliquent à chaque partition à partir de laquelle un abonné reçoit des messages.

Vous pouvez configurer les paramètres de contrôle de flux suivants :

  • La taille des messages en attente. Taille maximale des messages en attente, en octets. La taille maximale doit être supérieure à la taille du message le plus volumineux.
  • Nombre de messages. Nombre maximal de messages en attente.

La taille d'un message se situe dans le champ size_bytes. Vous pouvez configurer les paramètres de contrôle de flux à l'aide de la bibliothèque cliente.

Java

Pour configurer les paramètres de contrôle de flux, utilisez les méthodes suivantes de la classe FlowControlRequest.Builder :

Par exemple, si le nombre maximal de messages est de 100 et que l'abonné se connecte à 10 partitions, il ne peut pas recevoir plus de 100 messages depuis l'une des 10 partitions. Le nombre total de messages en attente peut être supérieur à 100, mais l'abonné ne peut pas stocker plus de 100 messages de chaque partition.