Flutter后台服务管理插件flutter_daemon的使用

flutter_daemon 是一个围绕 Flutter 守护进程协议构建的可编程接口。它允许开发者通过 JSON-RPC 协议控制运行中的 Flutter 应用程序，并提供了强类型的 API 来与守护进程进行交互。

安装

首先，需要在 pubspec.yaml 文件中添加 flutter_daemon 作为依赖：

dependencies:
  flutter_daemon: ^最新版本号

然后在 Dart 文件中导入该包：

import 'package:flutter_daemon/flutter_daemon.dart';

使用

以下是一个简单的示例，展示如何启动并控制 Flutter 应用程序：

import 'package:flutter_daemon/flutter_daemon.dart';

void main() async {
  final daemon = FlutterDaemon();

  // 监听守护进程发出的事件
  daemon.events.listen((event) {
    print('Daemon event: $event');
  });

  // 运行一个 Flutter 应用
  final application = daemon.run(
    arguments: [
      '--target', 'lib/main.dart',
      '--flavor', 'development',
    ],
    workingDirectory: '/path/to/your/flutter/app/',
  );

  // 监听特定应用程序发出的事件
  application.events.listen((event) {
    print('Application event: $event');
  });

  // 重启应用
  await (await application).restart();
  print('Restarted the application.');

  // 分离应用但不终止它
  await (await application).detach();
  print('Detached from the application.');

  // 停止应用
  await (await application).stop();
  print('Stopped the application.');

  // 处理完后正确地释放资源
  await daemon.dispose();
  print('Disposed the daemon.');
}

调用服务扩展

你可以通过守护进程调用 Flutter 和 Dart 的服务扩展：

void main() async {
  final daemon = FlutterDaemon();

  final application = daemon.run(
    arguments: [
      '--target', 'lib/main.dart',
    ],
    workingDirectory: '/path/to/your/flutter/app/',
  );

  final response = await (await application).callServiceExtension('ext.myExtension.handler', {
    'some': 'parameters'
  });

  if (response.hasError) throw response.error;
  print('Service extension result: ${response.result}');
}

重用守护进程

一旦你运行或附加了一个应用程序，直到关闭当前进程之前，守护进程不能被重用：

void main() async {
  final daemon = FlutterDaemon();

  final application1 = daemon.run(
    arguments: [
      '--target', 'lib/main.dart',
    ],
    workingDirectory: '/path/to/your/flutter/app/',
  );

  // 如果你不关闭它并尝试再次运行或附加，它将抛出 StateError。
  await daemon.close();

  final application2 = daemon.attach(
    arguments: [
      '--target', 'lib/main.dart',
    ],
    workingDirectory: '/path/to/your/flutter/app/',
  );
}

确保在完全完成对守护进程的操作后正确地处理它：

await daemon.dispose();

示例代码

以下是一个完整的示例代码，展示了如何运行、重启和停止一个 Flutter 应用：

import 'package:flutter_daemon/flutter_daemon.dart';

/// 你可以使用以下命令运行这个示例：
/// ```sh
/// # 第一个参数必须是工作目录，其余为正常的 Flutter 参数。
/// dart example/main.dart ../path/to/flutter/app/ --target lib/main.dart --flavor development
/// ```
void main(List<String> arguments) async {
  final daemon = FlutterDaemon();
  daemon.events.listen(print);

  final workingDirectory = arguments.removeAt(0);
  final application = await daemon.run(
    arguments: arguments,
    workingDirectory: workingDirectory,
  );

  print('started');
  await Future<void>.delayed(const Duration(seconds: 10));

  print('restarting');
  print(await application.restart());
  await Future<void>.delayed(const Duration(seconds: 10));

  print('stopping');
  await application.stop();
  await daemon.dispose();
}