分享一下Flutter中异常处理

我正在参加「掘金·启航计划」

Flutter如何捕获异常

• 程序异常会怎样
  • 在Java中，程序发生异常且没有被捕获，那么程序将会终止。
  • 但在Dart或JavaScript中则不会，究其原因，这和它们的运行机制有关系，Java是多线程模型的编程语言，任意一个线程触发异常且没被捕获时，整个进程就退出。
  • 但Dart和JavaScript不会，它们都是单线程模型，运行机制很相似(但有区别)。
• flutter如何捕获异常
  • Dart中可以通过try/catch/finally来捕获代码块异常，这个和其它编程语言类似。

Flutter框架异常捕获

• Flutter 框架在很多关键的方法进行了异常捕获。
  • 举一个例子，当布局发生越界或不合规范时，Flutter就会自动弹出一个错误界面，这是因为Flutter已经在执行build方法时添加了异常捕获。
  • 最终的源码如下，具体看 ComponentElement 类中的 performRebuild() 方法。

  @override
  void performRebuild() {
    try {
      //执行build方法  
      built = build();
    } catch (e, stack) {
      // 有异常时则弹出错误提示  
      built = ErrorWidget.builder(_debugReportException('building $this', e, stack));
    } 
  }      
  

• 可以看到，在发生异常时，Flutter默认的处理方式是弹一个ErrorWidget
  • 但如果想自己捕获异常并上报到报警平台的话应该怎么做？进入_debugReportException()方法看看：

  FlutterErrorDetails _debugReportException(
    String context,
    dynamic exception,
    StackTrace stack, {
    InformationCollector informationCollector
  }) {
    //构建错误详情对象  
    final FlutterErrorDetails details = FlutterErrorDetails(
      exception: exception,
      stack: stack,
      library: 'widgets library',
      context: context,
      informationCollector: informationCollector,
    );
    //报告错误 
    FlutterError.reportError(details);
    return details;
  }
  

• 发现，错误是通过FlutterError.reportError方法上报的，继续跟踪：

  static void reportError(FlutterErrorDetails details) {
    ...
    if (onError != null)
      onError(details); //调用了onError回调
  }
  

• 发现onError是FlutterError的一个静态属性，它有一个默认的处理方法 dumpErrorToConsole，到这里就清晰了，如果想自己上报异常，只需要提供一个自定义的错误处理回调即可，如：

  void main() {
    FlutterError.onError = (FlutterErrorDetails details) {
      reportError(details);
    };
   ...
  }
  

• 这样就可以处理那些Flutter为我们捕获的异常了，接下来看看如何捕获其它异常。

其它异常捕获与日志收集

• 在Flutter中，还有一些Flutter没有为我们捕获的异常，如调用空对象方法异常、Future中的异常。

  • 在Dart中，异常分两类：同步异常和异步异常，同步异常可以通过try/catch捕获，而异步异常则比较麻烦，如下面的代码是捕获不了Future的异常的：

  try{
      Future.delayed(Duration(seconds: 1)).then((e) => Future.error("xxx"));
  }catch (e){
      print(e)
  }
  

• Dart中有一个runZoned(...) 方法，可以给执行对象指定一个Zone。

  • Zone表示一个代码执行的环境范围，为了方便理解，可以将Zone类比为一个代码执行沙箱，不同沙箱的之间是隔离的，沙箱可以捕获、拦截或修改一些代码行为。
  • 如Zone中可以捕获日志输出、Timer创建、微任务调度的行为，同时Zone也可以捕获所有未处理的异常。
  • 下面看看runZoned(...)方法定义：

  R runZoned<R>(R body(), {
      Map zoneValues, 
      ZoneSpecification zoneSpecification,
      Function onError,
  }) 
  

  • zoneValues: Zone 的私有数据，可以通过实例zone[key]获取，可以理解为每个“沙箱”的私有数据。
  • zoneSpecification：Zone的一些配置，可以自定义一些代码行为，比如拦截日志输出行为等，举个例子：

• 下面是拦截应用中所有调用print输出日志的行为。

  main() {
      runZoned(() => runApp(MyApp()), zoneSpecification: new ZoneSpecification(
          print: (Zone self, ZoneDelegate parent, Zone zone, String line) {
            parent.print(zone, "Intercepted: $line");
          }),
      );
  }
  

  • 这样一来，APP中所有调用print方法输出日志的行为都会被拦截，通过这种方式，也可以在应用中记录日志，等到应用触发未捕获的异常时，将异常信息和日志统一上报。ZoneSpecification还可以自定义一些其他行为，读者可以查看API文档。

• onError：Zone中未捕获异常处理回调，如果开发者提供了onError回调或者通过ZoneSpecification.handleUncaughtError指定了错误处理回调，那么这个zone将会变成一个error-zone，该error-zone中发生未捕获异常(无论同步还是异步)时都会调用开发者提供的回调，如：

  runZoned(() {
      runApp(MyApp());
  }, onError: (Object obj, StackTrace stack) {
      var details=makeDetails(obj,stack);
      reportError(details);
  });
  

  结合上面的FlutterError.onError就可以捕获我们Flutter应用中全部错误了！需要注意的是，error-zone内部发生的错误是不会跨越当前error-zone的边界的，如果想跨越error-zone边界去捕获异常，可以通过共同的“源”zone来捕获，如：

  var future = new Future.value(499);
  runZoned(() {
  	var future2 = future.then((_) { throw "error in first error-zone"; });
  	runZoned(() {
  		var future3 = future2.catchError((e) { print("Never reached!"); });
  	}, onError: (e) { print("unused error handler"); });
  }, onError: (e) { print("catches error of first error-zone."); });
  
  

总结

• 最终异常捕获和上报代码如下：

  void collectLog(String line){
      ... //收集日志
  }
  void reportErrorAndLog(FlutterErrorDetails details){
      ... //上报错误和日志逻辑
  }
  
  FlutterErrorDetails makeDetails(Object obj, StackTrace stack){
      ...// 构建错误信息
  }
  
  void main() {
    FlutterError.onError = (FlutterErrorDetails details) {
      reportErrorAndLog(details);
    };
    runZoned(
      () => runApp(MyApp()),
      zoneSpecification: ZoneSpecification(
        print: (Zone self, ZoneDelegate parent, Zone zone, String line) {
          collectLog(line); // 收集日志
        },
      ),
      onError: (Object obj, StackTrace stack) {
        var details = makeDetails(obj, stack);
        reportErrorAndLog(details);
      },
    );
  }