Flutter可取消操作插件cancellable的使用

cancellable 是一个用于在任务执行过程中提供取消能力的Flutter插件。它允许通过一定的机制终止或撤销正在进行的操作。下面将详细介绍如何使用这个插件，并提供完整的示例代码。

使用方法

基本用法

首先，我们需要导入 cancellable 包，并创建一个 Cancellable 实例。然后可以将任何流（Stream）绑定到这个实例上，这样就可以在需要的时候取消这些流的操作。

import 'dart:async';
import 'package:cancellable/cancellable.dart';

void main() {
  Cancellable cancellable = Cancellable();

  // 创建一个每100毫秒发射一次的流
  Stream.periodic(Duration(milliseconds: 100), (i) => i)
      .bindCancellable(cancellable.makeCancellable()) // 将流与cancellable关联
      .listen((event) => print(event)); // 监听并打印每个事件

  // 在1秒后取消流
  Future.delayed(Duration(seconds: 1)).then((value) => cancellable.cancel());

  // 输出：
  // 0
  // 1
  // 2
  // ...
  // 9
}

使用 withRunZone 方法

withRunZone 方法允许在一个独立的区域中运行异步任务，并且可以在任务被取消时捕获特定的异常。

Cancellable cancellable2 = cancellable.makeCancellable();

try {
  await cancellable2.withRunZone(() async {
    print('withRunZone 1');
    await Future.delayed(Duration(milliseconds: 200));
    print('withRunZone 2');
    await Future.delayed(Duration(milliseconds: 200));
    print('withRunZone 3');
    await Future.delayed(Duration(milliseconds: 200));
    print('withRunZone 4');
    await Future.delayed(Duration(milliseconds: 200));
    print('withRunZone 5');
    await Future.delayed(Duration(milliseconds: 200));
    print('withRunZone 6');
  }, ignoreCancelledException: true); // 忽略取消异常
} catch (err) {
  print('xxxxxxxx  $err');
}

// 输出：
// withRunZone 1
// withRunZone 2
// withRunZone 3
// withRunZone 4
// withRunZone 5

完整示例 Demo

以下是一个更完整的示例，展示了如何结合上述两种方式来使用 cancellable 插件：

import 'dart:async';
import 'package:cancellable/cancellable.dart';

void main() async {
  // 创建一个新的可取消实例
  Cancellable cancellable = Cancellable();

  // 创建一个周期性流并绑定到cancellable
  Stream.periodic(Duration(milliseconds: 100), (i) => i)
      .bindCancellable(cancellable.makeCancellable())
      .listen((event) => print(event));

  // 设置一个延迟，在1秒后取消操作
  Future.delayed(Duration(seconds: 1)).then((value) => cancellable.cancel());

  // 另一个cancellable实例
  Cancellable cancellable2 = cancellable.makeCancellable();

  try {
    await cancellable2.withRunZone(() async {
      print('withRunZone 1');
      await Future.delayed(Duration(milliseconds: 200));
      print('withRunZone 2');
      await Future.delayed(Duration(milliseconds: 200));
      print('withRunZone 3');
      await Future.delayed(Duration(milliseconds: 200));
      print('withRunZone 4');
      await Future.delayed(Duration(milliseconds: 200));
      print('withRunZone 5');
      await Future.delayed(Duration(milliseconds: 200));
      print('withRunZone 6');
    }, ignoreCancelledException: true);
  } catch (err) {
    print('xxxxxxxx  $err');
  }
}