ID da região
O REGION_ID
é um código abreviado que o Google atribui
com base na região que você selecionou ao criar o aplicativo. O código não
corresponde a um país ou estado, ainda que alguns IDs de região sejam semelhantes
aos códigos de país e estado geralmente usados. Para apps criados após
fevereiro de 2020, o REGION_ID.r
está incluído nos
URLs do App Engine. Para apps existentes criados antes dessa data, o
ID da região é opcional no URL.
Saiba mais sobre IDs de região.
O Pub/Sub mensagens assíncronas confiáveis de muitos para muitos entre os aplicativos. Os aplicativos do publisher podem enviar mensagens para um tópico e outros aplicativos podem assinar esse tópico para receber as mensagens.
Este documento descreve como usar a biblioteca de cliente do Cloud para enviar e receber mensagens do Pub/Sub em um aplicativo Java.
Pré-requisitos
- Siga as instruções em "Olá, mundo!" para Java 8 no App Engine para configurar seu ambiente e projeto e entender como os aplicativos Java 8 do App Engine estão estruturados.
- Anote e guarde o ID do projeto. Você precisará dele para executar o aplicativo de amostra descrito neste documento.
Como clonar o app de amostra
Copie os aplicativos de amostra para sua máquina local e navegue até o diretório pubsub
:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
cd java-docs-samples/appengine-java8/pubsub
Como criar um tópico e uma assinatura
Crie um tópico e uma assinatura. Isso inclui especificar o endpoint que receberá as solicitações do Pub/Sub:
bv # Configure the topic gcloud pubsub topics create YOUR_TOPIC_NAME # Configure the push subscription gcloud pubsub subscriptions create YOUR_SUBSCRIPTION_NAME \ --topic=YOUR_TOPIC_NAME \ --push-endpoint=https://YOUR_PROJECT_ID.REGION_ID.r.appspot.com/push-handlers/receive_messages?token=YOUR_TOKEN \ --ack-deadline=10
Substitua YOUR_TOKEN
por um token aleatório secreto. Ele é usado pelo endpoint do push para verificar as solicitações.
Para usar o Pub/Sub com autenticação, crie outra assinatura:
# Configure the push subscription gcloud pubsub subscriptions create YOUR_SUBSCRIPTION_NAME \ --topic=YOUR_TOPIC_NAME \ --push-auth-service-account=YOUR-SERVICE-ACCOUNT-EMAIL\ --push-auth-token-audience=OPTIONAL_AUDIENCE_OVERRIDE\ --push-endpoint=https://YOUR_PROJECT_ID.REGION_ID.r.appspot.com/push-handlers/receive_messages?token=YOUR_TOKEN \ --ack-deadline=10 # Your service agent # `service-{PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com` needs to have the # `iam.serviceAccountTokenCreator` role. PUBSUB_SERVICE_ACCOUNT="service-${PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com" gcloud projects add-iam-policy-binding ${PROJECT_ID} \ --member="serviceAccount:${PUBSUB_SERVICE_ACCOUNT}"\ --role='roles/iam.serviceAccountTokenCreator'
Substitua YOUR-SERVICE-ACCOUNT-EMAIL
pelo e-mail da conta de serviço.
Como definir variáveis de ambiente
Edite o arquivo
appengine-web.xml
para definir as variáveis de ambiente do tópico e do token de verificação:
Revisão de código
O aplicativo de exemplo usa a Biblioteca de cliente do Cloud.O aplicativo de amostra usa os valores definidos no arquivo
appengine-web.xml
para configurar
variáveis de ambiente. Esses valores são usados pelo gerenciador da solicitação de push para
confirmar que a solicitação veio do Pub/Sub e veio de uma fonte confiável:
String pubsubVerificationToken = System.getenv("PUBSUB_VERIFICATION_TOKEN");
O aplicativo de amostra mantém uma instância de banco de dados do Cloud Datastore para armazenar mensagens.
O servlet PubSubPush
recebe as mensagens enviadas por push e as adiciona à instância do banco de dados messageRepository
:
O servlet PubSubPublish
interage com o aplicativo da Web do App Engine para publicar novas mensagens e exibir mensagens recebidas:
Executar a amostra no local
Com a Google Cloud CLI em execução no local, você pode fornecer autenticação
para usar as APIs do Google Cloud. Se tiver configurado o ambiente conforme descrito nos
Pré-requisitos, você já terá executado o comando
gcloud init
,
que fornece essa autenticação.
mvn clean package
Defina as variáveis de ambiente antes de iniciar o aplicativo:
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
mvn appengine:run
Como simular notificações push
Pelo aplicativo, é possível enviar mensagens localmente, mas não é possível receber mensagens push localmente. É possível simular uma mensagem de push com uma solicitação HTTP para o notification endpoint de push local. A amostra inclui o
sample_message.json
do arquivo.
É possível usar curl
ou
um cliente httpie
para
enviar uma solicitação POST
HTTP:
curl -H "Content-Type: application/json" -i --data @sample_message.json "localhost:8080/pubsub/push?token=[your-token]"
Ou
http POST ":8080/pubsub/push?token=[your-token]" < sample_message.json
Resposta:
HTTP/1.1 200 OK
Date: Wed, 26 Apr 2017 00:03:28 GMT
Content-Length: 0
Server: Jetty(9.3.8.v20160314)
Após a conclusão da solicitação, é possível atualizar localhost:8080
e ver a mensagem na lista de mensagens recebidas.
Como executar no App Engine
Para implantar o app de demonstração no App Engine usando a ferramenta de linha de comando gcloud
,
execute o seguinte comando no diretório em que
pom.xml
está localizado:
mvn package appengine:deploy -Dapp.deploy.projectId=PROJECT_ID
Substitua PROJECT_ID pelo ID do projeto do Google Cloud. Se
o arquivo pom.xml
já
especificar o
ID do projeto, não será necessário incluir a propriedade -Dapp.deploy.projectId
no
comando executado.
Agora, é possível acessar o aplicativo em
https://PROJECT_ID.REGION_ID.r.appspot.com
.
Use o formulário para enviar mensagens. No entanto, não há garantias sobre qual instância do seu aplicativo receberá a notificação. É possível enviar várias mensagens e atualizar a página para ver a mensagem recebida.