Flutter異常監控 - 壹 | 從Zone說起

碼裡特別有禪發表於2022-12-31
Flutter

如果覺得文章對你有幫助，點贊、收藏、關注、評論，一鍵四連支援，你的支援就是我創作最大的動力。

❤️ 本文原創聽蟬 公眾號：碼裡特別有禪 歡迎關注原創技術文章第一時間推送 ❤️

如果你正需要處理Flutter異常捕獲，那麼恭喜你，找對地了，這裡從根源上給你準備了Flutter異常捕獲需要是所有知識和原理，讓你更深刻認識Flutter Zone概念。

Zone是什麼

/// A zone represents an environment that remains stable across asynchronous
/// calls.

SDK中描述：表示一個環境，這個環境為了保持穩定非同步呼叫。

通俗理解39 | 線上出現問題，該如何做好異常捕獲與資訊採集？中描述：

我們可以給程式碼執行物件指定一個 Zone，在 Dart 中，Zone 表示一個程式碼執行的環境範圍，其概念類似沙盒，不同沙盒之間是互相隔離的。如果我們想要觀察沙盒中程式碼執行出現的異常，沙盒提供了 onError 回撥函式，攔截那些在程式碼執行物件中的未捕獲異常。

Zone建立

Dart提供了runZoned方法，支援Zone的快速建立

R runZoned<R>(R body(),
    {Map<Object?, Object?>? zoneValues,
    ZoneSpecification? zoneSpecification,
    @Deprecated("Use runZonedGuarded instead") Function? onError}) {
  • zoneValues: Zone 的私有資料，可以透過例項zone[key]獲取，可以理解為每個“沙箱”的私有資料。
  • zoneSpecification：Zone的一些配置，可以自定義一些程式碼行為，比如攔截日誌輸出和錯誤等

Zone的作用

捕獲異常

import 'dart:async';

//OUTPUT:Uncaught error: Would normally kill the program
void main() {
  runZonedGuarded(() {
    Timer.run(() {
      throw 'Would normally kill the program';
    });
  }, (error, stackTrace) {
    print('Uncaught error: $error');
  });
}

用try catch一樣可以捕獲，為啥要透過Zone來捕獲？

  1. Zone回撥收攏了非同步捕獲入口，提高了可維護性。
  2. 未預料的未捕獲異常可以幫你自動捕獲到，提高便捷性。

是不是所有異常都可以捕獲到？

不是, 只能處理情況1。

  1. Zone預設捕獲範圍主要針對非同步異常或者一般邏輯異常等常規異常，比如Future中出了問題，或者邏輯處理了1/0，(見Tag3)，捕獲非同步異常原理見簡話-Flutter異常處理 - 掘金

  2. Dart中另外比較容易出現的異常是framework異常，比如build異常等，這種異常Zone無法捕獲到，原因可以參看Flutter異常捕獲和Crash崩潰日誌收集 。如果想Zone來處理可這樣拋給它(見Tag1)

  3. Flutter Engine和Native異常，isolate異常 不是runZonedGuarded和FlutterError.onError 能處理範圍。

  4. isolate異常處理(見Tag2)

    原理參考特別放送 ｜ 溫故而知新，與你說說專欄的那些思考題

併發 Isolate 的異常是無法透過 try-catch 來捕獲的。併發 Isolate 與主 Isolate 通訊是採用 SendPort 的訊息機制，而異常本質上也可以視作一種訊息傳遞機制。所以，如果主 Isolate 想要捕獲併發 Isolate 中的異常訊息，可以給併發 Isolate 傳入 SendPort。而建立 Isolate 的函式 spawn 中就恰好有一個型別為 SendPort 的 onError 引數，因此併發 Isolate 可以透過往這個引數裡傳送訊息，實現異常通知。

完整Dart異常捕獲程式碼

void main() {
  FlutterError.onError = (FlutterErrorDetails details) {
    Zone.current.handleUncaughtError(details.exception, details.stack);//Tag1
    //或customerReport(details);
  };

  //Tag2
  Isolate.current.addErrorListener(
      RawReceivePort((dynamic pair) async {
        final isolateError = pair as List<dynamic>;
        customerReport(details);
      }).sendPort,
    );

  runZoned(
    () => runApp(MyApp()),
    zoneSpecification: ZoneSpecification(
      print: (Zone self, ZoneDelegate parent, Zone zone, String line) {
            report(line)
      },
    ),
    onError: (Object obj, StackTrace stack) {
      //Tag3
      customerReport(e, stack);
    }
  );
}

在部分或全部程式碼中覆蓋一組有限的方法

例如print()和scheduleMicrotask()

main() {
  runZoned(() {
    print("test");
  }, zoneSpecification: ZoneSpecification(
      print: (self, parent, zone, s) {
        parent.print(zone, "hook it: $s");
      }
  ));
}

//OUTPUT:hook it: test

上面實現的原理是什麼呢？

簡單講就是runZoned從root Zone fork了一個子Zone，print列印時如果當前Zone

不為空則使用當前Zone的print來列印，而不使用root Zone的print方法。詳細見Dart中Future、Zone、Timer的原始碼學習

每次程式碼進入或退出區域時執行一個操作

例如啟動或停止計時器，或儲存堆疊跟蹤。

如下例子，Zone提供了一個hook點，在執行其中方法時候，可以做額外包裝操作（Tag1,Tag2），比如耗時方法列印，這樣在不破壞原有程式碼基礎上實現了無侵入的統一邏輯注入。

import 'dart:async';

final total = new Stopwatch();
final user = new Stopwatch();

final specification = ZoneSpecification(run: <R>(self, parent, zone, f) {
  //Tag1
  user.start();
  try {
    return parent.run(zone, f);
  } finally {
    //Tag2
    user.stop();
  }
});

void main() {
  runZoned(() {
    total.start();
    a();
    b();
    c().then((_) {
      print(total.elapsedMilliseconds);
      print(user.elapsedMilliseconds);
    });
  }, zoneSpecification: specification);
}

void a() {
  print('a');
}

void b() {
  print('b');
}

Future<void> c() {
  return Future.delayed(Duration(seconds: 5), () => print('c'));
}

輸出：

a
b
c
5005
6

將資料（稱為 Zone本地值）與各個其他Zone相關聯

這個作用類似java中的threadlocal，每個Zone相當於有自己值的作用範圍，Zone直接值的傳遞和共享透過zonevalue來實現。

import 'dart:async';

void main() {
  Zone firstZone = Zone.current.fork(zoneValues: {"name": "bob"});
  Zone secondZone = firstZone.fork(zoneValues: {"extra_values": 12345});
  secondZone.run(() {
    print(secondZone["name"]); // bob
    print(secondZone["extra_values"]); // 12345
  });
}

案例說明：

和Linux類似地，當Zone做Fork的時候，會將父Zone所持有的ZoneSpecification、ZoneValues會繼承下來，可以直接使用。並且是支援追加的，secondZone在firstZone的基礎之上，又追加了extra_values屬性，不會因為secondZone的ZoneValues就導致name屬性被替換掉。

參考連結

簡話-Flutter異常處理 - 掘金

Zones | Dart

Brian Ford - Zones - NG-Conf 2014 - YouTube

[Flutter] 認識Zone和異常處理 - 掘金

2.8 Flutter異常捕獲 | 《Flutter實戰·第二版》

特別放送 ｜ 溫故而知新，與你說說專欄的那些思考題

歡迎搜尋公眾號：【碼裡特別有禪】 裡面整理收集了最詳細的Flutter進階與最佳化指南。關注我，獲取我的最新文章~

相關文章