Flutter背景获取插件安装与配置完全指南

明洵柳

于 2024-10-18 12:38:53 发布

阅读量1k

点赞数 23

本文链接：https://blog.csdn.net/gitblog_01224/article/details/143048868

版权

Flutter背景获取插件安装与配置完全指南

flutter_background_fetch Periodic callbacks in the background for both IOS and Android. Includes Android Headless mechanism 项目地址: https://gitcode.com/gh_mirrors/fl/flutter_background_fetch

项目基础介绍与编程语言

项目名：Flutter Background Fetch
主导语言：Dart
适用平台：iOS & Android
作者：Transistor Software

本项目是一个简单却强大的Flutter插件，旨在实现iOS与Android应用在后台周期性唤醒功能。它允许开发者设置一个回调函数，在系统后台触发事件时执行，以此来处理诸如数据同步等任务。特别地，它引入了Android的无头(headless)机制，即使应用被终止也能继续处理后台事件。

关键技术和框架

Flutter：谷歌推出的UI工具包，用于构建响应式且美观的应用程序。
Background Fetch API：利用iOS和Android原生后台执行能力，以最低频率每15分钟唤醒一次应用（iOS限制），执行后台任务。
Android Headless Implementation：为Android提供了特殊处理方式，确保即便应用关闭后仍能响应后台事件。
灵活的调度机制：提供了自定义定时任务的能力，虽然iOS环境下性能受设备状态影响较大。

安装与配置教程

步骤一：环境准备

确保你已经安装了：

Flutter SDK
Android Studio/Android SDK
Xcode（如果你打算进行iOS开发）
最好配置了相关的环境变量。

步骤二：添加依赖

打开你的项目的pubspec.yaml文件，并加入以下依赖：

dependencies:
  background_fetch: ^1.1.3

或想要获取最新版本，可以使用Git仓库的方式：

dependencies:
  background_fetch:
    git:
      url: https://github.com/transistorsoft/flutter_background_fetch.git

完成后保存文件，执行flutter pub get命令以安装依赖。

步骤三：初始化配置

iOS 设置

在iOS端，你可能还需要在Info.plist中添加后台模式权限，如果没自动添加，手动插入：

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

Android 设置

对于Android，确保在AndroidManifest.xml文件中有接收器的声明（通常插件会在集成时自动处理，但如果缺失需手动添加）:

<receiver android:name="com.transistorsoft.flutter.backgroundfetch.FlutterBackgroundFetchBroadcastReceiver">
    <intent-filter>
        <action android:name="com.transistorsoft:flutter/backgroundfetch" />
    </intent-filter>
</receiver>

启用头文件任务（仅限Android）

若需在应用被终止状态下依然运行任务，请在你的主入口文件中注册头文件任务处理：

import 'package:background_fetch/background_fetch.dart';

void main() {
  // 在Android上启用头文件任务
  BackgroundFetch.registerHeadlessTask(headlessFetchCallback);
  runApp(MyApp());
}

// 确保该方法是VM入口点（针对Flutter >= 3.3.0），用于Android头文件任务
@pragma('vm:entry-point')
Future<void> headlessFetchCallback(HeadlessTask task) async { ... }

步骤四：基本使用示例

在你的应用代码中配置并启动Background Fetch服务：

// 配置Background Fetch
await BackgroundFetch.configure(
    BackgroundFetchConfig(
        minimumFetchInterval: 15,
        stopOnTerminate: false, // 允许应用在后台持续运行
        enableHeadless: true, // Android下启用头文件任务
        // 根据需要调整其他配置项...
    ),
    // 回调函数：每当有后台事件触发时调用
    (taskId) async {
        print("[BackgroundFetch] Event received $taskId");
        // 实现你的任务逻辑...
        // 必须在完成任务后调用finish方法
        BackgroundFetch.finish(taskId);
    },
    // 超时回调
    (taskId) async {
        print("[BackgroundFetch] TASK TIMEOUT $taskId");
        BackgroundFetch.finish(taskId); // 处理超时
    });

// 根据需要启停服务
if (_isEnabled) {
    BackgroundFetch.start();
} else {
    BackgroundFetch.stop();
}