如何实现Firestore后台同步？最优方案及Java相关示例咨询

方案选型结论 #

• 最优方案是WorkManager：作为Android Jetpack官方推出的后台任务调度组件，天然适配全版本Android的后台运行限制，自带网络状态监听、任务异常重试、任务队列持久化能力，完全匹配你需要在特定网络条件下、即使应用完全关闭也能执行同步的需求。
• 不推荐BroadcastReceiver：Android 8.0之后对静态广播做了严格限制，网络状态变更的自定义广播无法被静态注册的接收器接收，动态注册的接收器仅能在应用存活时生效，完全满足不了应用关闭时触发同步的要求。
• 不适用LiveData：LiveData是生命周期感知型的数据观测组件，仅能在应用处于前台/活跃状态下工作，进程销毁后无法运行，不适合后台同步场景。

Java实现示例 #

第一步：添加依赖 #

在模块级build.gradle中引入相关依赖：

dependencies {
    // WorkManager 依赖
    implementation "androidx.work:work-runtime:2.8.1"
    // Firestore 依赖
    implementation platform("com.google.firebase:firebase-bom:32.7.0")
    implementation "com.google.firebase:firebase-firestore"
}

第二步：实现同步Worker类 #

自定义Worker类编写Firestore同步逻辑：

import android.content.Context;
import androidx.annotation.NonNull;
import androidx.work.Worker;
import androidx.work.WorkerParameters;
import com.google.firebase.firestore.FirebaseFirestore;

public class FirestoreSyncWorker extends Worker {
    private final FirebaseFirestore db = FirebaseFirestore.getInstance();

    public FirestoreSyncWorker(@NonNull Context context, @NonNull WorkerParameters params) {
        super(context, params);
    }

    @NonNull
    @Override
    public Result doWork() {
        // 执行Firestore同步逻辑，示例为开启网络触发本地缓存与云端同步
        db.enableNetwork().addOnCompleteListener(task -> {
            if (task.isSuccessful()) {
                // 若户外场景默认优先走缓存，同步完成后可手动关闭网络
                // db.disableNetwork();
            }
        });
        // 同步成功返回success，失败可根据需求返回retry自动重试或failure标记失败
        return Result.success();
    }
}

第三步：调度同步任务 #

在Application类或应用启动入口配置任务，指定仅WiFi连接时执行：

import androidx.work.Constraints;
import androidx.work.ExistingPeriodicWorkPolicy;
import androidx.work.NetworkType;
import androidx.work.PeriodicWorkRequest;
import androidx.work.WorkManager;
import java.util.concurrent.TimeUnit;

// 配置任务约束：仅在WiFi/不计费网络下执行，需要任意可用网络可改为NetworkType.CONNECTED
Constraints constraints = new Constraints.Builder()
        .setRequiredNetworkType(NetworkType.UNMETERED)
        .build();

// 构建周期同步任务，示例为每12小时执行一次，单次触发可使用OneTimeWorkRequest
PeriodicWorkRequest syncWorkRequest =
        new PeriodicWorkRequest.Builder(FirestoreSyncWorker.class, 12, TimeUnit.HOURS)
                .setConstraints(constraints)
                .build();

// 提交任务，使用唯一标识避免重复提交
WorkManager.getInstance(context).enqueueUniquePeriodicWork(
        "FirestoreSyncTask",
        ExistingPeriodicWorkPolicy.KEEP, // 已有相同任务时保留旧任务，需要替换可改为REPLACE
        syncWorkRequest
);

可选优化配置 #

提前开启Firestore本地持久化缓存，无网络时也可正常读写本地数据，同步时会自动合并云端与本地的冲突：

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .build();
db.setFirestoreSettings(settings);

内容的提问来源于stack exchange，提问作者Nemanja