使用 @capgo/capacitor-background-task

在一个 Capacitor 应用中使用命名任务、持久注册、状态检查、注销和开发触发器来周期性地在后台获取数据。该插件使用 Android WorkManager 和 iOS BGTaskScheduler。

安装

npm install @capgo/capacitor-background-task
npx cap sync

iOS 配置

添加背景处理支持到 ios/App/App/Info.plist:

<key>UIBackgroundModes</key>
<array>
  <string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
  <string>app.capgo.backgroundtask.processing</string>
</array>

然后运行：

npx cap sync ios

此插件暴露了什么

defineTask - 为一个命名任务定义 JavaScript 回调函数。
registerTaskAsync - 持久化和调度一个周期性任务。
unregisterTaskAsync - 取消一个任务。
isTaskRegisteredAsync - 检查一个任务的注册状态。
getRegisteredTasksAsync - 列出已注册的任务名称。
getStatusAsync - 检查原生背景任务的可用性。
triggerTaskWorkerForTestingAsync - 在开发中触发已注册的任务。
addExpirationListener - 在 iOS 过期一个任务时做出反应。

示例用法

在模块范围内定义任务，使其在应用程序唤醒时可用：

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

const SYNC_TASK = 'sync-offline-data';

BackgroundTask.defineTask(SYNC_TASK, async () => {
  try {
    await fetch('https://api.example.com/sync', { method: 'POST' });
    return BackgroundTaskResult.Success;
  } catch {
    return BackgroundTaskResult.Failed;
  }
});

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

检查状态和注册的任务名称：

const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, tasks });

触发开发运行：

await BackgroundTask.triggerTaskWorkerForTestingAsync();

取消任务：

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

平台说明

后台任务的调度是机会主义的，而不是精确的定时器。
Android周期性工作有15分钟的最小间隔。
iOS将 minimumInterval 视为最早开始的日期，并可能在后面运行。
在物理设备上测试iOS后台处理：

全参考

GitHub: https://github.com/Cap-go/capacitor-background-task/
文档：/docs/plugins/background-task/

继续使用@capgo/capacitor-background-task

如果您正在使用 使用@capgo/capacitor-background-task 来规划原生插件工作，连接它与 @capgo/capacitor-background-task 的实现细节在@capgo/capacitor-background-task 中 Getting Started Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor 插件由 Capgo 提供了解 Capacitor 插件由 Capgo 的实现细节添加或更新插件了解添加或更新插件的实现细节

后台任务

背景任务教程