如何取消Dart异步任务避免执行？现有CancelableCompleter方案失效

问题场景 #

想要实现调用stop()时终止正在执行的异步任务，但使用CancelableCompleter后，异步任务doWork()还是会完整执行完毕。现有代码如下：

class Example {
  late final completer = CancelableCompleter();
  final List<String> list;

  Example(this.list);

  void start() {
     completer.complete(doWork());
  }

  Future<void> doWork() async {
     for(final e in list) {
       await a();
       await b();
     }
     await c();
     print("end");
  }

   void stop() {
      completer.operation.cancel();
   }
}

疑问：是否需要在每个await调用前添加if(completer.isCancelled)判断？

解答 #

是的，必须手动在异步流程中添加取消检查，原因如下：

• CancelableCompleter的作用只是取消Future的回调监听，并不会主动终止正在运行的异步任务。即使调用了cancel()，doWork()里的代码还是会继续执行直到结束。

修改后的代码示例 #

在异步任务的关键节点（比如循环迭代前、异步操作前后）检查取消状态，一旦发现任务已取消就立即终止流程：

class Example {
  late final completer = CancelableCompleter();
  final List<String> list;

  Example(this.list);

  void start() {
     completer.complete(doWork());
  }

  Future<void> doWork() async {
     for(final e in list) {
       // 每次循环前检查是否取消
       if(completer.isCancelled) {
         print("任务已取消，终止执行");
         return;
       }
       await a();
       // 异步操作后检查，避免执行后续不必要步骤
       if(completer.isCancelled) {
         print("任务已取消，终止执行");
         return;
       }
       await b();
     }
     // 执行c()前检查
     if(completer.isCancelled) {
       print("任务已取消，终止执行");
       return;
     }
     await c();
     if(completer.isCancelled) return;
     print("end");
  }

   void stop() {
      completer.operation.cancel();
   }
}

优化方案 #

如果需要频繁检查取消状态，可以封装一个工具函数简化代码：

Future<void> _checkIfCancelled() {
  if(completer.isCancelled) {
    // 也可抛出自定义取消异常，供上层捕获处理
    throw StateError("任务已取消");
  }
  return Future.value();
}

然后在doWork()中调用：

Future<void> doWork() async {
  for(final e in list) {
    await _checkIfCancelled();
    await a();
    await _checkIfCancelled();
    await b();
  }
  await _checkIfCancelled();
  await c();
  await _checkIfCancelled();
  print("end");
}

本质上，Dart的原生Future不支持主动取消，所有的取消逻辑都需要开发者手动在异步流程中插入检查点，确保任务能及时终止。

内容的提问来源于stack exchange，提问作者J_Strauton