Background Fetch 开源项目教程

江焘钦

于 2024-08-26 09:50:02 发布

阅读量463

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00299/article/details/141554914

Background Fetch 开源项目教程

background-fetchAPI proposal for background downloading/uploading项目地址:https://gitcode.com/gh_mirrors/ba/background-fetch

项目介绍

Background Fetch 是一个用于在后台定期唤醒应用并执行任务的插件。它适用于 iOS 和 Android 平台，能够在用户不活跃时定期执行一些后台任务，例如数据同步、消息推送等。该插件的核心功能是每隔大约15分钟唤醒一次应用，并提供短暂的运行时间来执行用户定义的回调函数。

项目快速启动

安装

首先，确保你已经安装了 Flutter 和 Dart SDK。然后，在你的 Flutter 项目中添加 background_fetch 依赖：

dependencies:
  background_fetch: ^1.3.5

运行 flutter pub get 来安装依赖。

配置

在 ios/Runner/Info.plist 文件中添加以下配置：

<key>UIBackgroundModes</key>
<array>
  <string>fetch</string>
</array>

在 android/app/src/main/AndroidManifest.xml 文件中添加以下权限：

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>

初始化

在你的 Dart 代码中初始化 Background Fetch：

import 'package:background_fetch/background_fetch.dart';

void backgroundFetchHeadlessTask(String taskId) async {
  print("[BackgroundFetch] HeadlessTask: $taskId");
  BackgroundFetch.finish(taskId);
}

void main() {
  // Register the headless task.
  BackgroundFetch.registerHeadlessTask(backgroundFetchHeadlessTask);
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    // Configure BackgroundFetch.
    BackgroundFetch.configure(BackgroundFetchConfig(
      minimumFetchInterval: 15,
      stopOnTerminate: false,
      startOnBoot: true,
      enableHeadless: true,
      requiresBatteryNotLow: false,
      requiresCharging: false,
      requiresStorageNotLow: false,
      requiresDeviceIdle: false,
      requiredNetworkType: NetworkType.NONE
    ), (String taskId) async {
      // This is the fetch-event callback.
      print("[BackgroundFetch] Event received: $taskId");
      setState(() {
        // Update the state of the app.
      });
      // Finish the task.
      BackgroundFetch.finish(taskId);
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Background Fetch Example'),
        ),
        body: Center(
          child: Text('Background Fetch is running...'),
        ),
      ),
    );
  }
}