Flutter異常監控 - 肆 | Rollbar源碼賞析

一. Rollbar可以幫你解決哪些問題無特別說明，文中Rollbar統指Rollbar-flutter 1. 代碼復用 Rollbar官方文檔說是純Dart實現，該特征意味著自帶”代碼復用”光環。如圖當接入端(Third-APP)調用Rollbar SDK時表示包含的網路(異常數據上傳等)和存 ...

一. Rollbar可以幫你解決哪些問題

無特別說明，文中Rollbar統指Rollbar-flutter

1. 代碼復用

Rollbar官方文檔說是純Dart實現，該特征意味著自帶”代碼復用”光環。

如圖當接入端(Third-APP)調用Rollbar SDK時表示包含的網路(異常數據上傳等)和存儲(異常存儲管理)可達到復用效果。

Untitled 1.png

若Flutter異常監控框架非純Dart實現(第三篇中Bugsnag)，就存在代碼無法復用問題，如圖，Dart-Crash-SDK是這層殼依賴對端SDK，最終導致各平臺(android,ios,…)都須對端SDK(android-crash-sdk, ios-crash-sdk,…)適配，導致網路和存儲邏輯對端SDK都須各自實現一遍，嚴重邏輯重覆。

Untitled 2.png
由此在做軟體多端架構設計時，Dart側可理解成是多平臺公共代碼集合，如果存在多端邏輯功能代碼完全可以抽離到Dart側以復用，減少測試和人力成本。

2. 定製包裝操作

前面兩篇文章我們知道，捕獲到原始異常後對其中的Error和StackTrace有相當部分的工作是對原始異常數據的包裝再將包裝類數據發送給對端或者後臺，不同框架包裝過程是不一樣的，如下圖中Catcher框架包裝後類對象是Report，Bugsnag對異常進行兩次包裝，第一次是BugsnagError，第二次是BugsnagEvent。
Untitled 3.png

這很好理解，因為對於同一事物不同框架的需求是不一樣的，不同需求註定了不同的包裝行為。
原始異常數據就像一條魚，口味清淡的Catcher選擇清蒸，重口味的Bugsnag選擇紅燒，不同框架就是不同口味的吃魚人。而Rollbar 將包裝行為抽象化，將原始的魚以某種方式提供給你，讓你享受自由烹飪樂趣。

3. 線程切換

異常產生後有很多耗時操作，如原始異常數據包裝中存在讀取額外欄位，異常的存儲，查詢，加密，上報等。耗時操作都在main isolate 中做, 勢必會影響到main isolate的UI 構建等行為，異常數據量比大時UI會有卡頓情況，就像圖中情況，

Untitled 4.png
Rollbar支持將異常耗時處理操作交給子isolate(crash isolate)，讓main isolate保持專註做UI構建等以提高應用的流暢度。

Untitled 5.png

4. 追溯生成路徑

該需求與第三篇Flutter異常監控 - 叄 |從bugsnag源碼學習如何追溯異常產生路徑相同

該需求目的是能完整記錄用戶操作的整個行為路徑，這樣達到清晰指導用戶操作過程，對問題的定位很有幫助。可以理解成一個小型的埋點系統，只是該埋點系統只是針對異常來做的。

區別在代碼層面實現，bugsnag中有自動添加和手動添加路徑兩種情況，Rollbar中只有手動添加，但是手動添加分類更加細化，比如圖中將Breadcrumb構造過程被分成Breadcrumb.error、Breadcrumb.navigation、Breadcrumb.widget、Breadcrumb.log 對應不同圖標事件。

Untitled 6.png
話說，追溯異常生成路徑需求是標配麽？目前看Bugsnag和Rollbar都有實現。

二. 如何使用

將包添加到您的文件中：pubspec.yaml

dependencies:
  rollbar_flutter: ^0.3.0-beta

運行 flutter pub get

代碼中配置:

import 'package:rollbar_flutter/rollbar.dart';
Future<void> main() async {
  const config = Config(
      //accessToken到https://rollbar.com/註冊獲取
      accessToken: 'YOUR-ROLLBAR-ACCESSTOKEN',
      package: 'rollbar_flutter_example');

  await RollbarFlutter.run(config, () {
    runApp(const MyApp());
  });
}

要求

Dart SDK >= 2.7.0
Flutter >= 1.20.0
A Rollbar account

三. 原理解析

Rollbar是Flutter異常框架，當然少不了讀這類源碼套路，直接拿出第三篇文章中的通用閱讀路徑, 按照如下流程一步步走：

1. Flutter異常監控點

接入端通過RollerFlutter.run 進入到Rollbar內部邏輯。
重點關註Config中預設的四個變數：

Notifier：控制發送事件是通過主線程還是其他線程中發送。
Transformer：對異常數據進行轉換的轉換器。
Wrangler: 提供對異常數據二次包裝機會返回最終發送的真實數據。
Sender: 將Wrangler提供的真實數據發送。

Untitled 8.png

Untitled 9.png

通過FlutterError.onError（21行）和runZonedGuarded（13行）兩個監控點邏輯處理，將異常收攏到Rollbar.error方法中

Untitled 10.png

將原始異常以Event方式交給Notifier.notify（15行）。

Untitled 11.png

通過步驟1中Config提供預設實現知道步驟3中_notifier是IsolatedNotifier，這樣下圖中(14行)事件最終會發送到子線程中(45行)。

這裡主要涉及到isolate雙向通信知識，不清楚可以看下這個帖子Flutte 指北 -> Isolate

40~43 ：實際拿到的是步驟1中傳入的幾個預設值，其中telemetry變數可以理解成資料庫封裝對象用來緩存異常數據的。
46~49 ：在轉換Event之前，需要對資料庫中緩存的異常進行處理，其中資料庫中緩存數據有兩類1. breadcrumb 2. Event 。49會對正常Event進行過期判斷，如果過期就刪除掉。
51~53：這個通過預設wrangler獲取真實數據。
54：sender發送真實數據到伺服器等。

Untitled 12.png

至此流程圖如下：

2. 生成異常包裝類

10行:Event轉換成Data對象，主要是添加一些除了Error和StackTrack之外信息。比如客戶端信息(當前OS系統，OS版本，dart版本，平臺CPU內核數目等)、包名，事件等級，環境等。
11行:Data對象交給Transformer轉換器，讓開發者可以自定義自己的轉換行為。
12行:返回最終真實數據Payload。

Untitled 14.png

異常數據包裝流程：

Untitled 15.png

3. 操作包裝類

上面步驟中經過對Event二次封裝，生成最終包裝類為Payload, 最後該類轉換成字元串發送到Rollbar後臺。

Untitled 16.png

四.如何進行線程切換

上面分析可知線程切換通過Notifier實現，線程切換思路：通過Config配置自定義Notifier值來指定異常處理運行線程，AsyncNotifier是main UI isolate, IsolateNotifier會新建子線程執行異常相關操作。

Notifier定義

abstract class Notifier {
  // notifier version to be updated with each new release: [todo] automate
  static const version = '0.4.0-beta';
  static const name = 'rollbar-dart';

  Sender get sender;
  Wrangler get wrangler;
  Telemetry get telemetry;

  FutureOr<void> notify(Event event);
  FutureOr<void> dispose();
}

Notifier及子類關係圖

Untitled 17.png

子isolate處理好處

預設初始化IsolatedNotifier.spwan 將產生一個新線程。

總結了幾點好處：

發送事件之前Telemetry會做資料庫相關增加，查詢和刪除操作，這個耗時。
Wrangler對象會通過Transformer對Event進行二次保證操作，這個過程也可能耗時。
Sender.send發送事件的時候，如果當前應用某個時間段異常頻繁，在主線程也可能影響UI。

綜上將可能耗時都放到非同步線程,可以提高主線程流暢性。

五. 如何定製包裝類

上面分析可知，包裝過程通過Transformer來實現，自定義包裝類思路：通過Config配置自定義Transformer值來實現自定義處理異常數據邏輯，可以進行加密等。

Transformer定義

abstract class Transformer {
  FutureOr<Data> transform(Data data, {required Event event});
}

Transformer子類

Config預設實現是這個，如果想自定義數據包裝過程，可以覆寫其中transform，對其中date和event操作。

class NoopTransformer implements Transformer {
  const NoopTransformer(Config _);

  @override
  Data transform(Data data, {required Event event}) => data;
}

六. 設計模式相關

1. 單一職責原則

類功能抽象精準，清晰的職能分工：

Isolate切換模塊，Notifier 子類實現。
轉換模塊： Transformer 對象給了自定義和預設的轉換方式。
傳輸模塊：Wrangler 將提供最終真實數據並傳輸給sender。
發送模塊：Sender 子類實現，可以擴展出httpSender等。
存儲模塊：Telemetry 對資料庫的包裝，可插入，查詢異常和異常路徑對象。

2. 可插拔設計

可插拔意味更自由的功能和更開閉的設計。Rollbar像堆積木一樣，將包裝，傳輸，發送，存儲通過組合方式統一配置起來更具靈活性。

Untitled 18.png

通過非空命名構造函數提供預設實現，模塊直接是以組合配置，外部可設置和替換，滿足開閉原則。

const Config({
    this.notifier = IsolatedNotifier.spawn,
    this.wrangler = DataWrangler.new,
    this.transformer = NoopTransformer.new,
    this.sender = PersistentHttpSender.new,
  });

PS: 一直沒想明白Dart中構造函數的多非空可選參數與構建者模式有啥不同，感覺前者完全可以替換構建者模式的場景，哪位大佬能告訴我應用場景區別？

七. 其他

考慮到篇幅原因，文章分析了主要流程，其實還有很多點值得學習和借鑒。如

異常存儲和序列化相關邏輯。
多stacktrace處理，例如:Android平臺中的PlatformException。
Dart2.15中構造函數拆分。

八. 問題及說明

官方flutter還是beta版本官網創建項目的時候沒有flutter項目圖標選擇，可以不選，直接將客戶端accesstoken拿到example中即可。
在發送過程中會報accesstoken的錯誤，這個是因為之前accesstoken配置錯誤的情況下記錄沒發送出去導致的，將應用卸載或者應用資料庫刪掉後，再用最新的accesstoken測試即可。