Escrever e responder a mensagens do Pub/Sub

ID da região

O REGION_ID é um código abreviado que a Google atribui com base na região que seleciona quando cria a sua app. O código não corresponde a um país ou uma província, embora alguns IDs de regiões possam parecer semelhantes aos códigos de países e províncias usados frequentemente. Para apps criadas após fevereiro de 2020, REGION_ID.r está incluído nos URLs do App Engine. Para apps existentes criadas antes desta data, o ID da região é opcional no URL.

Saiba mais acerca dos IDs de regiões.

O Pub/Sub oferece mensagens assíncronas fiáveis de muitos para muitos entre aplicações. As aplicações de publicadores podem enviar mensagens para um tópico, e outras aplicações podem subscrever esse tópico para receber as mensagens.

Este documento descreve como usar as bibliotecas cliente do Google Cloud para enviar e receber mensagens do Pub/Sub numa app do App Engine.

Pré-requisitos

Clonar a app de exemplo

Copie as apps de exemplo para a sua máquina local e navegue para o diretório pubsub:

Go

git clone https://github.com/GoogleCloudPlatform/golang-samples.git
cd golang-samples/appengine/go11x/pubsub/authenicated_push

Java

Não existe nenhum exemplo disponível para este tempo de execução.

Tenha em atenção que as apps de demonstração Java estão disponíveis no ambiente flexível.

Node.js

git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
cd nodejs-docs-samples/appengine/pubsub

PHP

git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
cd php-docs-samples/pubsub

Python

git clone https://github.com/GoogleCloudPlatform/python-docs-samples
cd python-docs-samples/appengine/standard_python3/pubsub

Ruby

git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
cd ruby-docs-samples/appengine/pubsub

Crie um tópico e uma subscrição

Crie um tópico e uma subscrição, que inclui a especificação do ponto final para o qual o servidor Pub/Sub deve enviar pedidos:

Go

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

Java

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

Node.js

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

PHP

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

Python

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

Ruby

# 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. O ponto final de envio usa isto para validar pedidos.

Para usar o Pub/Sub com autenticação, crie outra subscrição:

# 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 email da sua conta de serviço.

Definir variáveis de ambiente

Go

Edite o ficheiro app.yaml para definir as variáveis de ambiente para o seu tópico e token de validação:

# Copyright 2020 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
#
#     https://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.

runtime: go122
env_variables:
    # This token is used to verify that requests originate from your
    # application. It can be any sufficiently random string.
    PUBSUB_VERIFICATION_TOKEN: check123

Java

Edite o ficheiro app.yaml para definir as variáveis de ambiente para o seu tópico e token de validação:

env_variables:
  PUBSUB_TOPIC: <your-topic-name>
  PUBSUB_VERIFICATION_TOKEN: <your-verification-token>

Node.js

Edite o ficheiro app.yaml para definir as variáveis de ambiente para o seu tópico e token de validação:

env_variables:
  PUBSUB_TOPIC: YOUR_TOPIC_NAME
  # This token is used to verify that requests originate from your
  # application. It can be any sufficiently random string.
  PUBSUB_VERIFICATION_TOKEN: YOUR_VERIFICATION_TOKEN

PHP

Edite o ficheiro index.php para definir as variáveis de ambiente do seu tópico e subscrição:

$container->set('topic', 'php-example-topic');
$container->set('subscription', 'php-example-subscription');

Python

Edite o ficheiro app.yaml para definir as variáveis de ambiente para o ID do projeto, o tópico e o token de validação:

env_variables:
  PUBSUB_TOPIC: '<YOUR_TOPIC>'
  # This token is used to verify that requests originate from your
  # application. It can be any sufficiently random string.
  PUBSUB_VERIFICATION_TOKEN: '<YOUR_VERIFICATION_TOKEN>'

Ruby

Edite o ficheiro app.standard.yaml para definir as variáveis de ambiente para o ID do projeto, o tópico e o token de validação:

env_variables:
    PUBSUB_TOPIC: gaeflex_net_pubsub_auth_push_1
    # This token is used to verify that requests originate from your
    # application. It can be any sufficiently random string.
    PUBSUB_VERIFICATION_TOKEN: abc123

Revisão de código

A app de exemplo usa a biblioteca cliente do Pub/Sub.

Go

A app de exemplo usa as variáveis de ambiente que definiu no ficheiro app.yaml (PUBSUB_TOPIC e PUBSUB_VERIFICATION_TOKEN) para configuração.

As mensagens recebidas por esta instância são armazenadas numa fatia:

messages   []string

A função receiveMessagesHandler recebe mensagens enviadas por push, valida o token e adiciona a mensagem à fatia messages:


// receiveMessagesHandler validates authentication token and caches the Pub/Sub
// message received.
func (a *app) receiveMessagesHandler(w http.ResponseWriter, r *http.Request) {
	if r.Method != "POST" {
		http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed)
		return
	}

	// Verify that the request originates from the application.
	// a.pubsubVerificationToken = os.Getenv("PUBSUB_VERIFICATION_TOKEN")
	if token, ok := r.URL.Query()["token"]; !ok || len(token) != 1 || token[0] != a.pubsubVerificationToken {
		http.Error(w, "Bad token", http.StatusBadRequest)
		return
	}

	// Get the Cloud Pub/Sub-generated JWT in the "Authorization" header.
	authHeader := r.Header.Get("Authorization")
	if authHeader == "" || len(strings.Split(authHeader, " ")) != 2 {
		http.Error(w, "Missing Authorization header", http.StatusBadRequest)
		return
	}
	token := strings.Split(authHeader, " ")[1]
	// Verify and decode the JWT.
	// If you don't need to control the HTTP client used you can use the
	// convenience method idtoken.Validate instead of creating a Validator.
	v, err := idtoken.NewValidator(r.Context(), option.WithHTTPClient(a.defaultHTTPClient))
	if err != nil {
		http.Error(w, "Unable to create Validator", http.StatusBadRequest)
		return
	}
	// Please change http://example.com to match with the value you are
	// providing while creating the subscription.
	payload, err := v.Validate(r.Context(), token, "http://example.com")
	if err != nil {
		http.Error(w, fmt.Sprintf("Invalid Token: %v", err), http.StatusBadRequest)
		return
	}
	if payload.Issuer != "accounts.google.com" && payload.Issuer != "https://accounts.google.com" {
		http.Error(w, "Wrong Issuer", http.StatusBadRequest)
		return
	}

	// IMPORTANT: you should validate claim details not covered by signature
	// and audience verification above, including:
	//   - Ensure that `payload.Claims["email"]` is equal to the expected service
	//     account set up in the push subscription settings.
	//   - Ensure that `payload.Claims["email_verified"]` is set to true.
	if payload.Claims["email"] != "test-service-account-email@example.com" || payload.Claims["email_verified"] != true {
		http.Error(w, "Unexpected email identity", http.StatusBadRequest)
		return
	}

	var pr pushRequest
	if err := json.NewDecoder(r.Body).Decode(&pr); err != nil {
		http.Error(w, fmt.Sprintf("Could not decode body: %v", err), http.StatusBadRequest)
		return
	}

	a.messagesMu.Lock()
	defer a.messagesMu.Unlock()
	// Limit to ten.
	a.messages = append(a.messages, pr.Message.Data)
	if len(a.messages) > maxMessages {
		a.messages = a.messages[len(a.messages)-maxMessages:]
	}

	fmt.Fprint(w, "OK")
}

Java

Não existe nenhum exemplo disponível para este tempo de execução.

Tenha em atenção que está disponível uma app de demonstração Java no ambiente flexível.

Node.js

A app de exemplo usa os valores que define no ficheiro app.yaml para configurar as variáveis de ambiente. O controlador de pedidos push usa estes valores para confirmar que o pedido foi enviado pelo Pub/Sub e teve origem numa fonte fidedigna:

// The following environment variables are set by the `app.yaml` file when
// running on App Engine, but will need to be manually set when running locally.
var PUBSUB_VERIFICATION_TOKEN = process.env.PUBSUB_VERIFICATION_TOKEN;
var pubsub = gcloud.pubsub({
    projectId: process.env.GOOGLE_CLOUD_PROJECT
});
var topic = pubsub.topic(process.env.PUBSUB_TOPIC);

A app de exemplo mantém uma lista global para armazenar mensagens recebidas por esta instância:

// List of all messages received by this instance
var messages = [];

Este método recebe mensagens push e adiciona-as à messages lista global:

app.post('/pubsub/push', jsonBodyParser, (req, res) => {
  if (req.query.token !== PUBSUB_VERIFICATION_TOKEN) {
    res.status(400).send();
    return;
  }

  // The message is a unicode string encoded in base64.
  const message = Buffer.from(req.body.message.data, 'base64').toString(
    'utf-8'
  );

  messages.push(message);

  res.status(200).send();
});

Este método interage com a app Web do App Engine para publicar novas mensagens e apresentar mensagens recebidas:

app.get('/', (req, res) => {
  res.render('index', {messages, tokens, claims});
});

app.post('/', formBodyParser, async (req, res, next) => {
  if (!req.body.payload) {
    res.status(400).send('Missing payload');
    return;
  }

  const data = Buffer.from(req.body.payload);
  try {
    const messageId = await topic.publishMessage({data});
    res.status(200).send(`Message ${messageId} sent.`);
  } catch (error) {
    next(error);
  }
});

PHP

A app de exemplo usa os valores que define no ficheiro app.yaml para configurar variáveis de ambiente. O controlador de pedidos push usa estes valores para confirmar que o pedido foi enviado pelo Pub/Sub e originou-se numa fonte fidedigna:

runtime: php81

handlers:
- url: /pubsub\.js
  static_files: pubsub.js
  upload: pubsub\.js

A app de exemplo mantém uma lista global para armazenar mensagens recebidas por esta instância:

$messages = [];

O método pull obtém mensagens do tópico que criou e adiciona-as à lista de mensagens:

// get PULL pubsub messages
$pubsub = new PubSubClient([
    'projectId' => $projectId,
]);
$subscription = $pubsub->subscription($subscriptionName);
$pullMessages = [];
foreach ($subscription->pull(['returnImmediately' => true]) as $pullMessage) {
    $pullMessages[] = $pullMessage;
    $messages[] = $pullMessage->data();
}
// acknowledge PULL messages
if ($pullMessages) {
    $subscription->acknowledgeBatch($pullMessages);
}

O método publish publica novas mensagens no tópico:

if ($message = (string) $request->getBody()) {
    // Publish the pubsub message to the topic
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);
    $topic = $pubsub->topic($topicName);
    $topic->publish(['data' => $message]);
    return $response->withStatus(204);
}

Python

A app de exemplo usa os valores que define no ficheiro app.yaml para configurar variáveis de ambiente. O controlador de pedidos push usa estes valores para confirmar que o pedido foi enviado pelo Pub/Sub e originou-se numa fonte fidedigna:

app.config['PUBSUB_VERIFICATION_TOKEN'] = \
    os.environ['PUBSUB_VERIFICATION_TOKEN']
app.config['PUBSUB_TOPIC'] = os.environ['PUBSUB_TOPIC']

A app de exemplo mantém uma lista global para armazenar mensagens recebidas por esta instância:

MESSAGES = []

O método receive_messages_handler() recebe mensagens push e adiciona-as à MESSAGES lista global:

@app.route("/pubsub/push", methods=["POST"])
def receive_pubsub_messages_handler():
    # Verify that the request originates from the application.
    if request.args.get("token", "") != current_app.config["PUBSUB_VERIFICATION_TOKEN"]:
        return "Invalid request", 400

    envelope = json.loads(request.data.decode("utf-8"))
    payload = base64.b64decode(envelope["message"]["data"])
    MESSAGES.append(payload)

    # Returning any 2xx status indicates successful receipt of the message.
    return "OK", 200

O método index() interage com a app Web do App Engine para publicar novas mensagens e apresentar mensagens recebidas:

@app.route("/", methods=["GET", "POST"])
def index():
    if request.method == "GET":
        return render_template(
            "index.html", messages=MESSAGES, tokens=TOKENS, claims=CLAIMS
        )

    data = request.form.get("payload", "Example payload").encode("utf-8")

    # Consider initializing the publisher client outside this function
    # for better latency performance.
    publisher = pubsub_v1.PublisherClient()
    topic_path = publisher.topic_path(
        app.config["GOOGLE_CLOUD_PROJECT"], app.config["PUBSUB_TOPIC"]
    )
    future = publisher.publish(topic_path, data)
    future.result()
    return "OK", 200

Ruby

A app de exemplo usa os valores que define no ficheiro app.standard.yaml para configurar variáveis de ambiente. O controlador de pedidos push usa estes valores para confirmar que o pedido foi enviado pelo Pub/Sub e originou-se numa fonte fidedigna:

publisher = pubsub.publisher ENV["PUBSUB_TOPIC"]
PUBSUB_VERIFICATION_TOKEN = ENV["PUBSUB_VERIFICATION_TOKEN"]

A app de exemplo mantém uma lista global para armazenar mensagens recebidas por esta instância:

# List of all messages received by this instance
messages = []

Este método recebe mensagens push e adiciona-as à messages lista global:

post "/pubsub/push" do
  halt 400 if params[:token] != PUBSUB_VERIFICATION_TOKEN

  message = JSON.parse request.body.read
  payload = Base64.decode64 message["message"]["data"]

  messages.push payload
end

Este método interage com a app Web do App Engine para publicar novas mensagens e apresentar mensagens recebidas:

get "/" do
  @claims = claims
  @messages = messages

  slim :index
end

post "/publish" do
  publisher.publish params[:payload]

  redirect "/", 303
end

Executar o exemplo localmente

Quando executado localmente, pode usar a CLI Google Cloud para fornecer autenticação para usar as APIs Google Cloud. Partindo do princípio de que configurou o seu ambiente conforme descrito em Pré-requisitos, já executou o comando gcloud init, que fornece esta autenticação.

Go

Defina as variáveis de ambiente antes de iniciar a aplicação:

export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-token]
export PUBSUB_TOPIC=[your-topic]
go run pubsub.go

Java

Defina as variáveis de ambiente antes de iniciar a aplicação:

export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]

Para executar a sua aplicação localmente, use as ferramentas de desenvolvimento que usa normalmente.

Node.js

Defina as variáveis de ambiente antes de iniciar a aplicação:

export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
npm install
npm start

PHP

Instale dependências através do Composer:

composer install

Em seguida, defina as variáveis de ambiente antes de iniciar a aplicação:

export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
php -S localhost:8080

Python

Instale dependências, de preferência num ambiente virtual.

Mac OS / Linux

  1. Crie um ambiente Python isolado: 
    python3 -m venv env
source env/bin/activate
  2. Se não estiver no diretório que contém o código de exemplo, navegue para o diretório que contém o código de exemplo hello_world. Em seguida, instale as dependências: 
    cd YOUR_SAMPLE_CODE_DIR
pip install -r requirements.txt

Windows

Use o PowerShell para executar os seus pacotes Python.

  1. Localize a sua instalação do PowerShell.
  2. Clique com o botão direito do rato no atalho para o PowerShell e inicie-o como administrador.
  3. Crie um ambiente Python isolado. 
    python -m venv env
.\env\Scripts\activate
  4. Navegue para o diretório do projeto e instale as dependências. Se não estiver no diretório que contém o código de exemplo, navegue para o diretório que contém o hello_world código de exemplo. Em seguida, instale as dependências: 
    cd YOUR_SAMPLE_CODE_DIR
pip install -r requirements.txt

Em seguida, defina as variáveis de ambiente antes de iniciar a aplicação:

export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
python main.py

Ruby

Instalar dependências:

bundle install

Em seguida, defina as variáveis de ambiente antes de iniciar a aplicação:

export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
bundle exec ruby app.rb -p 8080

Simular notificações push

A aplicação pode enviar mensagens localmente, mas não consegue receber mensagens push localmente. No entanto, pode simular uma mensagem push fazendo um pedido HTTP ao ponto final de notificação push local. A amostra inclui o ficheiro sample_message.json.

Go

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

curl -H "Content-Type: application/json" -i --data @sample_message.json "localhost:8080/push-handlers/receive_messages?token=[your-token]"

Ou

http POST ":8080/push-handlers/receive_messages?token=[your-token]" < sample_message.json

Resposta:

HTTP/1.1 200 OK
Date: Tue, 13 Nov 2018 16:04:18 GMT
Content-Length: 0

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

Java

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

curl -H "Content-Type: application/json" -i --data @sample_message.json "localhost:8080/push-handlers/receive_messages?token=[your-token]"

Ou

http POST ":8080/push-handlers/receive_messages?token=[your-token]" < sample_message.json

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

Node.js

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

curl -H "Content-Type: application/json" -i --data @sample_message.json "localhost:8080/push-handlers/receive_messages?token=[your-token]"

Ou

http POST ":8080/push-handlers/receive_messages?token=[your-token]" < sample_message.json

Resposta:

HTTP/1.1 200 OK
Connection: keep-alive
Date: Mon, 31 Aug 2015 22:19:50 GMT
Transfer-Encoding: chunked
X-Powered-By: Express

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

PHP

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

curl -i --data @sample_message.json "localhost:4567/push-handlers/receive_messages?token=[your-token]"

Ou

http POST ":4567/push-handlers/receive_messages?token=[your-token]" < sample_message.json

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

Python

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

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.0 200 OK
Content-Length: 2
Content-Type: text/html; charset=utf-8
Date: Mon, 10 Aug 2015 17:52:03 GMT
Server: Werkzeug/0.10.4 Python/2.7.10

OK

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

Ruby

Pode usar curl ou um cliente httpie para enviar um pedido HTTP POST:

curl -i --data @sample_message.json "localhost:4567/push-handlers/receive_messages?token=[your-token]"

Ou

http POST ":4567/push-handlers/receive_messages?token=[your-token]" < sample_message.json

Resposta:

HTTP/1.1 200 OK
Content-Type: text/html;charset=utf-8
Content-Length: 13
X-Xss-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
Server: WEBrick/1.3.1 (Ruby/2.3.0/2015-12-25)
Date: Wed, 20 Apr 2016 20:56:23 GMT
Connection: Keep-Alive

Hello, World!

Após a conclusão do pedido, pode atualizar localhost:8080 e ver a mensagem na lista de mensagens recebidas.

Em execução no App Engine

Para implementar a app de demonstração no App Engine através da ferramenta de linha de comandos gcloud:

Go

Execute o seguinte comando a partir do diretório onde se encontra o ficheiro app.yaml:

gcloud app deploy

Java

Execute o comando gcloud a partir do diretório onde o ficheiro app.yaml se encontra:

gcloud app deploy

Para implementar a sua app através do Maven, execute o seguinte:

mvn package appengine:deploy -Dapp.deploy.projectId=PROJECT_ID

Substitua PROJECT_ID pelo ID do seu Google Cloud projeto. Se o seu ficheiro pom.xml já especificar o seu ID do projeto , não precisa de incluir a propriedade -Dapp.deploy.projectId no comando que executa.

Node.js

Execute o seguinte comando a partir do diretório onde se encontra o ficheiro app.yaml:

gcloud app deploy

PHP

Execute o seguinte comando a partir do diretório onde se encontra o ficheiro app.yaml:

gcloud app deploy

Python

Execute o seguinte comando a partir do diretório onde se encontra o ficheiro app.yaml:

gcloud app deploy

Ruby

Execute o seguinte comando a partir do diretório onde se encontra o ficheiro app.yaml:

gcloud app deploy app.standard.yaml

Já pode aceder à aplicação em https://PROJECT_ID.REGION_ID.r.appspot.com. Pode usar o formulário para enviar mensagens, mas não há garantia de que a notificação seja recebida por uma instância específica da sua aplicação. Pode enviar várias mensagens e atualizar a página para ver a mensagem recebida.