Os tipos de serviço em primeiro plano são obrigatórios

Para ajudar os desenvolvedores na definição de serviços em primeiro plano voltados ao usuário, o Android 10 introduziu o atributo android:foregroundServiceType no elemento <service>.

Caso o app seja destinado ao Android 14, é necessário especificar os tipos de serviço em primeiro plano adequados. Como nas versões anteriores do Android, vários tipos podem ser combinados. Esta lista mostra os tipos de serviço em primeiro plano que você pode escolher:

Se um caso de uso no app não estiver associado a nenhum desses tipos, é recomendável migrar a lógica para usar o WorkManager ou jobs de transferência de dados iniciados pelo usuário.

Os tipos health, remoteMessaging, shortService, specialUse e systemExempted são novos no Android 14.

O snippet de código abaixo mostra um exemplo de declaração de tipo de serviço em primeiro plano no manifesto:

<manifest ...>
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
    <application ...>
      <service
          android:name=".MyMediaPlaybackService"
          android:foregroundServiceType="mediaPlayback"
          android:exported="false">
      </service>
    </application>
</manifest>

Se um app destinado ao Android 14 não definir tipos para um determinado serviço no manifesto, o sistema vai gerar uma MissingForegroundServiceTypeException ao chamar startForeground() para o serviço.

Declarar nova permissão para usar tipos de serviço em primeiro plano

Se os apps direcionados ao Android 14 usarem um serviço em primeiro plano, eles precisarão declarar uma permissão específica, com base no tipo de serviço em primeiro plano, que foi introduzida no Android 14. Essas permissões são exibidas nas seções denominadas "permissão que você precisa declarar no arquivo de manifesto" na seção de casos de uso pretendidos e aplicação de cada tipo de serviço em primeiro plano nesta página.

Todas as permissões são definidas como permissões normais e são concedidas por padrão. Os usuários não podem revogar essas permissões.

Incluir tipo de serviço em primeiro plano no momento da execução

A prática recomendada para aplicativos que iniciam serviços em primeiro plano é usar a versão ServiceCompat de startForeground() (disponível no androidx-core 1.12 e mais recentes), em que você transmite um número inteiro de bits de tipos de serviços em primeiro plano. É possível transmitir um ou mais valores de tipo.

Normalmente, você precisa declarar apenas os tipos necessários para um caso de uso específico. Isso facilita o cumprimento das expectativas do sistema para cada tipo de serviço em primeiro plano. Nos casos em que um serviço em primeiro plano é iniciado com vários tipos, ele precisa aderir aos requisitos de aplicação da plataforma de todos os tipos.

ServiceCompat.startForeground(0, notification, FOREGROUND_SERVICE_TYPE_LOCATION)

Se o tipo de serviço em primeiro plano não for especificado na chamada, o padrão será os valores definidos no manifesto. Se você não especificar o tipo de serviço no manifesto, o sistema vai gerar uma MissingForegroundServiceTypeException.

Se o serviço em primeiro plano precisar de novas permissões depois de iniciá-lo, chame startForeground() novamente e adicione os novos tipos de serviço. Por exemplo, suponha que um app de fitness execute um serviço de rastreamento de corrida que sempre precisa de informações location, mas pode ou não precisar de permissões media. Você precisa declarar location e mediaPlayback no manifesto. Se um usuário iniciar uma corrida e só quiser que a localização seja rastreada, seu app precisará chamar startForeground() e transmitir apenas o tipo de serviço location. Em seguida, se o usuário quiser começar a reproduzir o áudio, chame startForeground() novamente e transmita location|mediaPlayback.

Verificações do momento de execução no sistema

O sistema confere o uso adequado dos tipos de serviço em primeiro plano e confirma se o app solicitou as permissões de execução adequadas ou se ele usa as APIs necessárias. Por exemplo, o sistema espera que apps que usam o tipo de serviço em primeiro plano FOREGROUND_SERVICE_TYPE_LOCATION solicitem ACCESS_COARSE_LOCATION ou ACCESS_FINE_LOCATION.

Isso significa que os apps precisam seguir uma ordem muito específica de operações ao solicitar permissões do usuário e iniciar serviços em primeiro plano. As permissões precisam ser solicitadas e concedidas antes que o app tente chamar startForeground(). Os apps que solicitam as permissões adequadas após a inicialização do serviço em primeiro plano precisam mudar essa ordem de operações e solicitar a permissão antes de iniciar o serviço.

As especificidades da aplicação da plataforma aparecem nas seções denominadas "requisitos de tempo de execução" na seção de casos de uso pretendidos e aplicação para cada tipo de serviço em primeiro plano nesta página.

Casos de uso pretendidos e aplicação de cada tipo de serviço em primeiro plano

Para usar determinado tipo de serviço em primeiro plano, é necessário declarar uma permissão específica no arquivo de manifesto e atender a requisitos de execução específicos. Além disso, seu app precisa atender a um dos conjuntos de casos de uso pretendidos para esse tipo. As seções a seguir explicam a permissão que precisa ser declarada, os pré-requisitos de execução e os casos de uso pretendidos para cada tipo.

Câmera

Tipo de serviço em primeiro plano a ser declarado no manifesto em android:foregroundServiceType
camera
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_CAMERA
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_CAMERA
Pré-requisitos do ambiente de execução

Solicitar e receber a permissão de execução CAMERA

Observação:a permissão de execução CAMERA está sujeita a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano camera enquanto o app está em segundo plano, com algumas exceções. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Continue acessando a câmera em segundo plano, como em apps de chat por vídeo que permitem várias tarefas.

Dispositivo conectado

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
connectedDevice
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_CONNECTED_DEVICE
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE
Pré-requisitos do ambiente de execução

Pelo menos uma das condições a seguir precisa ser verdadeira:

Descrição

Interações com dispositivos externos que exigem uma conexão Bluetooth, NFC, IR, USB ou de rede.

Alternativas

Se o app precisar fazer transferências de dados contínuas para um dispositivo externo, use o gerenciador de dispositivo complementar. Use a API de presença de dispositivo complementar para ajudar o app a continuar em execução enquanto o dispositivo complementar está no alcance.

Se o app precisar procurar dispositivos Bluetooth, use a API de verificação de Bluetooth.

Sincronização de dados

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
dataSync
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_DATA_SYNC
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_DATA_SYNC
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Operações de transferência de dados, como as seguintes:

  • Upload ou download de dados
  • Operações de backup e restauração
  • Operações de importação ou exportação
  • Busca de dados
  • Processamento local de arquivos
  • Transferência de dados entre um dispositivo e a nuvem por uma rede
Alternativas

Consulte Alternativas aos serviços em primeiro plano de sincronização de dados para informações detalhadas.

Saúde

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
health
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_HEALTH
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_HEALTH
Pré-requisitos do ambiente de execução

Pelo menos uma das condições a seguir precisa ser verdadeira:

Observação:as permissões de leitura de BODY_SENSORS e baseadas em sensores estão sujeitas a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano health que use sensores corporais enquanto o app está em segundo plano, a menos que você tenha recebido as permissões BODY_SENSORS_BACKGROUND (nível 33 a 35 da API) ou READ_HEALTH_DATA_IN_BACKGROUND (nível 36 e mais recente da API). Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Todos os casos de uso de longa duração que oferecem suporte a apps na categoria fitness, como apps de monitoramento de atividade física.

Local

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
location
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_LOCATION
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_LOCATION
Pré-requisitos do ambiente de execução

O usuário precisa ter ativado os serviços de localização, e o app precisa ter pelo menos uma das seguintes permissões de execução:

Observação:para verificar se o usuário ativou os serviços de localização e concedeu acesso às permissões de execução, use PermissionChecker#checkSelfPermission().

Observação:as permissões de local de execução estão sujeitas a restrições de uso. Por esse motivo, não é possível criar um serviço em primeiro plano location enquanto o app está em segundo plano, a menos que você tenha recebido a permissão de execução ACCESS_BACKGROUND_LOCATION. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Casos de uso de longa duração que exigem acesso à localização, como navegação e compartilhamento de local.

Alternativas

Se o app precisar ser acionado quando o usuário chegar a locais específicos, use a API Geofence.

Mídia

要在清单中的以下位置声明的前台服务类型
android:foregroundServiceType
mediaPlayback
在清单中声明的权限
FOREGROUND_SERVICE_MEDIA_PLAYBACK
要传递给 startForeground() 的常量
FOREGROUND_SERVICE_TYPE_MEDIA_PLAYBACK
运行时前提条件
说明
在后台继续播放音频或视频。在 Android TV 上支持数字视频录制 (DVR) 功能。
替代方案
如果您要显示画中画视频,请使用画中画模式

Projeção de mídia

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
mediaProjection
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MEDIA_PROJECTION
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
Pré-requisitos do ambiente de execução

Chame o método createScreenCaptureIntent() antes de iniciar o serviço em primeiro plano. Isso mostra uma notificação de permissão ao usuário. Ele precisa conceder a permissão antes que você possa criar o serviço.

Depois de criar o serviço em primeiro plano, você pode chamar MediaProjectionManager.getMediaProjection().

Descrição

Projete conteúdo em uma tela secundária ou um dispositivo externo usando as APIs MediaProjection. Esse conteúdo não precisa ser exclusivamente de mídia.

Alternativas

Para transmitir mídia para outro dispositivo, use o SDK do Google Cast.

Microfone

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
microphone
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_MICROPHONE
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_MICROPHONE
Pré-requisitos do ambiente de execução

Solicite e receba a permissão de execução RECORD_AUDIO.

Observação:a permissão de execução RECORD_AUDIO está sujeita a restrições durante o uso. Por esse motivo, não é possível criar um serviço em primeiro plano microphone enquanto o app está em segundo plano, com algumas exceções. Para mais informações, consulte Restrições para iniciar serviços em primeiro plano que precisam de permissões em uso.

Descrição

Continue a captura do microfone em segundo plano, como gravadores de voz ou apps de comunicação.

Ligação telefônica

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
phoneCall
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_PHONE_CALL
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_PHONE_CALL
Pré-requisitos do ambiente de execução

Pelo menos uma destas condições precisa ser verdadeira:

Descrição

Continue uma chamada usando as APIs ConnectionService.

Alternativas

Se você precisar fazer ligações telefônicas, de vídeo ou VoIP, use a biblioteca android.telecom.

Considere usar CallScreeningService para filtrar ligações.

Mensagens remotas

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
remoteMessaging
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_REMOTE_MESSAGING
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_REMOTE_MESSAGING
Pré-requisitos do ambiente de execução
Nenhum
Descrição
Transferir mensagens de texto de um dispositivo para outro. Ajuda na continuidade das tarefas de mensagens de um usuário ao trocar de dispositivo.

Serviço curto

要在清单中的以下位置声明的前台服务类型
android:foregroundServiceType
shortService
在清单中声明的权限
要传递给 startForeground() 的常量
FOREGROUND_SERVICE_TYPE_SHORT_SERVICE
运行时前提条件
说明

快速完成不可中断或推迟的关键工作。

这种类型有一些独特的特征:

  • 只能持续运行一小段时间(大约 3 分钟)。
  • 不支持粘性前台服务。
  • 无法启动其他前台服务。
  • 不需要类型专用权限,不过它仍需要 FOREGROUND_SERVICE 权限。
  • 只有当应用当前符合启动新前台服务的条件时,shortService 才能更改为其他服务类型。
  • 前台服务可以随时将其类型更改为 shortService,届时超时期限将开始。

shortService 的超时时间从调用 Service.startForeground() 开始算起。应用应在发生超时之前调用 Service.stopSelf()Service.stopForeground()。否则,系统会调用新的 Service.onTimeout(),让应用有机会调用 stopSelf()stopForeground() 来停止其服务。

调用 Service.onTimeout() 后的短时间内,应用会进入缓存状态,并且不再被视为处于前台,除非用户正在主动与应用互动。应用缓存一小段时间后,服务还未停止,该应用会收到 ANR 消息。ANR 消息提及 FOREGROUND_SERVICE_TYPE_SHORT_SERVICE。出于这些原因,实现 Service.onTimeout() 回调被视为一种最佳实践。

Android 13 及更低版本中不存在 Service.onTimeout() 回调。如果同一服务在此类设备上运行,则不会出现超时,也不会发生 ANR。确保您的服务在完成处理任务后立即停止,即使它尚未收到 Service.onTimeout() 回调也是如此。

请务必注意,如果未遵循 shortService 的超时设置,即使应用还有其他有效的前台服务或其他应用生命周期进程,应用也会遇到 ANR。

如果应用对用户可见,或满足允许从后台启动前台服务的某一豁免条件,则使用 FOREGROUND_SERVICE_TYPE_SHORT_SERVICE 参数再次调用 Service.StartForeground() 会将超时时间再延长 3 分钟。如果应用对用户不可见且不满足其中一个豁免条件,则尝试启动其他前台服务(无论其类型如何)都会导致 ForegroundServiceStartNotAllowedException

即使用户为您的应用停用电池优化功能,仍然会受到 shortService FGS 的影响。

如果您启动包含 shortService 类型和另一个前台服务类型的前台服务,系统会忽略 shortService 类型声明。不过,该服务仍必须遵守其他声明类型的先决条件。如需了解详情,请参阅前台服务文档

Uso especial

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
specialUse
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_SPECIAL_USE
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_SPECIAL_USE
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Abrange todos os casos de uso de serviço em primeiro plano válidos que não são abrangidos por outros tipos de serviço em primeiro plano.

Além de declarar o tipo de serviço em primeiro plano FOREGROUND_SERVICE_TYPE_SPECIAL_USE, os desenvolvedores precisam declarar casos de uso no manifesto. Para fazer isso, especifique o elemento <property> no elemento <service>. Esses valores e os casos de uso correspondentes são analisados quando você envia o app no Google Play Console. Os casos de uso fornecidos são livres, e você precisa fornecer informações suficientes para que o revisor entenda por que você precisa usar o tipo specialUse.

<service android:name="fooService" android:foregroundServiceType="specialUse">
  <property android:name="android.app.PROPERTY_SPECIAL_USE_FGS_SUBTYPE"
      android:value="explanation_for_special_use"/>
</service>

Sistema isento

Tipo de serviço em primeiro plano a ser declarado no manifesto em
android:foregroundServiceType
systemExempted
Permissão a ser declarada no manifesto
FOREGROUND_SERVICE_SYSTEM_EXEMPTED
Constante para transmitir para startForeground()
FOREGROUND_SERVICE_TYPE_SYSTEM_EXEMPTED
Pré-requisitos do ambiente de execução
Nenhum
Descrição

Reservado para que aplicativos do sistema e integrações específicas do sistema possam continuar a usar serviços em primeiro plano.

Para usar esse tipo, um app precisa atender a pelo menos um destes critérios:

Aplicação da política do Google Play para uso de tipos de serviço em primeiro plano

Se o app for direcionado ao Android 14 ou versões mais recentes, será necessário declarar os tipos de serviço em primeiro plano na página "Conteúdo do app" do Play Console (Política > Conteúdo do app). Para mais informações sobre como declarar seus tipos de serviço em primeiro plano no Play Console, consulte Saiba mais sobre o serviço em primeiro plano e os requisitos de intent para tela cheia.