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 dos tópicos
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 dissociar uma instância de app a um tópico é chamado de assinar e cancelar a assinatura, respectivamente
Os tópicos devem ser usados para conteúdo disponível publicamente. Por exemplo, mensagens sobre atualizações meteorológicas. Se você quiser enviar mensagens sensíveis ao usuário, use o SDK Admin do Firebase para fazer o multicast de mensagens em 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ópicos.
- 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 se inscreve/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.
- Ambiente de desenvolvimento integrado IntelliJ IDEA para desenvolvimento de aplicativos Java.
- Ative o suporte ao Gradle durante a instalação.
- IDE do Android Studio para desenvolvimento de apps Android.
- Um dispositivo para executar o app Android. Uma das seguintes opções:
- O Android Emulator. Exige 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 completa deste codelab está no diretório messaging/fcm-topics-codelab/completed
.
Criar um projeto do Firebase
- 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 definir o ID que preferir.
- Você pode pular a ativação do Google Analytics. Para os fins deste codelab, você não precisa dele. Clique em Continuar.
- 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 de app do Firebase específica da 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 o Android
- No Console do Firebase, selecione Configurações do projeto na parte de cima da barra de navegação à esquerda no ícone de engrenagem e clique no ícone Android em Seus apps na página Geral.
A seguinte caixa de diálogo será exibida :
- O valor importante a ser fornecido é o Nome do pacote Android. Defina-o como
com.ticker.stocknews
.- O nome do pacote informado aqui precisa ser o mesmo informado no
AndroidManifest.xml
do código inicial de StockNewsApp. Se quiser localizá-lo ou alterá-lo, siga estas etapas:- No diretório StockNewsApp, abra o arquivo
app/src/main/AndroidManifest.xml
. - No elemento
manifest
, encontre o valor da string do atributopackage
. Esse valor é o nome do pacote Android.
- No diretório StockNewsApp, abra o arquivo
- O nome do pacote informado aqui precisa ser o mesmo informado no
- Na caixa de diálogo do Firebase, cole o nome do pacote copiado no campo Nome do pacote Android.
- Você não precisa do Certificado de assinatura de depuração SHA-1 para este codelab, porque esse app não será lançado. Deixe em branco.
- Clique em Registrar app.
- Ainda no Console do Firebase, siga as instruções para fazer o download do arquivo de configuração
google-services.json
. - Você pode pular as etapas de configuração restantes, porque tudo já está configurado no código do app inicial. Seu aplicativo estará listado na página principal do console do Firebase.
- Copie o arquivo
google-services.json
que você acabou de transferir por download para o diretóriomessaging/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 enviará alterações de volta para o 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, precisará expandi-la 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 a conclusão desse processo antes de fazer alterações no código. Isso permitirá que o Android Studio extraia todos os componentes necessários.
Além disso, se você receber uma solicitação dizendo "Atualizar para que as alterações de idioma entrem em vigor?" ou algo semelhante, selecione "Sim".
Configuração do emulador
Se precisar de ajuda para configurar um emulador do Android, consulte o artigo Executar o 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 firebase-messaging já foi adicionada ao arquivo
app/build.gradle
.
- No
AndroidManifest.xml
, um gerenciador de callbackMESSAGING_EVENT
já foi adicionado.- Esse gerenciador,
StockNewsMessagingService.java
, estende a classeFirebaseMessagingService
, que fornece 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 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. Atualmente, ele apenas registra a mensagem recebida.- Consulte Receber mensagens em um app Android para saber mais sobre as diferenças entre o envio e o processamento de mensagens em segundo plano e em primeiro plano.
- Esse gerenciador,
- Além disso, em
AndroidManifest.xml
, uma classeApplication
do Android também é fornecida com o nomeStockNewsApplication
.- Essa classe será a primeira a ser instanciada quando o app for iniciado.
- Na função
onCreate
da classeStockNewsApplication
, é adicionada uma chamada de criação de token de registro do FCM. Ele vai gerar um token de registro do FCM válido e fazer o registro dele.
- O
MainActivity.java
adiciona oRecyclerView
que mostra as opções de categoria de estoque. - A
SubscriptionAdapter.java
implementa oRecyclerView.Adapter
, que desenha a tela de seleção da categoria de estoque.- Cada categoria de estoque tem um nome e um botão de ativar a assinatura ao lado.
- Mudar o botão deve fazer com que uma chamada de inscrição / cancelamento de assinatura de tópico do FCM seja feita.
- Você vai implementar essas chamadas nas próximas seções.
- A classe
model/StockCategories.java
contém uma lista de todas as categorias de estoque e os nomes dos tópicos associados.
Executar o app inicial
- Conecte o dispositivo Android ao computador ou inicie um emulador.
- Na barra de ferramentas de cima, selecione o dispositivo ou emulador Android de destino e pressione o botão de execução.
- A interface do app vai ficar assim:
- O app criará um token de registro do FCM e o registrará. No entanto, nada vai mudar na interface do app.
- 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 será semelhante a esta:
O IntellIj IDEA pode levar alguns minutos para criar seu projeto, incluindo a extração das dependências necessárias.
Entender 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:
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 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
- Primeiro, precisamos configurar uma conta de serviço do Firebase que permita que o SDK firebase-admin autorize chamadas para APIs do FCM.
- 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.
- Na página de configurações, selecione Contas de serviço e clique em Criar conta de serviço.
- Agora clique no botão Generate new private key (gerar nova chave privada) e o download automático do arquivo de chave será iniciado.
- Renomeie o arquivo de chave como
service-account.json
e copie na pastamessaging/fcm-topics-codelab/starter/StockNewsServer/src/main/resources
. - Tanto
FcmSender.java
quantoFcmSubscriptionManager.java
carregam o arquivoservice-account.json
do caminho de classe usando o código a seguir.
- Nesse ponto, o código do servidor está pronto. Execute o build -> Build Project na barra de menus de cima.
Como enviar uma mensagem de teste
- Em
FcmSender.java
, localize a funçãosendMessageToFcmRegistrationToken
e insira o token de registro do FCM que você copiou da seção Executar o app inicial no camporegistrationToken
. - Na função
main
, remova a marca de comentário apenas da funçãosendMessageToFcmRegistrationToken
e clique em "Executar" para executar o código.- Observe como o token de registro do FCM é definido no campo
Token
do objetomessage
. - Além disso, observe como usamos a API
send
da interfaceFirebaseMessaging
.
- Observe como o token de registro do FCM é definido no campo
- Isso deve enviar uma mensagem para a instância do app que você configurou na etapa anterior.
- Quando a instância do app estiver em primeiro plano, você verá o conteúdo da mensagem registrado.
- Quando a instância do app estiver em segundo plano, a mensagem será exibida na bandeja de notificações.
Ótimo, você usou o SDK Admin do Firebase para enviar mensagens a uma instância de app. Leia 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 assinaturas 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.
Revisar código
- Navegue até a classe
SubscriptionAdapter.java
no código do app Android e localize a classeRecyclerViewViewHolder
.
- 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
eunsubscribeFromStockCategory
, respectivamente. - O método
setData
é chamado peloonBindViewHolder
do adaptador da RecyclerView para vincular o ViewHolder à categoria de estoque apropriada.
Implementar assinatura de tópico
- No método
subscribeToStockCategory
, você implementará a chamada para a APIsubscribeToTopic
do objetoFirebaseMessaging
. O código pode ser parecido com este:
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
- Da mesma forma, na condição else, você implementa 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
- 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:
Inscreva-se | Cancelar inscrição |
7. Enviando sua primeira mensagem de tema
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
- No código do servidor, acesse
FcmSender.java
e localize o método chamadosendMessageToFcmTopic
.
- 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
.
- É uma string no formato:
- Nas próximas linhas, crie um novo objeto
message
(semelhante ao definido na funçãosendMessageToFcmRegistrationToken
).- A diferença será que, em vez de definir o campo
Token
do objetomessage
, você definirá o campoTopic
.
- A diferença será que, em vez de definir o campo
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();
- Agora, adicione a chamada à instância
FirebaseMessaging
para enviar a mensagem, que é idêntica à chamada de envio feita na funçãosendMessageToFcmRegistrationToken
.
FirebaseMessaging.getInstance().send(message);
- Por fim, atualize a função
main
e ative a chamada apenas para a funçãosendMessageToFcmTopic
.
Enviar mensagem e validar a confirmação
- Antes de enviar a mensagem do tópico, verifique se a instância do app está inscrita no tópico para o qual você quer enviar.
- Isso pode ser feito ao virar o botão de alternância correspondente. Exemplo:
- Agora você pode enviar a mensagem de tópico executando a função
main
deFcmSender.java
. - Como antes, deve ser possível observar o recebimento da mensagem na instância do aplicativo.
- Instância do app em primeiro plano
- Instância do app em segundo plano
- Bônus: tente cancelar a inscrição no tópico para o qual você enviou e reenviar a mensagem. Você observaria que a mensagem não está sendo entregue à instância do aplicativo.
8. Enviando sua primeira Mensagem de condição de tópico
O recurso de condição de tópico permite o envio de mensagens para uma combinação de tópicos, o que possibilita fornecer uma definição de público 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 acontecer, por exemplo, se houver um evento importante envolvendo a Waymo.
A API Topics permite expressar 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 instâncias de apps que estão inscritas em Tecnologia e em temas de automóveis 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
- De volta ao código do servidor, acesse
FcmSender.java
e localize o método com o nomesendMessageToFcmTopicCondition
.
- 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 defini-la como:'Technology' in topics && 'Automotive' in topics
. - Nas próximas linhas, crie um novo objeto
message
(semelhante ao definido na funçãosendMessageToFcmTopic
).- A diferença será que, em vez de definir o campo
Topic
do objeto, você definirá o campoCondition
.
- A diferença será que, em vez de definir o campo
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();
- Agora, adicione a chamada à instância
FirebaseMessaging
para enviar a mensagem, que é idêntica à chamada de envio feita na funçãosendMessageToFcmTopic
.
FirebaseMessaging.getInstance().send(message);
- Por fim, atualize a função
main
e ative a chamada apenas para a funçãosendMessageToFcmTopicCondition
.
Enviar a mensagem e validar o recebimento
- 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.
- Agora você pode enviar a mensagem de tópico executando a função
main
deFcmSender.java
. - Como antes, você poderá observar o recebimento da mensagem na instância do app.
- Instância do app em primeiro plano
- Instância do app em segundo plano
- Bônus: agora é possível 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 recapitular rapidamente o que você aprendeu até aqui.
- Como iniciar uma assinatura / cancelamento de assinatura de um tópico em uma instância de app.
- Enviar uma mensagem para o tópico e verificar o recebimento nas instâncias do app assinadas.
- 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 do 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 inscrição 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
- No código do servidor, vá para a classe
FcmSubscriptionManager.java
. Localize o método com o nomesubscribeFcmRegistrationTokensToTopic
. Você implementará a chamada para a APIsubscribeToTopic
aqui.
- Vamos inscrever a instância do app no tópico Energia. Para fazer isso, primeiro forneça dados para os dois campos a seguir:
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.topicName
: o nome do tópico Energia, ou seja,/topics/Energy
.
- Nas próximas linhas, implemente a chamada, seguindo estas linhas:
TopicManagementResponse response = FirebaseMessaging.getInstance().subscribeToTopic( registrationTokens, topicName);
- Você pode inspecionar o
TopicManagementResponse
para algumas estatísticas de resultados de alto nível. Por exemplo, exibir o número de assinaturas de tópicos criadas usandogetSuccessCount
.
System.out.printf("Num tokens successfully subscribed %d", response.getSuccessCount());
- Por fim, na função
main
, ative chamadas apenas para a funçãosubscribeFcmRegistrationTokensToTopic
.
Criar assinatura e enviar mensagem de tópico
- Agora você pode criar a assinatura do tópico e enviar uma mensagem para ele.
- Execute a função
main
da classeFcmSubscriptionManager.java
. Isso vai criar uma assinatura de tópico. - Agora, configure o código para enviar a mensagem. Semelhante a antes,
- No
FcmSender.java
, localize a funçãosendMessageToFcmTopic
. - Defina o
topicName
como o tópico Energia, ou seja,/topics/Energy
. - Crie um objeto
Message
e direcione-o para o tópico usandosetTopic
. - Por fim, atualize o método
main
para ativar apenas a funçãosendMessageToFcmTopic
.
- No
- Execute a função
main
deFcmSender.java
. Isso enviará a mensagem para a instância do seu aplicativo e você poderá observá-la no aplicativo da seguinte maneira.- Instância do app em primeiro plano
- Instância do app em segundo plano
Implementar o cancelamento da assinatura dos tokens de registro do FCM no tópico do FCM
- Para cancelamentos de inscrição de tópicos do lado do servidor, use esta API
unsubscribeFromTopic
. Você vai adicionar o código relevante à funçãounsubscribeFcmRegistrationTokensFromTopic
da classeFcmSubscriptionManager.java
.
- 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 ajudará a simplificar sua capacidade de alcançar os usuários de forma oportuna com conteúdo relevante.
A seguir
Agora que você concluiu o codelab, teste temas para outras plataformas usando estes guias: