Anulação da união de payloads para subscrições push do Pub/Sub

Ao criar o seu sistema Pub/Sub, a anulação da união de payloads pode ajudar a estabelecer ligação a outros sistemas que não cumprem todos os requisitos do sistema de uma implementação de ponto final de envio do Pub/Sub padrão.

Seguem-se alguns potenciais exemplos de utilização da anulação da união da carga útil:

• Não quer escrever código de análise de mensagens específico do Pub/Sub para os seus pontos finais de envio HTTP.
• Prefere receber metadados de mensagens do Pub/Sub como cabeçalhos HTTP, em vez dos metadados no corpo do HTTP POST.
• Quer enviar mensagens do Pub/Sub e excluir os metadados do Pub/Sub, por exemplo, quando envia dados para uma API de terceiros.

Como funciona a anulação da união da carga útil

A anulação da união da carga útil é uma funcionalidade que remove todos os metadados das mensagens do Pub/Sub, exceto os dados das mensagens. Ao enviar dados de mensagens não processados, os subscritores podem processar a mensagem sem terem de cumprir os requisitos do sistema do Pub/Sub.

• Com a anulação da união do payload, os dados da mensagem são entregues diretamente como o corpo HTTP.
• Sem a anulação da união do payload, o Pub/Sub envia um objeto JSON que contém vários campos de metadados de mensagens e um campo de dados de mensagens. Neste caso, o JSON tem de ser analisado para obter os dados da mensagem e, em seguida, descodificado em base64.

Escreva metadados

Depois de ativar a anulação da união da carga útil, pode usar a opção Escrever metadados, que adiciona metadados de mensagens removidos anteriormente ao cabeçalho do pedido.

• Escrita de metadados ativada. Adicione novamente os metadados da mensagem ao cabeçalho do pedido. Também fornece os dados de mensagens não processados e descodificados.
• Escrita de metadados desativada. Apenas envia os dados de mensagens não processados e descodificados.

Os metadados de gravação são expostos através do Pub/Sub, do argumento --push-no-wrapper-write-metadata da CLI Google Cloud e da propriedade da API NoWrapper. Por predefinição, este valor é nulo.

Antes de começar

• Saiba mais sobre as subscrições do Pub/Sub e as subscrições push. A anulação da união do payload só pode ser usada com subscrições push.
• Saiba como configurar uma subscrição push.

Exemplo de mensagens com e sem wrapper

Os exemplos seguintes ilustram a diferença entre o envio de uma mensagem HTTP envolvida e não envolvida. Nestes exemplos, os dados das mensagens contêm a string {"status": "Hello there"}.

Para este exemplo, é criada uma subscrição com a funcionalidade de desencapsulamento do payload ativada e é publicada uma mensagem em mytopic. Usa uma chave de ordenação com um valor de some-key e o tipo de suporte é declarado como application/json.

gcloud pubsub topics publish mytopic
   --message='{"status": "Hello there"}'
   --ordering-key="some-key"
   --attribute "Content-Type=application/json"

As secções seguintes mostram a diferença entre uma mensagem com wrapper e sem wrapper.

Mensagem moldada

O exemplo seguinte mostra uma mensagem padrão do Pub/Sub envolvida. Neste caso, a anulação da união da carga útil não está ativada.

data="{"status": "Hello there"}"
ordering_key="some-key"
attributes=
  {
     {"Content-Type", "application/json"}
  }

Content-Length: 361
Content-Type: application/json
User-Agent: CloudPubSub-Google
Host: subscription-project.uc.r.appspot.com

{
  "message": {
      "attributes": {
          "Content-Type": "application/json"
      },
      "data": "eyJzdGF0dXMiOiAiSGVsbG8gdGhlcmUifQ==", //  Base64 - {"status": "Hello there"}
      "messageId": "2070443601311540",
      "message_id": "2070443601311540",
      "publishTime": "2021-02-26T19:13:55.749Z",
      "publish_time": "2021-02-26T19:13:55.749Z"
  },
  "subscription": "projects/myproject/..."
}

Mensagem não processada com metadados de escrita desativados

O exemplo seguinte mostra uma mensagem não envolvida com a opção de metadados de gravação desativada. Neste caso, os cabeçalhos x-goog-pubsub-* e os atributos das mensagens não estão incluídos.

data="{"status": "Hello there"}"
ordering_key="some-key"
attributes=
  {
     {"Content-Type", "application/json"}
  }

Content-Length: 25
User-Agent: CloudPubSub-Google
Host: subscription-project.uc.r.appspot.com

{"status": "Hello there"}

Mensagem não processada com metadados de escrita ativados

O exemplo seguinte mostra uma mensagem não processada com a opção de metadados de escrita ativada. Neste caso, os cabeçalhos x-goog-pubsub-* e os atributos das mensagens são incluídos.

data="{"status": "Hello there"}"
ordering_key="some-key"
attributes=
  {
     {"Content-Type", "application/json"}
  }

x-goog-pubsub-subscription-name: "projects/myproject/..."
x-goog-pubsub-message-id: "2070443601311540"
x-goog-pubsub-publish-time: "2021-02-26T19:13:55.749Z"
x-goog-pubsub-ordering-key: "some-key"
Content-Type: application/json
Content-Length: 12
User-Agent: CloudPubSub-Google
Host: subscription-project.uc.r.appspot.com

{"status": "Hello there"}

Configure a anulação da união do payload

Pode ativar o fornecimento por envio da anulação da união de payloads para uma subscrição através da página Detalhes da subscrição da Google Cloud consola, da CLI do Google Cloud ou das bibliotecas de cliente.

gcloud pubsub subscriptions create SUBSCRIPTION \
  --topic TOPIC \
  --push-endpoint=PUSH_ENDPOINT \
  --push-no-wrapper

gcloud pubsub subscriptions create SUBSCRIPTION \
  --topic TOPIC \
  --push-endpoint=PUSH_ENDPOINT \
  --push-no-wrapper \
  --push-no-wrapper-write-metadata

from google.cloud import pubsub_v1

# TODO(developer)
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# subscription_id = "your-subscription-id"
# endpoint = "https://my-test-project.appspot.com/push"

publisher = pubsub_v1.PublisherClient()
subscriber = pubsub_v1.SubscriberClient()
topic_path = publisher.topic_path(project_id, topic_id)
subscription_path = subscriber.subscription_path(project_id, subscription_id)

no_wrapper = pubsub_v1.types.PushConfig.NoWrapper(write_metadata=True)
push_config = pubsub_v1.types.PushConfig(
    push_endpoint=endpoint, no_wrapper=no_wrapper
)

# Wrap the subscriber in a 'with' block to automatically call close() to
# close the underlying gRPC channel when done.
with subscriber:
    subscription = subscriber.create_subscription(
        request={
            "name": subscription_path,
            "topic": topic_path,
            "push_config": push_config,
        }
    )

print(f"Push no wrapper subscription created: {subscription}.")
print(f"Endpoint for subscription is: {endpoint}")
print(f"No wrapper configuration for subscription is: {no_wrapper}")

/*
 * Copyright 2016 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package pubsub;


import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
import com.google.pubsub.v1.PushConfig;
import com.google.pubsub.v1.PushConfig.NoWrapper;
import com.google.pubsub.v1.Subscription;
import com.google.pubsub.v1.SubscriptionName;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

public class CreateUnwrappedPushSubscriptionExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String subscriptionId = "your-subscription-id";
    String topicId