Tutorial: Enviar notificações por push para dispositivos Android usando o Firebase SDK versão 1.0.0-preview1

Artigo
05/08/2024

Este tutorial mostra como usar os Hubs de Notificação do Azure e a versão atualizada do SDK do Firebase Cloud Messaging (FCM) (versão 1.0.0-preview1) para enviar notificações por push para um aplicativo Android. Neste tutorial, você cria um aplicativo Android em branco que recebe notificações por push usando o Firebase Cloud Messaging (FCM).

Importante

A partir de junho de 2024, as APIs herdadas do FCM não serão mais suportadas e serão desativadas. Para evitar qualquer interrupção no serviço de notificação por push, você deve migrar para o protocolo FCM v1 o mais rápido possível.

Você pode baixar o código completo para este tutorial do GitHub.

Este tutorial contém os seguintes passos:

Criar um projeto do Android Studio.
Criar um projeto do Firebase que suporte o Firebase Cloud Messaging.
Criar um hub de notificação.
Conecte seu aplicativo ao hub.
Testar a aplicação.

Pré-requisitos

Para concluir este tutorial, tem de ter uma conta ativa do Azure. Se não tiver uma conta, pode criar uma conta de avaliação gratuita em apenas alguns minutos. Para obter mais detalhes, veja Avaliação Gratuita do Azure.

Nota

As APIs do Google/Firebase não são suportadas nas regiões do Azure China.

Você também precisa dos seguintes itens:

A versão mais recente do Android Studio é recomendada.
O suporte mínimo é o nível 19 da API.

Criar um projeto do Android Studio

O primeiro passo é criar um projeto no Android Studio:

Inicie o Android Studio.
Selecione Arquivo, selecione Novo e, em seguida, Novo Projeto.
Na página Escolha seu projeto, selecione Atividade vazia e, em seguida, selecione Avançar.
Na página Configurar seu projeto, faça o seguinte:
1. Insira um nome para o aplicativo.
2. Especifique um local no qual salvar os arquivos de projeto.
3. Selecione Concluir.

Criar um projeto do Firebase que suporte o FCM

Inicie sessão na consola Firebase. Crie um novo projeto Firebase se ainda não tiver um.
Depois de criar o projeto, selecione Adicionar Firebase à aplicação Android.
Na página Adicionar Firebase ao seu aplicativo Android, faça o seguinte:
1. Para o nome do pacote Android, copie o valor do applicationId no arquivo build.gradle do aplicativo. Neste exemplo, é com.fabrikam.fcmtutorial1app.
2. Selecione Registrar aplicativo.
Selecione Download google-services.json, salve o arquivo na pasta do aplicativo do seu projeto e selecione Avançar.
Na consola da Firebase, selecione o cog do seu projeto. Em seguida, selecione Definições do projeto.
Se você não baixou o arquivo google-services.json para a pasta do aplicativo do seu projeto do Android Studio, você pode fazê-lo nesta página.
Mude para o separador Cloud Messaging .
Copie e salve a chave do servidor para uso posterior. Você usa esse valor para configurar seu hub.
Se não vir uma chave de servidor no separador Firebase Cloud Messaging , siga estes passos:
1. Selecione o menu de três pontos do cabeçalho Cloud Messaging API (Legacy) Disabled .
2. Siga o link para Gerenciar API no Google Cloud Console.
3. No Google Cloud Console, selecione o botão para ativar a API do Google Cloud Messaging.
4. Aguarde alguns minutos.
5. Volte para a guia Cloud Messaging do projeto do console do Firebase e atualize a página.
6. Veja se o cabeçalho da API do Cloud Messaging foi alterado para Cloud Messaging API (Legacy) Enabled e agora mostra uma chave do servidor.

Configurar um hub de notificação

Inicie sessão no portal do Azure.
Selecione Todos os serviços no menu à esquerda e, em seguida, selecione Hubs de Notificação na seção Dispositivos móveis . Selecione o ícone de estrela ao lado do nome do serviço para adicionar o serviço à seção FAVORITOS no menu à esquerda. Depois de adicionar Hubs de Notificação aos FAVORITOS, selecione-o no menu à esquerda.
Na página Hubs de Notificação, selecione Adicionar na barra de ferramentas.
Na página Hubs de Notificação, faça o seguinte:
1. Insira um nome no Hub de Notificação.
2. Insira um nome em Criar um novo namespace. Um namespace contém um ou mais hubs.
3. Selecione um valor na lista suspensa Local . Esse valor especifica o local no qual você deseja criar o hub.
4. Selecione um grupo de recursos existente no Grupo de Recursos ou crie um novo.
5. Selecione Criar.
Selecione Notificações (o ícone de sino) e, em seguida, selecione Ir para recurso. Você também pode atualizar a lista na página Hubs de Notificação e selecionar seu hub.
Selecione Políticas de Acesso na lista. Observe que duas cadeias de conexão estão disponíveis. Você precisará deles mais tarde para lidar com notificações push.

Importante

Não use a política DefaultFullSharedAccessSignature em seu aplicativo. Esta política deve ser usada apenas no back-end do aplicativo.

Configurar as definições do Firebase Cloud Messaging para o hub

No painel esquerdo, em Configurações, selecione Google (GCM/FCM).
Insira a chave do servidor para o projeto FCM que você salvou anteriormente.
Na barra de ferramentas, selecione Salvar.
O portal do Azure exibe uma mensagem informando que o hub foi atualizado com êxito. O botão Salvar está desativado.

Seu hub de notificação agora está configurado para funcionar com o Firebase Cloud Messaging. Você também tem as cadeias de conexão necessárias para enviar notificações para um dispositivo e registrar um aplicativo para receber notificações.

Ligar a aplicação ao Notification Hub

Adicionar serviços do Google Play para o projeto

No Android Studio, selecione Ferramentas no menu e, em seguida, selecione Gerenciador SDK.
Selecione a versão de destino do SDK do Android que é usada em seu projeto. Em seguida, selecione Mostrar detalhes do pacote.
Selecione APIs do Google, se ainda não estiver instalada.
Alterne para a guia Ferramentas do SDK. Se você ainda não instalou o Google Play Services, selecione Google Play Services conforme mostrado na imagem a seguir. Em seguida, selecione Aplicar para instalar. Anote o caminho do SDK, para utilização num passo posterior.
Se vir a caixa de diálogo Confirmar alteração, selecione OK. O instalador do componente instala os componentes solicitados. Selecione Concluir após a instalação dos componentes.
Selecione OK para fechar a caixa de diálogo Configurações para Novos Projetos .

Adicionar bibliotecas dos Hubs de Notificação do Azure

No arquivo build.gradle do aplicativo, adicione as seguintes linhas na seção dependencies:

implementation 'com.microsoft.azure:notification-hubs-android-sdk-fcm:1.1.4'
implementation 'androidx.appcompat:appcompat:1.4.1'
implementation 'com.android.volley:volley:1.2.1'

Adicione o seguinte repositório após a seção de dependências:

dependencyResolutionManagement {
 repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
 repositories {
     google()
     mavenCentral()
     maven { url 'https://example.io' }
 }
}

Adicionar suporte do Google Firebase

Adicione o seguinte plug-in no final do arquivo, se ele ainda não estiver lá.
```
apply plugin: 'com.google.gms.google-services'
```
Selecione Sincronizar agora na barra de ferramentas.

Adicionar código

Crie um objeto NotificationHubListener , que lida com a intercetação das mensagens dos Hubs de Notificação do Azure.

public class CustomNotificationListener implements NotificationListener {

   @override
   public void onNotificationReceived(Context context, RemoteMessage message) {

      /* The following notification properties are available. */
      Notification notification = message.getNotification();
      String title = notification.getTitle();
      String body = notification.getBody();
      Map<String, String> data = message.getData();

      if (message != null) {
         Log.d(TAG, "Message Notification Title: " + title);
         Log.d(TAG, "Message Notification Body: " + message);
      }

      if (data != null) {
          for (Map.Entry<String, String> entry : data.entrySet()) {
              Log.d(TAG, "key, " + entry.getKey() + " value " + entry.getValue());
          }
      }
   }
}

OnCreate No método da classe, adicione o seguinte código para iniciar o processo de inicialização dos Hubs de MainActivity Notificação quando a atividade for criada:

@Override
protected void onCreate(Bundle savedInstanceState) {

   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_main);
   NotificationHub.setListener(new CustomNotificationListener());
   NotificationHub.start(this.getApplication(), "Hub Name", "Connection-String");

}

No Android Studio, na barra de menus, selecione Compilar e, em seguida, selecione Reconstruir projeto para garantir que não há erros no código. Se você receber um erro sobre o ícone ic_launcher , remova a seguinte instrução do arquivo AndroidManifest.xml:
```
android:icon="@mipmap/ic_launcher"
```
Verifique se você tem um dispositivo virtual para executar o aplicativo. Se não tiver um, adicione um da seguinte forma:
3. Execute o aplicativo no dispositivo selecionado e verifique se ele se registra com êxito no hub.
  
  Nota
  
  O registro pode falhar durante a inicialização inicial, até que o onTokenRefresh() método do serviço de ID da instância seja chamado. Uma atualização deve iniciar um registro bem-sucedido no hub de notificação.

Enviar uma notificação de teste

Pode enviar notificações push para o seu hub de notificação a partir do portal do Azure, da seguinte forma:

No portal do Azure, na página do hub de notificação do seu hub, selecione Testar envio na seção Solução de problemas .
Em Plataformas, selecione Android.
Selecione Enviar. Você ainda não verá uma notificação no dispositivo Android porque não executou o aplicativo móvel nele. Depois de executar o aplicativo móvel, selecione o botão Enviar novamente para ver a mensagem de notificação.
Veja o resultado da operação na lista na parte inferior da página do portal.
Você vê a mensagem de notificação no seu dispositivo.

Normalmente, as notificações por push são enviadas em um serviço back-end, como aplicativos móveis ou ASP.NET usando uma biblioteca compatível. Se uma biblioteca não estiver disponível para seu back-end, você também poderá usar a API REST diretamente para enviar mensagens de notificação.

Execute o aplicativo móvel no emulador

Antes de testar as notificações por push dentro de um emulador, verifique se a imagem do emulador é compatível com o nível de API do Google escolhido para seu aplicativo. Se sua imagem não for compatível com APIs nativas do Google, você poderá obter uma SERVICE_NOT_AVAILABLE exceção.

Certifique-se também de que adicionou a sua Conta Google ao emulador em execução em Definições>. Caso contrário, suas tentativas de registro no FCM podem resultar em uma exceção AUTHENTICATION_FAILED .

Próximos passos

Neste tutorial, você usou o Firebase Cloud Messaging para transmitir notificações para todos os dispositivos Android registrados no serviço. Para saber como enviar notificações push para dispositivos específicos, avance para o tutorial seguinte:

Tutorial: Enviar notificações para usuários específicos

A seguir está uma lista de alguns outros tutoriais para enviar notificações:

Aplicativos Móveis do Azure: para obter um exemplo de como enviar notificações de um back-end de Aplicativos Móveis integrado aos Hubs de Notificação, consulte Adicionar notificações por push ao seu aplicativo iOS.
ASP.NET: Use os Hubs de Notificação para enviar notificações por push aos usuários.
SDK Java dos Hubs de Notificação do Azure: veja Como utilizar Hubs de Notificação de Java para enviar notificações de Java. Este processo foi testado em Eclipse para Programação Android.
PHP: Como utilizar os Hubs de Notificação de PHP.

Partilhar via