如何备份Android库的Shared Preferences数据，实现应用重装后恢复？

阿华AIGC实验室

2026-5-26

解决Android库中Shared Preferences的备份与恢复问题

我完全懂你的困扰——官方的Android Backup框架确实主要针对独立应用设计，直接在库里面用会遇到不少限制，毕竟库没有自己的备份密钥和独立的备份空间。不过咱们可以通过几个实用方案来搞定这个需求，下面给你详细说明：

方案一：自定义本地备份+跨应用存储

这个思路是把库的Shared Preferences数据导出成文件，存到宿主应用能访问的安全位置，重装后再从这个位置读取恢复。

具体步骤：

备份逻辑：
1. 获取库的SharedPreferences实例：SharedPreferences sp = context.getSharedPreferences("my_library_sp", Context.MODE_PRIVATE);
2. 把SP里的所有键值对导出成JSON或者XML格式的文件（JSON更易解析）
3. 将文件存储到宿主应用的外部私有目录（比如getExternalFilesDir(null)），这个位置不需要额外的权限（Android 10+），也不会被其他应用随意访问
恢复逻辑：
1. 启动时检测备份文件是否存在
2. 读取文件内容，解析后批量写入库的SharedPreferences

备份代码示例（用Gson解析）：

public void backupLibrarySP(Context context) {
    SharedPreferences sp = context.getSharedPreferences("my_library_sp", Context.MODE_PRIVATE);
    Map<String, ?> allEntries = sp.getAll();
    
    try {
        // 创建宿主应用下的库备份目录
        File backupDir = new File(context.getExternalFilesDir(null), "library_backups");
        if (!backupDir.exists()) {
            backupDir.mkdirs();
        }
        File backupFile = new File(backupDir, "sp_backup_" + System.currentTimeMillis() + ".json");
        
        // 用Gson把Map转成JSON写入文件
        Gson gson = new Gson();
        String json = gson.toJson(allEntries);
        FileWriter writer = new FileWriter(backupFile);
        writer.write(json);
        writer.close();
    } catch (IOException e) {
        e.printStackTrace();
        // 这里可以添加错误提示或者重试逻辑
    }
}

方案二：借力宿主应用的Android Backup框架

虽然库不能直接使用Android Backup，但咱们可以提供API让宿主应用把库的SP数据纳入它自己的备份流程里。这样库的数据就能跟着宿主应用一起享受官方备份的便利。

具体步骤：

在库中提供方法，返回需要备份的SP名称，或者指定需要备份的特定键（避免备份无关数据）
宿主应用在自己的BackupAgentHelper中添加对应的SharedPreferencesBackupHelper，把库的SP名称传进去
宿主应用完成官方Backup的配置（注册BackupAgent、在Manifest里声明等），这样库的SP数据就会和宿主数据一起备份、恢复

库提供的API示例：

public class LibraryBackupTools {
    // 返回库使用的SharedPreferences名称
    public static String getLibrarySPName() {
        return "my_library_sp";
    }
    
    // 如果只需要备份特定键，返回这些键的数组
    public static String[] getCriticalBackupKeys() {
        return new String[]{"user_session_id", "custom_settings"};
    }
}

宿主应用的BackupAgent示例：

public class AppBackupAgent extends BackupAgentHelper {
    @Override
    public void onCreate() {
        super.onCreate();
        // 备份宿主自己的SP
        SharedPreferencesBackupHelper appHelper = new SharedPreferencesBackupHelper(this, "app_main_sp");
        addHelper("app_backup", appHelper);
        
        // 备份库的SP
        SharedPreferencesBackupHelper libraryHelper = new SharedPreferencesBackupHelper(this, LibraryBackupTools.getLibrarySPName());
        addHelper("library_backup", libraryHelper);
    }
}