Flutter后台服务插件background_service_easy的使用

Flutter后台服务插件background_service_easy的使用

简介

background_service_easy 是一个用于管理 Flutter 应用程序后台服务的包。

开始使用

要使用此包，请在 pubspec.yaml 文件中添加 background_service_easy 作为依赖项：

dependencies:
  background_service_easy: ^1.0.0

配置

该包提供了不同的配置选项以支持 iOS 和 Android 平台。通过使用 flutter_background_service 和 flutter_background_service_android 包进行配置。

iOS

• 如果希望 iOS 执行 IosConfiguration.onBackground 回调，请启用 Xcode 中的 background_fetch 能力（可选）。
• 对于 iOS 13 及以上版本（使用 BGTaskScheduler），请将以下内容插入到 ios/Runner/Info.plist 文件中：

<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
    <string>dev.flutter.background.refresh</string>
</array>

• 您也可以使用自己的自定义标识符。在 ios/Runner/AppDelegate.swift 文件中添加以下行：

import UIKit
import Flutter
import flutter_background_service_ios // 添加这一行

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    /// 添加这一行
    SwiftFlutterBackgroundServicePlugin.taskIdentifier = "your.custom.task.identifier"

    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

Android

• 对于 Android，您可以通过 AndroidConfiguration 类进行配置。

使用

import 'package:background_service_easy/background_service_easy.dart';

void main() {
  // 构造函数自动设置为前台状态
  BackgroundService(
    onForeground: () {
      // 当服务设置为前台时的回调
    },
    onBackground: () {
      // 当服务设置为后台或应用关闭时的回调
    },
    onStop: () {
      // 当服务停止时的回调
    },
  );
}

void setToBackground() {
  BackgroundService.setToBackground(); // 默认情况下调用此方法，仅当设置为后台时才调用
}

void stop() {
  BackgroundService.stop(); // 调用此方法来停止运行的服务
}

函数

• setToForeground()：将服务设置为前台。
• setToBackground()：将服务设置为后台。
• stop()：停止服务。

示例

以下是一个完整的示例，演示如何使用 background_service_easy 包来管理 Flutter 应用程序中的后台服务：

import 'package:flutter/material.dart';
import 'package:background_service_easy/background_service_easy.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化后台服务，初始化后无需手动设置为前台
    BackgroundService(
      onForeground: () {
        // 当服务设置为前台时的回调
      },
      onBackground: () {
        // 当服务设置为后台或应用关闭时的回调
      },
      onStop: () {
        // 当服务停止时的回调
      },
    );
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    BackgroundService.setToBackground(); // 在销毁时将服务设置为后台
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('后台服务示例'),
      ),
      body: Center(
        child: Text('后台服务示例'),
      ),
    );
  }
}