Sua primeira mensagem push multicast usando tópicos do FCM

1. Introdução

Metas

Neste codelab, você vai aprender a instrumentar seu app multiplataforma para transmitir mensagens push multicast para vários subgrupos das instâncias do app usando tópicos do FCM.

Depois de terminar, você poderá usar a infraestrutura do FCM para gerenciar esses subgrupos, bem como mensagens push multicast sobre eles.

Visão geral da API Topics

Os tópicos são uma maneira com suporte da infraestrutura do FCM de alcançar subgrupos das instâncias do seu app com mensagens.

O FCM fornece as APIs para enviar mensagens, além de manter assinaturas nesses tópicos. O ato de associar e de associar uma instância de app a um tópico é chamado de inscrição e cancelamento de inscrição, respectivamente.

Os tópicos devem ser usados para conteúdo disponível publicamente. Por exemplo, mensagens sobre atualizações de clima. Se você quiser enviar mensagens sensíveis ao usuário, use o SDK Admin do Firebase para enviar mensagens multicast para vários dispositivos.

O multicast baseado em tópicos é otimizado para capacidade.

O que você aprenderá

• Como inscrever usuários (e cancelar a inscrição) em tópicos de um app para dispositivos móveis.
• Como enviar mensagens push multicast usando tópicos.
• Como enviar mensagens para uma combinação de tópicos usando condições de tópico.
• Como gerenciar inscrições em tópicos no servidor e fazer inscrições e cancelamentos em massa.

O que você vai criar

• Um app Android que assina/cancela a inscrição em tópicos e recebe mensagens quando elas são enviadas para os tópicos.
• Uma integração do lado do servidor usando o SDK Admin do Firebase, que será usado para enviar mensagens de tópicos pelas APIs do FCM.

O que é necessário

• Um navegador de sua escolha, como o Chrome.
• IntelliJ IDEA (em inglês) para desenvolver aplicativos Java.
  • Ative o suporte para Gradle durante a instalação.
• Ambiente de desenvolvimento integrado Android Studio para desenvolver apps Android.
• Um dispositivo para executar o aplicativo Android. Uma das seguintes opções:
  • O Android Emulator. (requer configuração no Android Studio).
  • Um dispositivo Android físico conectado ao computador e configurado para o modo de desenvolvedor.
• Uma Conta do Google para criar e gerenciar seu projeto do Firebase.

2. Etapas da configuração

Buscar o código

Clone o repositório do GitHub na linha de comando:

git clone https://github.com/firebase/quickstart-android.git fcm-codelab

O exemplo de código será clonado no diretório fcm-codelab.

cd fcm-codelab

O app inicial deste codelab está no diretório messaging da ramificação fcm-topics-codelab. Siga as etapas abaixo para acessar o código inicial. Ele contém dois diretórios, StockNewsApp e StockNewsServer. O primeiro contém o app Android inicial e o segundo tem o código inicial do lado do servidor.

git checkout fcm-topics-codelab
cd messaging/fcm-topics-codelab/starter

A versão concluída deste codelab é colocada no diretório messaging/fcm-topics-codelab/completed.

Criar um projeto do Firebase

1. No Console do Firebase, clique em Adicionar projeto, nomeie o projeto como StockNews e clique em "Continuar". Observação: lembre-se do ID do projeto do Firebase ou clique no ícone Editar para usar o ID que preferir.

2. Você pode pular a ativação do Google Analytics. Para os fins deste codelab, você não precisa dele. Clique em Continuar.
3. Clique em Criar projeto.

Parabéns! Você acabou de criar seu projeto do Firebase. Agora, você pode clicar no nome do projeto para entrar no console.

3. Configuração do app do Firebase específica para a plataforma

A maioria das mudanças de código necessárias para ativar a compatibilidade do Firebase já foi feita no projeto em que você está trabalhando. No entanto, para adicionar suporte a plataformas móveis, você precisa:

• Registrar a plataforma desejada no projeto do Firebase
• Faça o download do arquivo de configuração específico da plataforma e adicione-o ao código.

Para este codelab, vamos adicionar um app Android Firebase.

Configurar para Android

1. No Console do Firebase, selecione Configurações do projeto na parte de cima da barra de navegação à esquerda na engrenagem de configurações e clique no ícone Android em Seus apps na página Geral.

Você vai ver a seguinte caixa de diálogo:

2. O valor importante que será fornecido é o nome do pacote do Android. Defina-o como com.ticker.stocknews.
   1. O nome do pacote informado aqui precisa ser o mesmo informado no AndroidManifest.xml do código inicial de StockNewsApp. Se você quiser localizá-lo ou fazer mudanças, siga estas etapas:
      1. No diretório StockNewsApp, abra o arquivo app/src/main/AndroidManifest.xml.
      2. No elemento manifest, encontre o valor da string do atributo package. Esse valor é o nome do pacote Android.

3. Na caixa de diálogo do Firebase, cole o nome do pacote copiado no campo Nome do pacote do Android.
4. O Certificado de assinatura de depuração SHA-1 não é necessário para este codelab, porque este app não será lançado. Deixe em branco.
5. Clique em Registrar app.
6. Ainda no Console do Firebase, siga as instruções para fazer o download do arquivo de configuração google-services.json.
7. Você pode pular as etapas de configuração restantes, já que tudo está configurado no código do app inicial. Seu aplicativo estará listado na página principal do console do Firebase.
8. Copie o arquivo google-services.json (que você acabou de salvar) para o diretório messaging/fcm-topics-codelab/starter/StockNewsApp/app.

4. Criar e executar seu app

Você já pode começar a trabalhar no seu app. Primeiro, crie e execute o app.

Importar o app inicial

Inicie o Android Studio e importe o messaging/fcm-topics-codelab/starter/StockNewsApp do diretório de código inicial.

Após o carregamento do projeto, você verá um alerta informando que o Git não está rastreando todas as mudanças locais. Clique em Ignore ou no X no canto superior direito. Você não vai enviar mudanças ao repositório Git.

No canto superior esquerdo da janela do projeto, você vai encontrar algo parecido com a imagem abaixo se estiver na visualização Android. Se você estiver na visualização Project, expanda o projeto para ver a mesma coisa.

O Android Studio pode levar vários segundos para compilar o projeto em segundo plano pela primeira vez. Durante esse período, um ícone de carregamento vai aparecer na barra de status na parte de baixo do Android Studio:

Recomendamos aguardar até que isso termine antes de fazer mudanças no código. Isso permitirá que o Android Studio extraia todos os componentes necessários.

Além disso, se você receber uma mensagem que diz "Reload for language changes to take effect?" ou algo semelhante, selecione "Yes".

Configuração do emulador

Se precisar de ajuda para configurar um emulador do Android, consulte o artigo Executar seu app.

Entender o código inicial do app Android

• O código inicial é um app Android leve com funcionalidade e interface mínimas.
• Uma dependência do SDK do firebase-messaging já foi adicionada ao arquivo app/build.gradle.

• No AndroidManifest.xml, um gerenciador de callback MESSAGING_EVENT já foi adicionado.
  • Esse manipulador, StockNewsMessagingService.java, estende a classe FirebaseMessagingService, que oferece várias funcionalidades relacionadas ao Firebase Cloud Messaging. Consulte a documentação do FirebaseMessagingService para saber mais.
  
  • A função onNewToken é chamada quando o token de registro do FCM é criado ou atualizado. Consulte Como monitorar a geração de tokens para mais informações.
  • A função onMessageReceived é chamada quando uma mensagem é recebida e o app está em primeiro plano. No momento, ele simplesmente registra a mensagem recebida.
    • Consulte Receber mensagens em um app Android para saber mais sobre as diferenças entre entrega e processamento de mensagens em segundo e primeiro plano.
• Além disso, em AndroidManifest.xml, uma classe Application do Android também é fornecida com o nome StockNewsApplication.
  • Essa classe será a primeira a ser instanciada quando o app for iniciado.
  • Na função onCreate da classe StockNewsApplication, uma chamada de criação de token de registro do FCM é adicionada. Ele gera e registra um token de registro do FCM válido.
• O MainActivity.java adiciona o RecyclerView que mostra as opções de categoria de estoque.
• A SubscriptionAdapter.java implementa o RecyclerView.Adapter, que desenha a tela de seleção da categoria de estoque.
  • Cada categoria de ações tem um nome e um botão de ativação de assinatura ao lado.
  • Mudar a chave deve fazer uma chamada de assinatura / cancelamento de assinatura de tópico do FCM.
  • Você vai implementar essas chamadas nas próximas seções.
• A classe model/StockCategories.java contém uma lista de todas as categorias de ações e os nomes dos tópicos associados.

Executar o app inicial

1. Conecte o dispositivo Android ao computador ou inicie um emulador.
2. Na barra de ferramentas de cima, selecione o dispositivo ou emulador Android de destino e pressione o botão de execução.

3. A interface do app vai ficar assim:

4. O app criará um token de registro do FCM e o registrará. No entanto, nada vai mudar na interface do app.
   1. Copie e salve o token de registro do FCM, porque ele será usado nas próximas etapas.

5. Enviar uma mensagem de teste

Agora você já pode enviar uma mensagem de teste para a instância do app que configurou na última etapa.

Importar o código inicial do servidor

Inicie o IntelliJ IDEA e abra o projeto messaging/fcm-topics-codelab/starter/StockNewsServer.

A visualização do projeto na barra de navegação à esquerda vai ficar assim:

Pode levar alguns minutos para que o IntellIj IDEA crie o projeto, inclusive as dependências necessárias.

Noções básicas sobre o código inicial do servidor

• O código inicial do servidor é um projeto Java baseado no Gradle.
• O arquivo build.gradle já tem a dependência do SDK firebase-admin adicionado a ele. Esse SDK oferece acesso a várias funcionalidades de envio de mensagens do FCM.

• Por fim, há duas classes, viz:
  • FcmSender.java: essa classe contém os seguintes métodos de observação:
    • initFirebaseSDK: inicializa o SDK do firebase-admin.
    • sendMessageToFcmRegistrationToken: envia uma mensagem para um token de registro do FCM.
    • sendMessageToFcmTopic: envia uma mensagem para um tópico do FCM.
    • sendMessageToFcmTopicCondition: envia uma mensagem para uma condição de tópico do FCM.
  • FcmSubscriptionManager.java: essa classe contém métodos que permitem gerenciar as assinaturas de tópicos do lado do servidor.
    • initFirebaseSDK: inicializa o SDK do firebase-admin.
    • subscribeFcmRegistrationTokensToTopic: inscrever tokens de registro do FCM em um tópico do FCM.
    • unsubscribeFcmRegistrationTokensFromTopic: cancela a inscrição dos tokens de registro do FCM em um tópico do FCM.

Configurar o código do servidor

1. Primeiro, precisamos configurar uma conta de serviço do Firebase que permita que o SDK firebase-admin autorize chamadas para as APIs FCM.
   1. Acesse o Console do Firebase, clique no ícone de engrenagem ao lado de Visão geral do projeto na barra de navegação à esquerda e selecione Configurações do projeto.
   2. Na página de configurações, selecione Contas de serviço e clique em Criar conta de serviço.
   3. Clique no botão Gerar nova chave privada para iniciar o download automático do arquivo de chave.
   4. Renomeie o arquivo de chave como service-account.json e copie-o na pasta messaging/fcm-topics-codelab/starter/StockNewsServer/src/main/resources.
   5. O FcmSender.java e o FcmSubscriptionManager.java carregam o arquivo service-account.json do classpath usando o código abaixo.
2. Nesse ponto, o código do servidor está pronto. Executar build -> "Build Project" na barra de menus superior.

Como enviar uma mensagem de teste

1. Em FcmSender.java, localize a função sendMessageToFcmRegistrationToken e insira o token de registro do FCM que você copiou da seção Executar o app inicial no campo registrationToken.
2. Na função main, remova a marca de comentário apenas da função sendMessageToFcmRegistrationToken e clique em "Executar" para executar o código.
   1. Observe como o token de registro do FCM é definido no campo Token do objeto message.
   2. Além disso, observe como usamos a API send da interface FirebaseMessaging.

3. Isso vai enviar uma mensagem para a instância do app que você configurou na etapa anterior.
4. Quando a instância do app estiver em primeiro plano, o conteúdo da mensagem será registrado.

5. Quando a instância do app estiver em segundo plano, a mensagem vai aparecer na bandeja de notificações.

Muito bem! Você usou o SDK Admin do Firebase para enviar mensagens a uma instância de app. Saiba mais sobre como usar o SDK Admin do Firebase no seu servidor.

6. Implementar a inscrição / cancelamento de inscrição em tópicos

Nesta etapa, você vai implementar a assinatura de tópicos e ações de cancelamento de assinatura na opção "Stock Category" do app Android.

Quando um usuário do app alterna a chave para uma determinada categoria de estoque, uma chamada de assinatura de tópico ou de cancelamento da assinatura é feita.

Revisão do código

• Navegue até a classe SubscriptionAdapter.java no código do app Android e localize a classe RecyclerViewViewHolder.

• O construtor da classe configura um listener para a alternância de assinatura usando setOnCheckedChangeListener.
• Dependendo da chave de alternância, as ações de inscrição e de cancelamento de inscrição são realizadas chamando os métodos subscribeToStockCategory e unsubscribeFromStockCategory, respectivamente.
• O método setData é chamado pelo onBindViewHolder do adaptador da RecyclerView para vincular o ViewHolder à categoria de estoque apropriada.

Implementar a assinatura de tópicos

1. No método subscribeToStockCategory, você implementará a chamada para a API subscribeToTopic do objeto FirebaseMessaging. O código pode ficar assim:

   void subscribeToStockCategory() {
      // Making call to FCM for subscribing to the topic for stockCategory
     FirebaseMessaging.getInstance().subscribeToTopic(stockCategory.getTopicName()).addOnSuccessListener(
          unused -> {
            // Subscribing action successful
            Log.i(TAG, "Subscribed to topic: " + stockCategory.getTopicName());
            Toast.makeText(itemView.getContext(), "Subscribed to " + stockCategory.getCategoryName(),
                Toast.LENGTH_SHORT).show();
          });
    }

Implementar o cancelamento de assinatura em tópicos

1. Da mesma forma, na condição "else", você vai implementar a chamada para a API unsubscribeFromTopic. Algo como o seguinte:

void unsubscribeFromStockCategory() {
      // Making call to FCM for unsubscribing from the topic for stockCategory
      FirebaseMessaging.getInstance().unsubscribeFromTopic(stockCategory.getTopicName())
          .addOnSuccessListener(unused -> {
            // Unsubscribing action successful
            Log.i(TAG, "Unsubscribed from topic: " + stockCategory.getTopicName());
            Toast.makeText(itemView.getContext(), "Unsubscribed from " + stockCategory.getCategoryName(),
                Toast.LENGTH_SHORT).show();
          });
    }

Vamos fazer um teste

1. Execute o app e alterne as opções da categoria de estoque para executar as ações "Assinar" e "Cancelar inscrição". Ele será parecido com:

7. Como enviar sua primeira mensagem de tópico

Nesta etapa, você vai implementar o código do lado do servidor para enviar uma mensagem de tópico do FCM.

Implementar a integração do lado do servidor para enviar mensagens de tópico

1. No código do servidor, acesse FcmSender.java e localize o método chamado sendMessageToFcmTopic.

2. Na primeira linha, forneça o tópico do FCM para o qual deseja enviar a mensagem.
   • É uma string no formato: /topics/<Topic Name>. Por exemplo, /topics/Technology.
3. Nas próximas linhas, crie um novo objeto message (semelhante ao definido na função sendMessageToFcmRegistrationToken).
   • A diferença será que, em vez de definir o campo Token do objeto message, você definirá o campo Topic.

Message message = Message.builder()
        .putData("FOOTECH", "$1000")
        .setNotification(
            Notification.builder()
                .setTitle("Investor confidence in Tech Stocks growing")
                .setBody("Foo Tech leading the way in stock growth for Tech sector.")
                .build())
        .setTopic(topicName)
        .build();

4. Agora, adicione a chamada à instância FirebaseMessaging para enviar a mensagem (idêntica à chamada de envio feita na função sendMessageToFcmRegistrationToken).

FirebaseMessaging.getInstance().send(message);

5. Por fim, atualize a função main e ative a chamada apenas para a função sendMessageToFcmTopic.

Enviar mensagem e validar o recebimento

1. Antes de enviar a mensagem de tópico, verifique se a instância do app está inscrita no tópico para o qual você quer enviar.
   1. Isso pode ser feito ao virar o botão de alternância correspondente. Exemplo:
   
2. Agora você pode enviar a mensagem do tópico executando a função main do FcmSender.java.
3. Como antes, você poderá observar o recebimento da mensagem na instância do app.
   1. Instância do app em primeiro plano
   
   2. Instância do app em segundo plano
   
4. Bônus: tente cancelar a inscrição no tópico para o qual você enviou e reenviar a mensagem. Você vai notar que a mensagem não está sendo entregue à instância do app.

8. Como enviar sua primeira mensagem de condição de tema

Com o recurso de condição de tópico, você pode enviar mensagens para uma combinação de tópicos, o que permite definir o público-alvo de forma mais expressiva.

Por exemplo, no nosso app StockNews, considere a possibilidade de enviar mensagens a um grupo de instâncias do app inscritas nos tópicos sobre tecnologia ou automotivo. Isso pode ocorrer, por exemplo, se houver um evento notável envolvendo a Waymo.

Os tópicos permitem que você expresse sua combinação na forma de uma expressão booleana usando os seguintes operadores:

• &&: AND lógico. Por exemplo, 'Technology' in topics && 'Automotive' in topics: segmenta apenas as instâncias de app que estão inscritas em "Technology" e "Automotive Topics".
• ||: disjunção lógica. Por exemplo, 'Technology' in topics || 'Automotive' in topics: segmenta instâncias de apps que estão inscritas nos tópicos "Tecnologia" ou "Automotivo".
• () : parênteses para agrupamento. Por exemplo, 'Technology' in topics && ('Automotive' in topics || 'Energy' in topics): segmenta apenas as instâncias de apps que estão inscritas em Tecnologia e nos tópicos Automotivo ou Energia.

Leia mais sobre como criar solicitações de envio para usar essa funcionalidade.

Implementar a integração do lado do servidor para enviar a mensagem de condição do tópico

1. No código do servidor, acesse FcmSender.java e localize o método chamado sendMessageToFcmTopicCondition.

2. Na primeira linha, para a variável topicCondition, forneça a condição do tópico para o qual você quer enviar a mensagem. Você pode definir como: 'Technology' in topics && 'Automotive' in topics.
3. Nas próximas linhas, crie um novo objeto message (semelhante ao definido na função sendMessageToFcmTopic).
   1. A diferença é que, em vez de definir o campo Topic do objeto, você vai definir o campo Condition.

    Message message = Message.builder()
        .putData("FOOCAR", "$500")
        .setNotification(
            Notification.builder()
                .setTitle("Foo Car shows strong Q2 results")
                .setBody("Foo Car crosses 1B miles. Stocks rally.")
                .build())
        .setCondition(topicCondition)
        .build();

4. Agora, adicione a chamada à instância FirebaseMessaging para enviar a mensagem, que é idêntica à chamada de envio feita na função sendMessageToFcmTopic.

FirebaseMessaging.getInstance().send(message);

5. Por fim, atualize a função main e ative a chamada para a função sendMessageToFcmTopicCondition.

Enviar a mensagem e validar o recebimento

1. Antes de enviar a mensagem do tópico, assegure-se de que a instância do app atenda à condição do tópico especificada inscrevendo a instância do app nos tópicos de tecnologia e automotivo.
2. Agora você pode enviar a mensagem do tópico executando a função main do FcmSender.java.
3. Como antes, você poderá observar o recebimento da mensagem na instância do app.
   1. Instância do app em primeiro plano
   
   2. Instância do app em segundo plano
   
4. Bônus: agora você pode cancelar a inscrição no tópico "Tecnologia" e reenviar a mensagem de condição do tópico. Observe que a mensagem não é recebida pela instância do app.

9. Recapitulação

Vamos fazer um breve resumo do que você aprendeu até agora.

• Como iniciar uma assinatura / cancelamento de assinatura de um tópico em uma instância de app.
• Enviar uma mensagem ao tópico e verificar o recebimento nas instâncias de app inscritas.
• Enviar uma mensagem para uma condição de tópico e verificar o recebimento em uma instância de app que satisfaça a condição.

Na próxima seção, você vai aprender a assinar / cancelar a inscrição de instâncias de apps em tópicos sem precisar instanciar chamadas do lado do cliente.

10. Gerenciar inscrições de tópicos do lado do servidor

Até agora, neste codelab, todas as chamadas de inscrições e cancelamentos de assinatura de tópicos são iniciadas em uma instância do app.

No entanto, em alguns casos de uso, talvez você queira gerenciar as assinaturas de tópicos no lado do servidor. Por exemplo, é possível inscrever um subgrupo da sua base de usuários em um novo tópico sem esperar pelo lançamento de um app.

Nesta seção, você vai aprender a usar o SDK Admin do Firebase para assinar e cancelar a assinatura de um lote de tokens de registro do FCM em um tópico fazendo chamadas do lado do servidor.

Implementar a assinatura do lado do servidor dos tokens de registro do FCM no tópico do FCM

1. No código do servidor, vá para a classe FcmSubscriptionManager.java. Localize o método com o nome subscribeFcmRegistrationTokensToTopic. Você implementará a chamada para a API subscribeToTopic aqui.

2. Vamos inscrever a instância do app no tópico "Energia". Para isso, forneça dados para os dois campos a seguir:
   1. registrationTokens: uma lista separada por vírgulas de strings que representam os tokens de registro do FCM para os quais você quer criar assinaturas de tópicos.
   2. topicName: o nome do tema "Energia", ou seja, /topics/Energy.
3. Nas próximas linhas, implemente a chamada, seguindo estas linhas:

TopicManagementResponse response = FirebaseMessaging.getInstance().subscribeToTopic(
        registrationTokens, topicName);

4. Você pode inspecionar o TopicManagementResponse para algumas estatísticas de resultados de alto nível. Por exemplo, imprimir o número de assinaturas de tópicos criadas com sucesso usando getSuccessCount.

System.out.printf("Num tokens successfully subscribed %d", response.getSuccessCount());

5. Por fim, na função main, ative chamadas apenas para a função subscribeFcmRegistrationTokensToTopic.

Criar assinatura e enviar mensagem de tópico

1. Agora você já pode criar a assinatura do tópico e enviar uma mensagem para ele.
2. Execute a função main da classe FcmSubscriptionManager.java. Isso vai criar uma assinatura de tópico.
3. Agora, configure o código para enviar a mensagem. Semelhante a antes,
   1. No FcmSender.java, localize a função sendMessageToFcmTopic.
   2. Defina o topicName como o tópico "Energia", ou seja, /topics/Energy.
   3. Crie um objeto Message e direcione-o para o tópico usando setTopic.
   4. Por fim, atualize o método main para ativar apenas a função sendMessageToFcmTopic.
4. Execute a função main de FcmSender.java. Isso vai enviar a mensagem para a instância do app, e você poderá observá-la no app da seguinte maneira.
   1. Instância do app em primeiro plano
   
   2. Instância do app em segundo plano
   

Implementar o cancelamento da assinatura dos tokens de registro do FCM no tópico do FCM

1. Para cancelamentos de inscrição no tópico do lado do servidor, use esta API unsubscribeFromTopic. Você vai adicionar o código relevante à função unsubscribeFcmRegistrationTokensFromTopic da classe FcmSubscriptionManager.java.

2. A implementação do código de cancelamento de assinatura do lado do servidor e a validação do seu efeito enviando uma mensagem de tópico são deixadas como um exercício para você.

11. Parabéns

Parabéns! Você usou os tópicos do FCM para enviar mensagens multicast a subgrupos das instâncias do app. Isso vai ajudar a simplificar sua capacidade de alcançar os usuários com conteúdo relevante.

A seguir

Agora que você concluiu o codelab, tente outros tópicos para outras plataformas usando estes guias:

• Tópicos do FCM para iOS
• Tópicos do FCM para Web

Documentos de referência

• Referência da API do Android ( Java / Kotlin)
• Referência da API do iOS (Objective-C / Swift)
• Referência da API JavaScript ( versão 9 / versão 8)
• Referência do SDK Admin (Node.js / Java / Python / .NET)