Ao criar seu sistema Pub/Sub, o desencapsulamento de payload pode ajudar você a se conectar a outros sistemas que não atendem a todos os requisitos de uma implementação de endpoint de push padrão do Pub/Sub.
Estes são alguns possíveis casos de uso para desencapsulamento de payload:
- Não convém escrever um código de análise de mensagens específico do Pub/Sub para os endpoints de push HTTP.
- Você prefere receber metadados de mensagens do Pub/Sub como cabeçalhos HTTP em vez dos metadados no corpo do HTTP POST.
- Você quer enviar mensagens do Pub/Sub e excluir os metadados do Pub/Sub, por exemplo, ao enviar dados para uma API de terceiros.
Como funciona o desencapsulamento de payload
O desencapsulamento de payload é um recurso que remove todas as mensagens do Pub/Sub de todos os metadados das mensagens, exceto os dados delas. Ao enviar dados brutos de mensagens, os assinantes podem processar a mensagem sem precisar aderir a nenhum requisito de sistema do Pub/Sub.
- Com o desencapsulamento de payload, os dados da mensagem são entregues diretamente como o corpo HTTP.
- Sem o desencapsulamento do payload, o Pub/Sub entrega um objeto JSON que contém vários campos de metadados de mensagem e um campo de dados da mensagem. Nesse caso, o JSON precisa ser analisado para recuperar os dados da mensagem e, em seguida, decodificado em base64.
Gravar metadados
Depois de ativar o desencapsulamento de payload, use a opção Gravar metadados, que adiciona metadados removidos das mensagens ao cabeçalho da solicitação.
- Metadados de gravação ativados. Adicione os metadados da mensagem novamente ao cabeçalho da solicitação. Também entrega os dados brutos e decodificados da mensagem.
- Metadados de gravação desativados. Mostra apenas os dados brutos e decodificados da mensagem.
Os metadados de gravação são expostos por meio do Pub/Sub, do argumento --push-no-wrapper-write-metadata
da Google Cloud CLI e da propriedade de API NoWrapper
.
Por padrão, esse valor é nulo.
Antes de começar
- Saiba mais sobre assinaturas e assinaturas push do Pub/Sub. O desencapsulamento de payload só pode ser usado com assinaturas de push.
- Saiba como configurar uma assinatura de push.
Exemplo de mensagens com wrapper e desencapsulada
Os exemplos a seguir ilustram a diferença entre o envio de uma mensagem HTTP encapsulada e desencapsulada. Nesses exemplos, os dados da mensagem contêm
a string {"status": "Hello there"}
.
Neste exemplo, uma assinatura é criada com o recurso de desencapsulamento de payload
ativado e publica uma mensagem em mytopic
. Ela usa uma chave de ordem
com um valor some-key
e o tipo de mídia é declarado como
application/json
.
gcloud pubsub topics publish mytopic --message='{"status": "Hello there"}' --ordering-key="some-key" --attribute "Content-Type=application/json"
As seções a seguir mostram a diferença entre uma mensagem com wrapper e desencapsulada.
Mensagem agrupada
O exemplo a seguir mostra uma mensagem encapsulada do Pub/Sub padrão. Nesse caso, o desencapsulamento de payload não está ativado.
Publicar | Recebimentos de endpoint de push |
---|---|
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 desencapsulada com metadados de gravação desativados
No exemplo a seguir, mostramos uma mensagem desencapsulada com a opção de gravação de metadados desativada. Nesse caso, os cabeçalhos x-goog-pubsub-*
e os atributos da mensagem
não são incluídos.
Publicar | Recebimentos de endpoint de push |
---|---|
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 desencapsulada com metadados de gravação ativados
No exemplo a seguir, mostramos uma mensagem desencapsulada com a opção de gravação de metadados ativada. Nesse caso, os cabeçalhos x-goog-pubsub-*
e os atributos da mensagem
são incluídos.
Publicar | Recebimentos de endpoint de push |
---|---|
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"} |
Configurar o desencapsulamento de payload
É possível ativar a entrega por push de desencapsulamento de payload para uma assinatura usando a página Detalhes da assinatura do console do Google Cloud, a Google Cloud CLI ou as bibliotecas de cliente.
Console
No console do Google Cloud, acesse a página Assinaturas.
Clique em Criar assinatura.
No campo ID da assinatura, digite um nome.
Para saber como nomear uma assinatura, consulte Diretrizes para nomear um tópico ou uma assinatura.
Selecione um tópico no menu suspenso. A assinatura recebe mensagens do tópico.
Em Tipo de envio, selecione Enviar.
Para ativar o desencapsulamento de payload, selecione Ativar desencapsulamento de payload.
(Opcional) Para preservar os metadados das mensagens no cabeçalho da solicitação, selecione Gravar metadados. Ative essa opção para definir um cabeçalho Content-Type para suas mensagens.
Especifique um URL de endpoint.
Mantenha todos os outros valores padrão.
Clique em Criar.
gcloud
Para configurar uma assinatura com desencapsulamento de payload que inclua cabeçalhos
HTTP padrão, execute o seguinte comando
gcloud pubsub subscriptions create
:
gcloud pubsub subscriptions create SUBSCRIPTION \ --topic TOPIC \ --push-endpoint=PUSH_ENDPOINT \ --push-no-wrapper
Substitua:
SUBSCRIPTION
: o nome ou ID da assinatura de pull.TOPIC
: o ID do tópico.PUSH_ENDPOINT
: o URL a ser usado como o endpoint da assinatura. Por exemplo,https://myproject.appspot.com/myhandler
--push-no-wrapper
: entrega os dados da mensagem diretamente como o corpo HTTP.
Para configurar uma assinatura com desencapsulamento de payload e controlar o uso de
cabeçalhos x-goog-pubsub-*
, execute o seguinte comando:
gcloud pubsub subscriptions create SUBSCRIPTION \ --topic TOPIC \ --push-endpoint=PUSH_ENDPOINT \ --push-no-wrapper \ --push-no-wrapper-write-metadata
--push-no-wrapper-write-metadata
: quando verdadeiro, grava os metadados de mensagem do Pub/Sub nos cabeçalhosx-goog-pubsub-<KEY>:<VAL>
da solicitação HTTP. Grava os atributos das mensagens do Pub/Sub nos cabeçalhos<KEY>:<VAL>
da solicitação HTTP.
Python
Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.
Java
Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.
C++
Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.
Go
Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Definir um cabeçalho de tipo de conteúdo na sua mensagem
Depois de ativar o desencapsulamento de payload, o Pub/Sub não
define automaticamente um campo de cabeçalho de tipo de mídia na solicitação. Se você não definir explicitamente um campo de cabeçalho Content-Type
, o servidor da Web que processa a solicitação poderá definir um valor padrão application/octet-stream
ou interpretar a solicitação de maneira inesperada.
Se você precisar de um cabeçalho Content-Type
, declare-o explicitamente
no momento da publicação para cada mensagem publicada individual. Para isso, ative Gravar metadados primeiro. O resultado da ativação de Gravar metadados
é mostrado nos exemplos fornecidos.
A seguir
- Se você tiver problemas com o desencapsulamento de payload, consulte Resolver problemas de desencapsulamento de payload.