Flutter隔离执行函数插件isolate_functions的使用

Flutter隔离执行函数插件isolate_functions的使用

isolate_functions

isolate_functions 是一个用于在独立隔离中运行函数的 Flutter 插件。你可以传递带有参数的函数并获取返回值。

入门指南

我们使用此插件来运行耗时较长的功能，例如图像处理。该插件基于 flutter_isolate。我们简化了插件的使用方式，并增加了传递带参数和返回值的功能。

使用方法

一些计算密集型函数可能需要较长时间才能执行完毕。如果你在主线程中运行它们，UI 将会冻结。这时你可以将这些函数传递给插件，它将在独立隔离中运行这些函数。插件会返回函数执行的结果。

示例

你将传递函数及其参数（如果有的话）。函数将在隔离中运行并返回结果。

await IsolateFunctions().isolate(Calculator().addOne, paramsMapIn:{'int':1}).then((value) => print(value));

/// 计算器类。
class Calculator {
  /// 返回 [value] 加 1 的结果。
  int addOne(Map? paramsMapIn) {
    /// 耗时操作。
    var total = 0;
    for(var i = 0; i < 1000000000; i++) {
      total += i;
    }
    return paramsMapIn!['int'] + 1;
  }
}

你可以使用 quite 来简单地退出当前隔离。并且可以使用 quitAll 来退出所有隔离。

完整示例代码

以下是一个完整的示例代码，展示了如何使用 isolate_functions 插件：

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

import 'package:flutter/services.dart';
import 'package:isolate_functions/isolate_functions.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  int _valueAdded = 0;
  final _isolateFunctionsPlugin = IsolateFunctions();

  [@override](/user/override)
  void initState() {
    super.initState();
    iniValueCalculation();
  }

  // 值是在独立隔离中计算的。
  // 显然，这是一个简单的例子，但它展示了概念。
  // 你可以传递任何返回值的函数。
  Future<void> iniValueCalculation() async {
    int? value;
    // 计算消息可能会失败，所以我们使用 try/catch。
    // 我们还处理消息可能返回 null 的情况。
    // 输入为 1，你应该期望 2。
    try {
      value = await _isolateFunctionsPlugin.isolate(Calculator().addOne, paramsIn: 1) ?? 'Unknown platform version';
    } on PlatformException {
      throw 'Failed to get platform version.';
    }

    // 如果在计算过程中小部件从树中移除，则我们应该丢弃回复而不是调用
    // setState 更新不存在的外观。
    if (!mounted) return;

    setState(() {
      _valueAdded = value!;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Text('计算结果为: $_valueAdded\n'),
        ),
      ),
    );
  }
}

/// 计算器类。
class Calculator {
  /// 返回 [value] 加 1 的结果。
  int addOne(int? paramsIn) {
    /// 耗时操作。
    for (var i = 0; i < 1000000000; i++) {}
    return paramsIn! + 1;
  }
}