Flutter取消任务管理插件cancellation_token_dotnet的使用

Flutter取消任务管理插件cancellation_token_dotnet的使用

在Flutter开发中，我们经常需要处理长时间运行的任务，并且希望能够在需要时取消这些任务。cancellation_token_dotnet 插件提供了类似于 .NET 中 CancellationToken 的功能，使我们在Dart语言中能够更方便地进行任务取消操作。

安装插件

首先，在你的pubspec.yaml文件中添加该插件：

dependencies:
  cancellation_token_dotnet: ^最新版本号

然后运行flutter pub get以安装插件。

使用示例

下面是一个完整的示例代码，展示了如何使用cancellation_token_dotnet插件来管理任务的取消。

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('取消任务管理示例')),
        body: Center(
          child: RaisedButton(
            onPressed: () {
              // 创建一个CancellationTokenSource对象
              CancellationTokenSource cts = CancellationTokenSource()
                ..cancelAfter(const Duration(milliseconds: 4000));

              // 启动四个长运行任务
              Future<String> t1 = aLongRunningTask(
                const Duration(milliseconds: 250),
                "t1",
                token: cts.token,
              );
              Future<String> t2 = aLongRunningTask(
                const Duration(milliseconds: 500),
                "t2",
                token: cts.token,
              );
              Future<String> t3 = aLongRunningTask(
                const Duration(milliseconds: 750),
                "t3",
                token: cts.token,
              );
              Future<String> t4 = aLongRunningTask(
                const Duration(milliseconds: 1000),
                "t4",
                token: cts.token,
              );

              // 注册一个回调函数
              CancellationTokenRegistration ctr = cts.register(
                callback: (Object? state, CancellationToken token) {
                  print("Callback has run");
                },
                state: Object(),
              );

              // 等待所有任务完成
              try {
                await Future.wait<String>([t1, t2, t3, t4]);
              } on OperationCancelledException catch (e, st) {
                print("Operation is cancelled. Exception $e, Stack Trace: $st");
              }
            },
            child: Text('启动任务'),
          ),
        ),
      ),
    );
  }
}

// 模拟一个长时间运行的任务
Future<String> aLongRunningTask(Duration duration, String taskName, {CancellationToken token = CancellationToken.none}) async {
  print("Running Task name: $taskName");
  int iteration = 1;
  while (!token.isCancellationRequested) {
    print("Task name: $taskName, iteration: $iteration");
    await Future<void>.delayed(duration);
    ++iteration;
  }

  if (taskName == "t4") {
    token.throwIfCancellationRequested();
  }

  print("Completed Task name: $taskName");

  return taskName;
}

代码解释

1. 创建CancellationTokenSource对象：

   CancellationTokenSource cts = CancellationTokenSource()
     ..cancelAfter(const Duration(milliseconds: 4000));
   

   这里我们创建了一个CancellationTokenSource对象，并设置了一个4秒的超时时间。

2. 启动多个长运行任务：

   Future<String> t1 = aLongRunningTask(
     const Duration(milliseconds: 250),
     "t1",
     token: cts.token,
   );
   Future<String> t2 = aLongRunningTask(
     const Duration(milliseconds: 500),
     "t2",
     token: cts.token,
   );
   Future<String> t3 = aLongRunningTask(
     const Duration(milliseconds: 750),
     "t3",
     token: cts.token,
   );
   Future<String> t4 = aLongRunningTask(
     const Duration(milliseconds: 1000),
     "t4",
     token: cts.token,
   );
   

   我们启动了四个不同的长运行任务，每个任务都有自己的执行间隔时间。

3. 注册回调函数：

   CancellationTokenRegistration ctr = cts.register(
     callback: (Object? state, CancellationToken token) {
       print("Callback has run");
     },
     state: Object(),
   );
   

   我们注册了一个回调函数，当任务被取消时会触发。

4. 等待任务完成：

   try {
     await Future.wait<String>([t1, t2, t3, t4]);
   } on OperationCancelledException catch (e, st) {
     print("Operation is cancelled. Exception $e, Stack Trace: $st");
   }