Fazer backup dos dados de usuários com o Backup automático

O Backup automático para apps faz backup dos dados do usuário automaticamente de apps direcionados para o Android 6.0 (nível 23 da API) ou mais recente. O Android preserva os dados do app fazendo upload deles para o Google Drive, onde ficam protegidos pelas credenciais da Conta do Google do usuário. O backup tem criptografia de ponta a ponta em dispositivos com Android 9 ou versões mais recentes usando PIN, padrão ou senha. A quantidade de dados é limitada a 25 MB por usuário. Não há custos para armazenar dados de backup. Os apps podem personalizar o processo de backup ou cancelar o uso dele desativando os backups.

Para ter uma visão geral das opções de backup do Android e conferir uma orientação sobre quais dados armazenar em backup e restaurar, consulte a Visão geral do backup de dados.

Arquivos que são salvos em backup

Por padrão, o Backup automático inclui arquivos da maioria dos diretórios atribuídos ao seu app pelo sistema:

• Arquivos de preferências compartilhados

• Arquivos salvos no armazenamento interno do app e acessados por getFilesDir() ou getDir(String, int)

• Arquivos no diretório retornado por getDatabasePath(String), que também inclui os arquivos criados pela classe SQLiteOpenHelper

• Arquivos do armazenamento externo no diretório retornado por getExternalFilesDir(String)

O Backup automático exclui os arquivos nos diretórios retornados por getCacheDir(), getCodeCacheDir() e getNoBackupFilesDir(). Os arquivos salvos nesses locais são necessários apenas temporariamente e são excluídos intencionalmente das operações de backup.

É possível configurar seu app para incluir e excluir arquivos específicos. Para mais informações, consulte a seção Incluir e excluir arquivos.

Observação: o Android não trata a configuração dos componentes como dados do usuário. Se o app ativar ou desativar componentes específicos no manifesto enquanto estiver em execução, o Backup automático não salvará e restaurará a configuração automaticamente. Para preservar o estado de configuração, armazene-o em preferências compartilhadas e recupere essas preferências durante a restauração.

Local de backup

Os dados de backup são armazenados em uma pasta particular na conta do Google Drive do usuário, com o limite de 25 MB por app. Os dados salvos não contam para a cota pessoal do usuário no Google Drive. Apenas o backup mais recente é armazenado. Quando um backup é feito, todos os backups anteriores são excluídos. Os dados de backup não podem ser lidos pelo usuário ou por outros apps do dispositivo.

O usuário pode conferir uma lista dos apps que foram armazenados em backup no app Android Google Drive. Em um dispositivo com Android, o usuário pode acessar essa lista na gaveta de navegação do app Drive em Configurações > Fazer backup e redefinir.

Os backups de cada ciclo de vida de configuração do dispositivo são armazenados em conjuntos de dados separados, conforme descrito nos exemplos abaixo:

• Se o usuário tiver dois dispositivos, haverá um conjunto de dados de backup para cada dispositivo.

• Se o usuário redefinir um dispositivo para a configuração original e, em seguida, configurar o dispositivo usando a mesma conta, o backup será armazenado em um novo conjunto de dados. Os conjuntos de dados obsoletos serão automaticamente excluídos após um período de inatividade.

Cuidado: se a quantidade de dados for maior que 25 MB, o sistema chamará o método onQuotaExceeded() e não fará o backup dos dados na nuvem. O sistema verificará periodicamente se a quantidade de dados está abaixo do limite de 25 MB e voltará a fazer o Backup automático quando isso ocorrer.

Programação do backup

Os backups ocorrem automaticamente quando todas as condições a seguir são atendidas:

• O usuário ativou o backup no dispositivo. No Android 9, essa configuração está em Configurações > Sistema > Backup.
• Pelo menos 24 horas se passaram desde o último backup.
• O dispositivo está ocioso.
• O dispositivo está conectado a uma rede Wi-Fi (se o usuário do dispositivo não tiver ativado os backups com dados móveis).

Na prática, essas condições ocorrem quase todas as noites, mas um dispositivo pode nunca fazer backup (por exemplo, se ele nunca se conectar a uma rede). Para preservar a largura de banda da rede, o upload acontecerá somente se os dados do app forem alterados.

Durante o Backup automático, o sistema encerra o app para garantir que ele não esteja mais gravando no sistema de arquivos. Por padrão, o sistema de backup ignora os apps em execução em primeiro plano para evitar uma experiência ruim do usuário. É possível substituir o comportamento padrão definindo o atributo android:backupInForeground como "true".

Para simplificar os testes, o Android inclui ferramentas que permitem iniciar manualmente um backup do app. Para mais informações, consulte Testar backup e restauração.

Programação da restauração

Os dados são restaurados sempre que o app é instalado, seja pela Play Store, durante a configuração do dispositivo (quando o sistema faz download dos apps instalados anteriormente) ou executando a instalação de adb. A operação de restauração ocorre depois que o APK é instalado, mas antes que o app esteja disponível para ser iniciado pelo usuário.

Durante a execução do assistente de configuração inicial do dispositivo, o usuário encontrará uma lista de conjuntos de dados de backup disponíveis pedindo que ele escolha qual deles será usado para restaurar os dados. O conjunto de dados de backup selecionado se tornará o conjunto de dados ancestral do dispositivo. O dispositivo pode ser restaurado usando os próprios backups ou o conjunto de dados ancestral. Se os backups das duas fontes estiverem disponíveis, o dispositivo vai priorizar o próprio backup. Se o usuário não tiver passado pelo assistente de configuração, o dispositivo só poderá ser restaurado usando os próprios backups.

Para simplificar o teste, o Android inclui ferramentas que permitem iniciar manualmente uma restauração do app. Para ver mais informações, consulte Testar backup e restauração.

Ativar e desativar o backup

Os apps voltados para o Android 6.0 (API de nível 23) ou versão mais recente são incluídos automaticamente no Backup automático. No arquivo de manifesto do app, defina o valor booleano android:allowBackup para ativar ou desativar o backup. O valor padrão é true, mas recomendamos definir explicitamente o atributo no manifesto, como mostrado abaixo:

<manifest ... >
    ...
    <application android:allowBackup="true" ... >
        ...
    </application>
</manifest>

Você pode desativar os backups definindo android:allowBackup como false. Faça isso se o app puder recriar o próprio estado usando outro mecanismo ou se ele processar informações confidenciais.

Observação: para apps em execução no Android 12 (nível 31 da API) ou em versões mais recentes, especificar android:allowBackup="false" desativa os backups no Google Drive, mas não desativa as transferências entre dispositivos para o aplicativo. Para mais detalhes, consulte as informações sobre mudanças no backup e na restauração.

Incluir e excluir arquivos

Por padrão, o sistema faz backup de quase todos os dados dos apps. Para mais informações, consulte a seção sobre arquivos que são salvos em backup.

Esta seção mostra como definir regras XML personalizadas para controlar o que é salvo em backup. Caso o app seja destinado ao Android 12 (nível da API 31) ou a versões mais recentes, é necessário especificar outro conjunto de regras de backup em XML, conforme descrito nesta seção, para oferecer suporte a mudanças na restauração de backup que foram lançadas para dispositivos com essas versões do Android.

Controlar o backup no Android 11 e em versões anteriores

Siga as etapas desta seção para controlar quais arquivos são salvos em backup em dispositivos com o Android 11 (nível 30 da API) ou versões anteriores.

Importante: essas regras de backup em XML também são usadas para dispositivos com o Android 12 ou versões mais recentes caso o app seja destinado ao Android 11 ou versões anteriores. Consulte a próxima seção para conferir outro conjunto de regras de backup em XML com suporte às mudanças na restauração de backup introduzidas para dispositivos com o Android 12 ou versões mais recentes.

1. No arquivo AndroidManifest.xml, adicione o atributo android:fullBackupContent ao elemento <application>, conforme mostrado no exemplo abaixo. Esse atributo aponta para um arquivo XML que contém regras de backup.

   <application ...
    android:fullBackupContent="@xml/backup_rules">
   </application>
   

2. Crie um arquivo XML com o nome @xml/backup_rules no diretório res/xml/. Nesse arquivo, adicione regras com os elementos <include> e <exclude>. O exemplo abaixo faz backup de todas as preferências compartilhadas, exceto device.xml:

   <?xml version="1.0" encoding="utf-8"?>
   <full-backup-content>
    <include domain="sharedpref" path="."/>
    <exclude domain="sharedpref" path="device.xml"/>
   </full-backup-content>
   

Definir as condições do dispositivo necessárias para backup

Se o app salvar informações confidenciais no dispositivo, você poderá especificar as condições em que os dados do app serão incluídos no backup do usuário. Você pode adicionar as condições abaixo no Android 9 (nível 28 da API) ou versão mais recente:

• clientSideEncryption: o backup do usuário é criptografado com um segredo do lado do cliente. Essa forma de criptografia é ativada em dispositivos com o Android 9 ou versões mais recentes, desde que o usuário tenha ativado o backup no Android 9 ou mais recente e tenha definido um bloqueio de tela (PIN, padrão ou senha) para o dispositivo.
• deviceToDeviceTransfer: o usuário está transferindo o backup para outro dispositivo com suporte à transferência local entre dispositivos (por exemplo, Google Pixel).

Se você fez upgrade dos seus dispositivos de desenvolvimento para o Android 9, será necessário desativar e reativar o backup de dados depois do upgrade. Isso ocorre porque o Android só criptografa os backups com um segredo do lado do cliente depois de informar os usuários nas configurações ou no assistente de configuração.

Para declarar as condições de inclusão, defina o atributo requireFlags com os valores que você quer usar ou os valores nos elementos <include> dentro do conjunto de regras de backup:

backup_rules.xml

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    <!-- App data isn't included in user's backup
         unless client-side encryption is enabled. -->
    <include domain="file" path="."
             requireFlags="clientSideEncryption" />
</full-backup-content>

Observação: adicionar requisitos ao XML impede o funcionamento dos backups em versões anteriores do Android. Por isso, forneça recursos alternativos para os backups usados em dispositivos com o Android 8.1 (nível 27 da API) ou versões anteriores.

Se o app implementar um sistema de backup de chave-valor ou se você implementar BackupAgent, também será possível aplicar essas condições necessárias à lógica de backup fazendo uma comparação bit a bit entre um conjunto de flags de transferência do objeto BackupDataOutput e as flags FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED ou FLAG_DEVICE_TO_DEVICE_TRANSFER do seu agente de backup personalizado.

O snippet de código abaixo mostra um exemplo de uso desse método:

Kotlin

class CustomBackupAgent : BackupAgent() {
    override fun onBackup(oldState: ParcelFileDescriptor?,
            data: BackupDataOutput?, newState: ParcelFileDescriptor?) {
        if (data != null) {
            if ((data.transportFlags and
                    FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) {
                // Client-side backup encryption is enabled.
            }

            if ((data.transportFlags and FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) {
                // Local device-to-device transfer is enabled.
            }
        }
    }

    // Implementation of onRestore() here.
}

Java

public class CustomBackupAgent extends BackupAgent {
    @Override
    public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
            ParcelFileDescriptor newState) throws IOException {
        if ((data.getTransportFlags() &
                FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED) != 0) {
            // Client-side backup encryption is enabled.
        }

        if ((data.getTransportFlags() &
                FLAG_DEVICE_TO_DEVICE_TRANSFER) != 0) {
            // Local device-to-device transfer is enabled.
        }
    }

    // Implementation of onRestore() here.
}

Controlar o backup no Android 12 ou mais recente

Caso o app seja destinado ao Android 12 (nível 31 da API) ou versões mais recentes, siga as etapas desta seção para controlar quais arquivos são salvos em backup em dispositivos com essas versões.

Importante: mesmo que o app seja destinado ao Android 12 ou versões mais recentes, também será necessário especificar outro conjunto de regras de backup XML para suporte a dispositivos com o Android 11 (nível 30 da API) ou anterior

.

1. No arquivo AndroidManifest.xml, adicione o atributo android:dataExtractionRules ao elemento <application>, conforme mostrado no exemplo abaixo. Esse atributo aponta para um arquivo XML que contém regras de backup.

   <application ...
    android:dataExtractionRules="backup_rules.xml">
   </application>
   

2. Crie um arquivo XML com o nome backup_rules.xml no diretório res/xml/. Nesse arquivo, adicione regras com os elementos <include> e <exclude>. O exemplo abaixo faz backup de todas as preferências compartilhadas, exceto device.xml:

   <?xml version="1.0" encoding="utf-8"?>
   <data-extraction-rules>
    <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]>
      <include domain="sharedpref" path="."/>
      <exclude domain="sharedpref" path="device.xml"/>
    </cloud-backup>
   </data-extraction-rules>
   

Sintaxe de configuração XML

A sintaxe XML para o arquivo de configuração varia de acordo com a versão do Android em que o app é direcionado e está sendo executado.

Android 11 ou versão anterior

Use a seguinte sintaxe XML para o arquivo de configuração que controla o backup para dispositivos com o Android 11 ou versões anteriores.

<full-backup-content>
    <include domain=["file" | "database" | "sharedpref" | "external" |
                     "root"] path="string"
    requireFlags=["clientSideEncryption" | "deviceToDeviceTransfer"] />
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                     "root"] path="string" />
</full-backup-content>

Android 12 ou versão mais recente

Caso o app seja direcionado ao Android 12 (nível 31 da API) ou versões mais recentes, use a sintaxe XML mostrada abaixo para o arquivo de configuração que controla o backup em dispositivos com o Android 12 ou versões mais recentes.

<data-extraction-rules>
  <cloud-backup [disableIfNoEncryptionCapabilities="true|false"]>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
  </cloud-backup>
  <device-transfer>
    ...
    <include domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
    <exclude domain=["file" | "database" | "sharedpref" | "external" |
                        "root"] path="string"/>
    ...
  </device-transfer>
</data-extraction-rules>

Cada seção da configuração (<cloud-backup>, <device-transfer>) contém regras que se aplicam apenas a esse tipo de transferência. Essa separação permite, por exemplo, excluir um arquivo ou diretório dos backups do Google Drive enquanto ele ainda estiver sendo enviado em uma transferência entre dispositivos (D2D). Isso é útil se você tem arquivos muito grandes para fazer backup na nuvem, mas que podem ser transferidos entre dispositivos sem problemas.

Se não houver regras para um modo de backup específico, por exemplo, se a seção <device-transfer> estiver vazia, esse modo será totalmente ativado para todo o conteúdo, exceto para os diretórios no-backup e cache, conforme descrito em Arquivos armazenados em backup.

O app pode definir a flag disableIfNoEncryptionCapabilities na seção <cloud-backup> para garantir que o backup aconteça apenas se puder ser criptografado, como quando o usuário tem uma tela de bloqueio. A definição dessa restrição impedirá que os backups sejam enviados à nuvem se o dispositivo do usuário não oferecer suporte à criptografia. Porém, como as transferências D2D não são enviadas ao servidor, elas continuam funcionando até mesmo em dispositivos sem suporte à criptografia.

Sintaxe para os elementos "include" e "exclude"

Dentro das tags <full-backup-content>, <cloud-backup> e <device-transfer>, dependendo da versão do Android do dispositivo e da targetSDKVersion do app, é possível definir os elementos <include> e <exclude>:

<include>

Especifica um arquivo ou uma pasta para ser salva em backup. Por padrão, o Backup automático inclui quase todos os arquivos dos apps. Se você especificar um elemento <include>, o sistema não incluirá mais arquivos por padrão e fará o backup somente dos arquivos especificados. Para incluir vários arquivos, use vários elementos <include>.

No Android 11 e versões anteriores, esse elemento também pode conter o atributo requireFlags, discutido em mais detalhes na seção que descreve como definir requisitos condicionais para backup.

Os arquivos nos diretórios retornados por getCacheDir(), getCodeCacheDir() ou getNoBackupFilesDir() serão sempre excluídos, mesmo que você tente incluí-los.

Dica: para fazer backup de credenciais de usuário e tokens de autenticação, não os armazene em preferências compartilhadas ou um arquivo. Em vez disso, use as APIs Block Store para armazenar e gerenciar credenciais. Isso ajuda a garantir que elas sejam armazenadas com segurança e possam ser salvas em backup e restauradas com outros dados do app.

<exclude>

Especifica um arquivo ou uma pasta a serem excluídos do backup. Confira alguns arquivos que costumam ser excluídos do backup:

• Arquivos que têm identificadores específicos ao dispositivo, emitidos por um servidor ou gerados no dispositivo. Por exemplo, o Firebase Cloud Messaging (FCM) precisa gerar um token de registro toda vez que um usuário instalar o app em um novo dispositivo. Se o token de registro antigo for restaurado, o app poderá ter um comportamento inesperado.

• Arquivos relacionados à depuração do app.

• Arquivos grandes que fazem com que o app exceda a cota de backup de 25 MB.

Observação: se o arquivo de configuração especificar os dois elementos, o backup incluirá tudo o que for capturado pelos elementos <include>, exceto os recursos nomeados nos elementos <exclude>. Em outras palavras, <exclude> tem prioridade.

Cada elemento <include> e <exclude> precisa incluir os dois atributos a seguir:

domain

Especifica o local do recurso. Os valores válidos para esse atributo incluem:

• root: o diretório no sistema de arquivos em que todos os arquivos particulares pertencentes ao app são armazenados.
• file: diretórios retornados por getFilesDir().
• database: diretórios retornados por getDatabasePath(). Os bancos de dados criados pelo SQLiteOpenHelper são armazenados neste elemento.
• sharedpref: o diretório onde as SharedPreferences são armazenadas.
• external: o diretório retornado por getExternalFilesDir().

Observação: não é possível fazer backup de arquivos fora desses locais.

path

Especifica um arquivo ou uma pasta a serem incluídos ou excluídos do backup. Observe o seguinte:

• Esse atributo não oferece suporte à sintaxe de caractere curinga ou regex.
• É possível referenciar o diretório atual usando ./, mas não é possível referenciar o diretório pai, usando .., por motivos de segurança.
• Se você especificar um diretório, a regra se aplicará a todos os arquivos que estiverem nele e nos subdiretórios recursivos.

Implementar o BackupAgent

Apps que implementam o Backup automático não precisam implementar um BackupAgent. No entanto, você pode implementar um BackupAgent personalizado como uma opção. Normalmente, há duas razões para fazer isso:

• Você quer receber notificações de eventos de backup, como onRestoreFinished() e onQuotaExceeded(long, long). Esses métodos de callback são executados mesmo que o app não esteja em execução.

• Você não consegue expressar com facilidade o conjunto de arquivos que quer armazenar em backup usando regras XML. Nesses casos raros, é possível implementar um BackupAgent que substitui o método onFullBackup(FullBackupDataOutput) para armazenar o que você quer. Para manter a implementação padrão do sistema, chame o método correspondente na superclasse usando super.onFullBackup().

Se você implementar um BackupAgent, o sistema esperará, por padrão, que o app faça o backup e a restauração de chave-valor. Para usar o Backup automático com base em arquivos, defina o atributo android:fullBackupOnly como true no manifesto do app.

Durante as operações automáticas de backup e restauração, o sistema inicia o app em um modo restrito para evitar que ele acesse arquivos que possam causar conflitos e permitir que o app execute métodos de callback no BackupAgent. No modo restrito, a atividade principal do app não é iniciada automaticamente, os provedores de conteúdo não são inicializados e o Application de classe básica é instanciado, em vez de qualquer subclasse declarada no manifesto do app.

Cuidado: para evitar erros, confira se as partes do seu app que são executadas no modo restrito (principalmente o BackupAgent) não acessam provedores de conteúdo no mesmo app ou tentam transmitir o objeto Application. Se você não conseguir evitar esses padrões, implemente o Backup de chave-valor ou desative o backup completamente

.

Seu BackupAgent precisa implementar os métodos abstratos onBackup() e onRestore(), que são usados para o backup de chave-valor. No entanto, se você não quiser fazer o backup de chave-valor, poderá deixar a implementação desses métodos em branco.

Para mais informações, consulte Estender o BackupAgent.