通过自动备份功能备份用户数据

对于面向 Android 6.0(API 级别 23)或更高版本的系统并在相应系统中运行的应用,应用自动备份功能会自动备份应用内的用户数据。Android 通过将应用数据上传到用户的 Google 云端硬盘来保留这些数据;在 Google 云端硬盘中,这些数据受到用户的 Google 帐号凭据的保护。在搭载 Android 9 或更高版本的设备上,系统会使用设备 PIN 码、解锁图案或密码对备份进行端到端加密。数据量上限是每位用户 25 MB。存储备份数据是免费的。应用可以自定义备份流程,也可以通过停用备份选择将其停用。

如需简要了解 Android 备份选项并获得有关应备份和恢复哪些数据的指南,请参阅数据备份概览

备份的文件

默认情况下,自动备份功能会备份系统分配给应用的大多数目录中的文件:

自动备份会排除 getCacheDir()getCodeCacheDir()getNoBackupFilesDir() 返回的目录中的文件。在这些位置保存的文件只是临时需要,备份操作会特意排除这些文件。

您可以将应用配置为包含和排除特定文件。如需了解详情,请参阅包含和排除文件部分。

备份位置

备份数据存储在用户的 Google 云端硬盘账号的私人文件夹中,每个应用的数据量上限为 25 MB。保存的数据不计入用户的个人 Google 云端硬盘配额。系统仅存储最新备份。进行备份时,之前的所有备份都会被删除。用户或设备上的其他应用无法读取备份数据。

用户可以查看已在 Google 云端硬盘 Android 应用中备份的应用列表。在 Android 设备中,用户可以在 Google 云端硬盘应用的抽屉式导航栏中找到此列表,只需依次转到设置 > 备份和重置即可。

每个设备设置生命周期中的备份存储在不同的数据集内,具体如以下示例所述:

  • 如果用户拥有两个设备,每个设备都存在备份数据集。

  • 如果用户将设备恢复出厂设置,然后使用相同的帐号设置该设备,则备份会存储在新数据集中。过时数据集会在一段闲置时间后自动删除。

备份计划

满足以下所有条件时,备份会自动进行:

  • 用户已在设备上启用了备份功能。在 Android 9 中,此设置位于设置 > 系统 > 备份中。
  • 自上次备份以来已经过了至少 24 小时。
  • 设备处于闲置状态。
  • 设备已连接到 Wi-Fi 网络(如果设备用户未选择启用移动数据备份)。

在实践中,这些情况大概每天晚上都会发生,但设备可能永远不会进行备份(例如,如果设备一直未连接到网络)。为了节省网络带宽,仅在应用数据发生更改时才会进行上传。

在自动备份期间,系统会关闭应用以确保其不再向文件系统写入数据。默认情况下,备份系统会忽略在前台运行的应用,以避免糟糕的用户体验。您可以通过将 android:backupInForeground 属性设置为 true 来替换默认行为。

为了简化测试,Android 提供了可让您手动启动应用备份的工具。如需了解详情,请参阅测试备份和恢复

恢复计划

每当通过 Play 商店安装应用、在设备设置过程中安装应用(系统安装之前安装的应用时)或通过运行 adb 安装应用时,系统都会恢复数据。恢复操作会在 APK 安装完成后且应用可供用户启动之前的这段时间内发生。

在初始设备设置向导运行期间,系统会向用户显示可用的备份数据集列表,并询问用户从哪个数据集恢复数据。选择哪个备份数据集,哪个数据集就会成为设备的原始数据集。设备可以从自己的备份或原始数据集进行恢复。如果这两个来源的备份都可用,设备会优先考虑自己的备份。如果用户未完成设备设置向导,则设备只能从自己的备份进行恢复。

为了简化测试,Android 提供了可让您手动启动应用恢复的工具。如需了解详情,请参阅测试备份和恢复

启用和停用备份

面向 Android 6.0(API 级别 23)或更高版本的应用会自动参与自动备份。在应用清单文件中,设置布尔值 android:allowBackup 即可启用或停用备份。默认值为 true,但我们建议您在清单中明确设置此属性,如以下示例所示:

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

您可以通过将 android:allowBackup 设为 false 来停用备份。如果应用可以通过其他机制重新创建其状态,或者应用会处理敏感信息,则可能需要执行此操作。

包含和排除文件

默认情况下,系统会备份几乎所有应用数据。如需了解详情,请参阅备份的文件部分。

本部分介绍了如何定义自定义 XML 规则以控制备份的内容。如果您的应用以 Android 12(API 级别 31)或更高版本为目标平台,您必须另外指定一组 XML 备份规则(如本部分中所述),以支持在搭载这些 Android 版本的设备上引入的备份恢复变更

在 Android 11 及更低版本中控制备份

如需控制在搭载 Android 11(API 级别 30)或更低版本的设备上备份哪些文件,请按照本部分中的步骤操作。

  1. AndroidManifest.xml 文件中,将 android:fullBackupContent 属性添加到 <application> 元素中,如以下示例所示。此属性指向包含备份规则的 XML 文件。

    <application ...
     android:fullBackupContent="@xml/backup_rules">
    </application>
    
  2. res/xml/ 目录中创建名为 @xml/backup_rules 的 XML 文件。在此文件中,使用 <include><exclude> 元素添加规则。以下示例会备份除 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>
    

定义备份所需的设备条件

如果您的应用在设备上保存敏感信息,您可以指定用户备份在哪些条件下包含应用数据。在 Android 9(API 级别 28)或更高版本中,您可以添加以下条件:

如果您已将开发设备升级到 Android 9,则需要在升级后停用数据备份功能,然后再重新启用。这是因为只有当在“设置”或“设置向导”中通知用户后,Android 才会使用客户端密钥加密备份。

如需声明包含条件,请将 requireFlags 属性设为备份规则集内的 <include> 元素中的所选值:

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>

如果您的应用实现了键值对备份系统,或者您自行实现 BackupAgent,还可以将这些条件要求应用于备份逻辑,方法是对 BackupDataOutput 对象的传输标志集与自定义备份代理的 FLAG_CLIENT_SIDE_ENCRYPTION_ENABLEDFLAG_DEVICE_TO_DEVICE_TRANSFER 标志执行按位比较。

以下代码段显示了此方法的示例用法:

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.
}

在 Android 12 或更高版本上控制备份

如果您的应用以 Android 12(API 级别 31)或更高版本为目标平台,请按照本部分中的步骤操作,以控制在搭载 Android 12 或更高版本的设备上备份哪些文件。

  1. AndroidManifest.xml 文件中,将 android:dataExtractionRules 属性添加到 <application> 元素中,如以下示例所示。此属性指向包含备份规则的 XML 文件。

    <application ...
     android:dataExtractionRules="backup_rules.xml">
    </application>
    
  2. res/xml/ 目录中创建名为 backup_rules.xml 的 XML 文件。在此文件中,使用 <include><exclude> 元素添加规则。以下示例会备份除 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>
    

XML 配置语法

配置文件的 XML 语法因运行应用的目标 Android 版本而异。

Android 11 或更低版本

如果设备搭载的是 Android 11 或更低版本,请使用以下 XML 语法来设置控制此类设备备份的配置文件。

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

Android 12 或更高版本

如果您的应用以 Android 12(API 级别 31)或更高版本为目标平台,对于搭载 Android 12 或更高版本的设备,请使用以下 XML 语法来设置控制此类设备备份的配置文件。

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

配置的每一部分(<cloud-backup><device-transfer>)包含仅适用于该传输类型的规则。例如,这种分离可让您从 Google 云端硬盘备份中排除某个文件或目录,同时仍在设备到设备 (D2D) 传输过程中传输该文件或目录。如果您的文件因太大而无法备份到云端,但可以在设备之间顺利传输,上述做法会很有用。

如果没有针对特定备份模式的规则(例如,如果缺少 <device-transfer> 部分),则系统会为除 no-backupcache 目录之外的所有内容完全启用该模式,如备份的文件部分中所述。

您的应用可以在 <cloud-backup> 部分中设置 disableIfNoEncryptionCapabilities 标志,以确保只有在可以加密时(例如,当用户具有锁定屏幕时)备份操作才会发生。如果用户的设备无法支持加密,设置此约束条件可阻止将备份内容发送到云端,但由于不会将 D2D 传输内容发送到服务器,因此即使在不支持加密的设备上,D2D 传输也会继续运行。

用于包含和排除元素的语法

<full-backup-content><cloud-backup><device-transfer> 标记(具体取决于设备的 Android 版本和应用的 targetSDKVersion)内,您可以定义 <include><exclude> 元素:

<include>

用于指定要备份的文件或文件夹。默认情况下,自动备份会涵盖应用的几乎所有文件。如果您指定 <include> 元素,系统在默认情况下不会再包含任何文件,而仅备份指定的文件。如需包含多个文件,请使用多个 <include> 元素。

Android 11 及更低版本中,此元素还可以包含 requireFlags 属性。介绍如何定义备份条件要求的部分对此有详细论述。

系统始终会排除 getCacheDir()getCodeCacheDir()getNoBackupFilesDir() 所返回目录中的文件,即使您尝试包含这些文件也是如此。

<exclude>

指定在备份期间要排除的文件或文件夹。以下是通常会从备份中排除的一些文件:

  • 包含由服务器发出或在设备上生成的设备特定标识符的文件。例如,每当用户在新设备上安装您的应用时,Firebase Cloud Messaging (FCM) 都需要生成注册令牌。如果旧的注册令牌恢复了,应用可能会出现意外行为。

  • 与应用调试相关的文件。

  • 导致应用超过 25 MB 的备份配额的大型文件。

每个 <include><exclude> 元素都必须包含以下两个属性:

domain

用于指定资源的位置。此属性的有效值包括以下各项:

  • root:文件系统上的目录,会存储属于此应用的所有不公开文件。
  • file - getFilesDir() 返回的目录。
  • databasegetDatabasePath() 返回的目录。使用 SQLiteOpenHelper 创建的数据库存储在此处。
  • sharedpref - 存储 SharedPreferences 的目录。
  • externalgetExternalFilesDir() 返回的目录。
  • device_root - 与 root 类似,但用于设备保护存储区。
  • device_file - 与 file 类似,但用于设备保护存储区。
  • device_database - 与 database 类似,但用于设备保护存储区。
  • device_sharedpref:与 sharedpref 类似,但用于设备保护的存储空间。
path

用于指定备份要包含或排除的文件或文件夹。请注意以下几点:

  • 此属性不支持通配符或正则表达式语法。
  • 您可以使用 ./ 引用当前目录,但出于安全考虑,不可(例如使用 ..)引用父级目录。
  • 如果您指定一个目录,该规则适用于此目录及递归子目录中的所有文件。

实现 BackupAgent

实现了自动备份的应用不需要实现 BackupAgent。不过,您可以根据需要实现自定义 BackupAgent。通常,这样做有两个原因:

  • 您希望接收备份事件(例如 onRestoreFinished()onQuotaExceeded(long, long))的通知。即使应用未运行,这些回调方法也会执行。

  • 您无法使用 XML 规则轻松表达要备份的文件集。在极少数情况下,您可以实现一个替换 onFullBackup(FullBackupDataOutput)BackupAgent 来存储您想要的内容。如需保留系统的默认实现,请使用 super.onFullBackup() 在父类上调用相应的方法。

如果您实现了 BackupAgent,在默认情况下,系统会要求您的应用执行键值对备份和恢复操作。如需改用基于文件的自动备份功能,请在应用清单中将 android:fullBackupOnly 属性设置为 true

在自动备份和恢复操作执行过程中,系统会以受限模式启动应用,以防止应用访问可能导致冲突的文件,并让应用能够在其 BackupAgent 中执行回调方法。在此受限模式下,应用的主 activity 不会自动启动,系统不会初始化其 content provider,并且会实例化基类 Application,而不是应用的清单中声明的任何子类。

您的 BackupAgent 必须实现抽象方法 onBackup()onRestore(),以用于键值对备份。如果您不想执行键值对备份,则可将这些方法的实现留空。

如需了解详情,请参阅扩展 BackupAgent