如何处理Dart中被误标记为async的void函数的错误？

当用户误将void Function()类型的回调标记为async后，该函数实际会返回一个Future<void>，但受限于签名无法被直接获取。异步函数抛出的异常会被封装进Future中，若不等待这个Future或添加错误处理，异常会成为未处理的Future异常，在事件循环的后续阶段抛出，无法被当前的try-catch块捕获。

以下是三种无需修改run签名的解决方案：

方案1：将test改为异步函数，等待潜在的Future #

把test的签名改为Future<void>，调用run()后检查返回值是否为Future，若是则通过await等待，异常会被当前try-catch捕获，循环也会在错误发生时终止：

Future<void> test(void Function() run) async {
  try {
    for (var i = 0; i < 3; i++) {
      print(i);
      final result = run();
      // 检查返回值是否为Future（即使签名是void）
      if (result is Future) {
        await result;
      }
    }
  } catch (e) {
    print(e);
  } finally {
    print('in finally block.');
  }
}

void errorThrower(String message) {
  print('in errorThrower ');
  throw message;
}

void main(List<String> args) async {
  await test(() async{
    print('in run ...');
    errorThrower('error thrown in test');
  });
}

输出结果：

0
in run ...
in errorThrower 
error thrown in test
in finally block.

错误被正常捕获，循环终止，finally块执行，符合预期。

方案2：保持test为void函数，通过catchError处理异步错误 #

若必须保持test的void签名，可在检测到run()返回Future时添加catchError回调捕获异常，并控制循环是否继续：

void test(void Function() run) {
  bool shouldStop = false;
  try {
    for (var i = 0; i < 3 && !shouldStop; i++) {
      print(i);
      final result = run();
      if (result is Future) {
        result.catchError((e) {
          print('Caught async error: $e');
          shouldStop = true;
        });
      }
    }
  } catch (e) {
    print(e);
  } finally {
    print('in finally block.');
  }
}

void errorThrower(String message) {
  print('in errorThrower ');
  throw message;
}

void main(List<String> args) {
  test(() async{
    print('in run ...');
    errorThrower('error thrown in test');
  });
}

注意：由于catchError是异步触发的，循环可能会多执行一次（比如上述代码会先打印0和1，再捕获错误）。若需严格终止循环，优先选择方案1。

方案3：使用runZonedGuarded捕获所有未处理异常 #

若需统一处理所有同步和异步异常（包括回调内部其他异步操作抛出的异常），可使用runZonedGuarded创建隔离Zone，捕获Zone内所有未处理异常：

void test(void Function() run) {
  runZonedGuarded(() {
    try {
      for (var i = 0; i < 3; i++) {
        print(i);
        run();
      }
    } catch (e) {
      print(e);
    } finally {
      print('in finally block.');
    }
  }, (e, stackTrace) {
    print('Caught async error: $e');
  });
}

void errorThrower(String message) {
  print('in errorThrower ');
  throw message;
}

void main(List<String> args) {
  test(() async{
    print('in run ...');
    errorThrower('error thrown in test');
  });
}

输出结果：

0
in run ...
in errorThrower 
in finally block.
Caught async error: error thrown in test

这种方式能捕获所有异步异常，但finally块会在错误捕获前执行，因为异步异常是在事件循环后续阶段抛出的。

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