Flutter服务集成插件cobi_flutter_service的使用

Flutter服务集成插件cobi_flutter_service的使用

CobiFlutterService 插件用于在第二个隔离区执行 Dart 代码，并且可以在主隔离区和后台隔离区之间进行通信。此外，它还集成了设备的状态栏。

此插件目前仅支持 Android 平台。

使用方法

要使用此插件，请将 cobi_flutter_service 添加为 pubspec.yaml 文件中的依赖项。

dependencies:
  cobi_flutter_service: ^版本号

然后实现一个运行函数：

void serviceRunner(SendPort sendPort, ReceivePort receivePort) {
  print("Service runner executed");
}

准备您的应用以运行后台服务，初始化该插件：

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  CobiFlutterService.instance.initService(serviceRunner, true);
  runApp(MyApp());
}

启动服务可以通过调用以下方法：

CobiFlutterService.instance.startService();

对于更高级的使用情况，请查看包含的示例。

示例代码

以下是完整的示例代码，展示了如何使用 CobiFlutterService 插件。

import 'dart:async';
import 'dart:isolate';

import "package:flutter/material.dart";
import "package:cobi_flutter_service/cobi_flutter_service.dart";

// 这个函数将在后台隔离区执行
void serviceRunner(SendPort sendPort, ReceivePort receivePort) {
  debugPrint("service runner invoked");
  int counter = 0;
  
  Timer timer = Timer.periodic(Duration(seconds: 1), (timer) {
    debugPrint("counter: ${counter}");
    counter++;
  });
  
  // 声明通知内容
  CobiNotificationData notificationData = CobiNotificationData(
    title: "我的后台服务",
    subtitle: "正在运行",
    icon: CobiIconData(
      // 这是自动生成的 Flutter 图标
      name: "ic_launcher",
      type: "native",
      subtype: "mipmap"
      // 这也可以是从 Flutter 资源中的图标
      // 注意：确保遵循 Android 的通知图标指南，例如透明背景
      // name: "images/ic_launcher.png",
      // type: "asset"
    ),
    showQuitAction: true,
    quitActionCaption: "停止",
    actions: [
      CobiNotificationAction(
        name: "sendData",
        caption: "发送数据"
      ),
      CobiNotificationAction(
        name: "runExampleFunction",
        caption: "运行示例函数"
      )
    ]
  );
  // 设置通知内容
  // 如果您在 Android SDK >= 26 上使用该服务作为前台服务，则这是必需的
  CobiFlutterService.instance.setNotificationData(notificationData);
  
  receivePort.listen((message) {
    // 停止周期性执行
    if (message == "stop") {
      timer.cancel();
      debugPrint("计时器已取消");
    }
    
    if (message is Map) {
      // 这是一个自定义动作
      if (message["action"] != null) {
        if (message["action"] == "runExampleFunction") {
          exampleFunction();
        }
        // 另一个自定义动作以执行并发送一些数据到 UI 隔离区
        if (message["action"] == "sendData") {
          Map<String, dynamic> answer = {
            "action": "sendData",
            "data": {"msg":["Hello", "World"]}
          };
          sendPort.send(answer);
        }
      }
      
      // 这是一个内置事件，通知隔离区它从 UI 隔离区接收到一些数据
      if (message["event"] != null) {
        if (message["event"] == "onReceiveData") {
          debugPrint("接收到的数据: " + message["data"].toString());
        }
      }
    }
  });
}

void exampleFunction() {
  debugPrint("exampleFunction invoked");
}

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  CobiFlutterService.instance.initService(serviceRunner, false)
  .then((_) async {
    await CobiFlutterService.instance.startService();
    runApp(MyApp());
  });
}

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

class _MyAppState extends State<MyApp> {
  
  _MyAppState() {
    CobiFlutterService.instance.isServiceRunning
    .then((value) {
      setState(() {
        _isRunning = value ?? false;
      });
    });
    CobiFlutterService.instance.onServiceStateChanged.listen((isRunning) {
      setState(() {
        _isRunning = isRunning ?? false;
      });
    });
    
    CobiFlutterService.instance.onDataReceived.listen((data) {
      debugPrint("onDataReceived: " + data.toString());
      setState(() {
        _data = data;
      });
    });
    
    CobiFlutterService.instance.getAutostartOnBoot()
    .then(_setAutostartState);
  }
  
  [@override](/user/override)
  void initState() {
    super.initState();
    
    CobiFlutterService.instance.getAutostartOnBoot()
    .then(_setAutostartState);
  }
  
  _setAutostartState(bool value) {
    debugPrint("自动启动: $value");
    setState(() {
      _autostart = value;
    });
  }
  
  bool _isRunning = false;
  dynamic _data;
  bool _autostart = false;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text("CobiFlutterService 示例应用"),
        ),
        body: Container(
          padding: const EdgeInsets.all(0.0),
          child: ListView(
            padding: const EdgeInsets.all(20.0),
            children: [
              ElevatedButton(
                child: Text("启动服务"),
                onPressed: _isRunning ? null : () async {
                  await CobiFlutterService.instance.startService();
                },
              ),
              ElevatedButton(
                child: Text("停止服务"),
                onPressed: _isRunning ? () async {
                  await CobiFlutterService.instance.stopService();
                } : null,
                
              ),
              ElevatedButton(
                child: Text("切换前台模式"),
                onPressed: _isRunning ? () async {
                  bool foreground = (await CobiFlutterService.instance.getForegroundMode()) ?? false;
                  foreground = !foreground;
                  await CobiFlutterService.instance.setForegroundMode(foreground);
                } : null,
              ),
              ElevatedButton(
                child: Text("运行示例函数"),
                onPressed: _isRunning ? () async {
                  bool result = (await CobiFlutterService.instance.executeAction("runExampleFunction"))!;
                  debugPrint("函数执行成功: ${result}");
                } : null,
              ),
              ElevatedButton(
                child: Text("发送数据"),
                onPressed: _isRunning ? () async {
                  await CobiFlutterService.instance.sendData({"msg":["Hello", "World"]});
                } : null,
              ),
              ElevatedButton(
                child: Text("切换开机自启动"),
                onPressed: () async {
                  bool autostart = (await CobiFlutterService.instance.getAutostartOnBoot());
                  autostart = !autostart;
                  CobiFlutterService.instance.setAutostartOnBoot(autostart);
                  setState(() {
                    _autostart = autostart;
                  });
                }
              ),
              Text("服务正在运行: " + _isRunning.toString()),
              Text("接收到的数据: " + (_data != null ? _data.toString() : "无数据接收")),
              Text("开机自启动: " + _autostart.toString()),
            ]
          ),
        ),
      ),
    );
  }
}