前言
嘿!欢迎。在这个高科技的世界里,数据是最重要的,不是吗?如今,数据丢失对我们大多数人来说都是一场噩梦。无论是您计算机硬盘驱动器中的数据还是您使用的应用程序的任何自定义设置数据,备份数据都应该是您优先列表中的任务之一。
作为应用程序开发人员,我认为我们应该为我们的用户提供数据备份工具。幸运的是,Android 为此目的提供了一种称为Auto Backup API的东西,并且它已经存在了一段时间。
自动备份 API
它将本地应用程序数据上传到用户 Google Drive 帐户的私人文件夹中,最大存储限制为25 MB/app。(数据不包含在用户的个人 Google Drive 配额中)。如果达到应用程序的配额限制,系统将不再备份数据。但是,完成新备份后,之前的备份将被删除。 要使用其默认配置启用它,我们只需在清单文件的应用程序标记中添加以下行。
android:allowBackup="true"
就这样..!整个过程由 Android 框架管理。
实际上还有一个要求才能使其工作。用户应在其设备上启用Google 备份和重置功能,并为其分配一个备份帐户。在 Android 9 中,此选项通常可以在Settings > Backup and reset > App data中找到。
用户的数据现在符合备份条件。
默认情况下,此数据包括文件、根目录和externalFiles目录、数据库和sharedPreferences ,但此 API 将始终忽略noBackupFiles、缓存和codeCache目录。
现在的问题是数据何时以及多久上传到 Google Drive 上?有某些触发器可以启动备份过程。
设备空闲
上次备份是在至少 24 小时前执行的
设备已连接 WiFi/移动数据(根据用户的备份配置)
自定义配置
假设我们要求仅考虑备份过程的sharedPreferences并且应忽略其余文件/目录。这可以使用清单应用程序标签的fullBackupContent属性轻松实现。
我们需要在res > xml中创建一个包含以下内容的 XML 文件(backup_rules.xml) 。这里,data.xml是sharedPreferences文件的名称。
<full-backup-content>
<include domain="sharedpref" path="data.xml" />
</full-backup-content>
然后我们可以如下指向这个文件。
android:fullBackupContent="@xml/backup_rules"
可以根据项目的要求配置规则。
<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>
<include>标记中的域将包含在备份过程中,而<exclude>标记中的域将被忽略。
<include>标记中还有一个参数requireFlags用于添加标志,这些标志基本上用于在 Android 9 设备上启用一些功能。它可以具有以下值。
clientSideEncryption:用于使用客户端机密加密备份。
deviceToDeviceTransfer:用于允许用户使用本地设备到设备传输将备份传输到另一台设备。
备份代理
Android 提供了应用程序和数据备份基础设施之间的接口。它主要与Key-Value 备份机制一起使用,当我们使用文件备份时并不真正需要它。但是,如果我们需要委托或回调来处理诸如完成备份过程和达到分配的配额限制等事件,我们可以为此目的创建一个代理。
class CustomBackupAgent : BackupAgentHelper() {
override fun onFullBackup(data: FullBackupDataOutput?) {
super.onFullBackup(data)
Log.e("BACKUP", "onFullBackup")
}
}
我们必须创建BackupAgentHelper的子类并覆盖所需的方法/事件。之后,我们需要在清单文件的应用程序标签中定义我们的代理。
android:backupAgent=".CustomBackupAgent"
测试
我们可以使用 ADB shell 命令强制备份和恢复。
备份
可以依次使用以下 4 个命令进行完整备份。
- 启用备份管理器
adb shell bmgr enabled
- 初始化并运行备份管理器
adb shell bmgr backup @pm@
adb shell bmgr run
- 执行完整备份
adb shell bmgr fullbackup <package_name>
当系统执行完整备份时,它会默认关闭应用程序,以避免在进程运行时发生任何本地数据更改。要在前台进行备份,我们可以在清单中启用一个标志。(适用于版本 >= 24)
android:backupInForeground="true"
恢复
从 Google Play 商店重新安装应用程序或使用 ADB 命令(使用 Android Studio 安装)时,数据恢复会自动完成。恢复过程在应用程序安装后和用户可用之前完成。如果我们需要使用 shell 命令强制恢复,可以按照这里的描述来完成。
这也太理论了吧?让我们启动 Android Studio 来使用这个 API。
示范
我不会让你厌烦项目创建、UI 和初始化过程,而是直接讨论这个主题的核心。我们将考虑一个非常简单的sharedPreferences用例。
我们有一个用于输入数据的编辑文本和一个用于将其保存在sharedPreferences中的按钮。这是代表整个演示的 GIF。
我在sharedPreferences中存储了一个值,执行了强制备份,卸载了应用程序,然后使用 ADB 命令重新安装了它。数据已成功恢复。
我还附加了一个代理来打印事件日志。这是 logcat 输出:
E/BACKUP: onFullBackup
避免备份
备份是非常必要的,但有一些事情不应该包含在这个过程中。例如:
-
任何特定于设备的信息,例如 FCM 令牌
- 当用户在具有相同 Google 帐户的另一台设备上安装应用程序时,恢复也将起作用。在这种情况下,我们不应该拥有之前设备的数据。
任何敏感的用户数据,例如帐户凭据
-
授权令牌
- 当用户在不同的设备上安装他的应用程序时,我们应该让他通过登录流程,而不是获取旧令牌并允许他直接使用应用程序。
-
大文件
- 我们应该始终牢记分配的配额,即 25 MB/应用程序。我们不应包含可能占用整个空间而导致备份失败的文件。
结论
Auto Backup API是 Android 框架提供的一个非常方便的工具。它非常易于使用和定制。我建议根据要求在每个项目中启用此 API。我希望你喜欢阅读这篇文章并从中获得一些有用的东西。保持安全并确保用户数据的安全!
作者:Sumeet Rukeja
链接:https://blog.mindorks.com/android-auto-backup-api