flutter线上异常用bugly监控

线上问题监控是程序开发必要流程,flutter该如何做呢?
我们用bugly收集异常

1.1 异常采集

Native的异常通常伴随着应用崩溃,而dart异常,提供了一种灵活的机制来捕获和处理异常,不会直接导致应用程序崩溃,常表现为页面白屏、执行操作卡死等,它们在稳定性的用户体验上并不是完全对等的。

截屏2024-01-26 14.31.06.png

捕获异常方式:

○ FlutterError.onError适用于全局异常处理

○ runZonedGuarded适用于在特定区域内捕获异常

○ PlatformDispatcher.instance.onError适用于处理底层平台异常 (Flutter SDK v3.3及以上支持)

○ try catch适用于捕获同步代码块中的异常

○ Future.catchError适用于捕获异步操作中的异常

pubspec.yaml 加入bugly插件
flutter_bugly_plugin: ^0.0.9
安卓需要添加几个权限,详情见下面链接
https://pub.dev/packages/flutter_bugly_plugin

1 项目初始化时候 找个地方初始化下bugly
  Future<void> initBugly() async {
    FlutterBuglyPlugin.init(
      appIdAndroid: "xxxxxx",
      appIdiOS: "xxxxxxx",
    );
    final onError = FlutterError.onError;

    FlutterError.onError = (FlutterErrorDetails details) {
      onError?.call(details);
     FlutterBuglyPlugin.reportException(
            exceptionName:
                'FlutterError.onError - ${details.exceptionAsString()}',
            reason: details.stack.toString());
    };
    PlatformDispatcher.instance.onError = (error, stack) {
        FlutterBuglyPlugin.reportException(
            exceptionName:
                'PlatformDispatcher.onError - ${error.toString()}',
            reason: stack.toString());
      return true;
    };
  }

2 runApp的异常也上报
  runZonedGuarded(() {
    runApp(MyApp()));
  }, (error, stackTrace) {

    if (kReleaseMode) {
      FlutterBuglyPlugin.reportException(
          exceptionName: '${error.toString()}',
          reason: stackTrace.toString());
    }
  });

异常级别

数组越界的主动引发执行异常,可以看到同类型的错误出现的位置不一样导致的页面表现也不一致。
List exceptionList = [];
exceptionList[1];

同步初始化异常:

在执行入口main() 主动引发异常,因为同步的初始化执行被阻塞导致后续的页面无法成功渲染,表现为页面白屏。
未捕获的异步错误:

主动在Future.delayed中引发异常,因为异步任务不会阻塞主线程页面渲染,所以页面表现正常。

写到build方法里面
组件渲染错误:
绘制主动引发异常,引发framework异常,表现为白屏(dev下红屏)。

手势事件回调异常:

Flutter的事件处理是异步的,并且是在单独的线程中处理的,不会阻塞页面渲染,但是异常代码之后的执行逻辑将被阻塞无法响应。

1.3 异常细类

Flutter 异常类型主要包括以下几种(不包含全部):

  1. FlutterError:这是 Flutter 异常的基类,用于表示 Flutter 框架内部的错误。它提供了一个描述错误的消息和一个可选的错误详情。

  2. AssertionError:这是一个断言异常,用于在开发过程中发现错误或无效的操作。当断言失败时,会抛出此异常。

  3. FormatException:表示由于格式错误而导致的异常。例如,将字符串转换为数字时,如果字符串的格式不正确,则会抛出此异常。

  1. RangeError:表示由于超出范围而导致的异常。例如,当索引超出列表的范围时,会抛出此异常。

  2. NoSuchMethodError:表示尝试调用不存在的方法或访问不存在的属性时引发的异常。

这些是一些常见的 Flutter 异常类型和相应的案例。根据项目的具体需求和实现细节,可能会遇到其他类型的异常。

SDK通过异常摘要的 runtimeType 来采集异常的异常细类,对于 CastError(类型转换错误)、RangeError、PlatformException、NoSuchMethodError、MissingPluginException 等多种错误类型,我们认为其是影响业务的,所以对 Flutter 的异常进行分类的处理。

上报异常解析

如何你构建包时候用
安卓 flutter build apk --release
ios flutter build ios --release 后用xcode archive导出ipa

这种情况没有对代码剥离调试符号,上报到bugly的异常直接可以看到堆栈
缺点是

  1. 增加应用大小**:所有的调试信息(比如堆栈信息)将会包含在你的应用程序的主二进制文件中,导致文件大小增加。

  2. 包含完整的符号信息**:由于调试信息没有被剥离出主二进制文件,如果有错误发生,错误报告将包含完整的符号信息,这有助于你直接在错误报告中定位到Dart源码的具体位置。

一般我们打线上包需要-split-debug-info 剥离调试符号
// Android
flutter build apk --release --split-debug-info=/<directory>

// iOS
flutter build ios --release -split-debug-info=/<directory>

以ios为例
在Xcode中对Flutter应用执行归档操作时,实际上是使用已经构建好的Flutter框架。如果你想使用--split-debug-info选项(它针对的是Flutter的Dart代码部分),你需要在命令行中使用Flutter命令来构建。

在终端中,使用以下命令(确保先从Flutter项目的根目录开始):

flutter build ios --release --split-debug-info=/path/to/directory/

这个命令会触发Flutter构建流程,并将Dart相关的调试信息存储在指定路径的目录中。构建完成后,相应的调试符号文件会生成在该目录下。(会把代码映射关系生成一个app.ios-arm64.symbols文件)

之后,你可以正常地在Xcode中进行归档操作:

  1. 打开Xcode,然后打开你的Flutter项目的 Runner.xcworkspace
  2. 选择 Product > Archive 进行归档操作。
  3. 归档完成后,通过Xcode的Organizer窗口导出IPA或者分发到TestFlight。

如果以后需要使用调试信息来解析混淆过的堆栈跟踪,你需要确保保存了--split-debug-info命令生成的那些文件,并了解它们与哪个版本的应用相对应。

请注意,--split-debug-info仅适用于Dart代码,Objective-C/Swift或者其他原生端代码的调试符号需要通过Xcode相应的工具和流程来管理。

这样线上收集到的异常 按照#00方式整理成下面这样 每个堆栈换一行


#00 abs 0000000109defa1f _kDartIsolateSnapshotInstructions+0x1c56df 
#01 abs 0000000109fee21b _kDartIsolateSnapshotInstructions+0x3c3edb 
#02 abs 000000010a18ef3b _kDartIsolateSnapshotInstructions+0x564bfb 
#03 abs 0000000109f5db67 _kDartIsolateSnapshotInstructions+0x333827 
#04 abs 000000010a1277c7 _kDartIsolateSnapshotInstructions+0x4fd487 
  1. 确保你有访问生成堆栈跟踪时相应版本的.symbols文件。

  2. 使用Flutter的symbolize命令,它是flutter工具的一部分,来解析混淆后的堆栈。

打开一个命令行或者终端窗口,并执行以下命令:

flutter symbolize -d /path/to/directory/ -i input.stacktrace.txt > output.symbolicated.txt

参数说明:

  • -d 后跟.symbols文件存储的目录。
  • -i 用于指定输入堆栈跟踪文件的路径(这是你从线上问题收集到的混淆堆栈跟踪)。如果堆栈跟踪是标准输入(STDIN)形式的,可以使用-i -
  • > 是将命令的输出(解析后的堆栈)重定向到一个文件,你可以自定义这个文件的名字。

实际例子

flutter symbolize -d /Users/xxxx/Desktop/symbol文件/app.ios-arm64.symbols  -i /Users/xxxx/Desktop/错误文件/cuowu.txt  > jiexi.txt

执行该命令后,output.symbolicated.txt文件将会包含解析后的堆栈跟踪信息,你可以通过这些信息将混淆的堆栈跟踪映射回你的原始Dart源码。

请确保使用了正确版本的符号文件,因为不同的编译版本会生成不同的.symbols文件,只有匹配的版本之间才能正确解析。

这样就把异常解析好了

对于Flutter生成的.symbols文件,你可以使用Flutter的symbolize命令来解析Flutter的Dart代码部分的堆栈跟踪。如果你的堆栈跟踪同时涉及到了iOS原生和Dart代码,你需要分别用dSYM和Flutter生成的.symbols文件来分别解析这两部分的内容。

如何你还想混淆你的flutter代码
flutter build ios --release --obfuscate --split-debug-info=放symbols文件的目录
安卓用flutter build apk --release --obfuscate --split-debug-info=

--obfuscate`选项不是必须的。这个选项用于在编译你的应用时进行代码混淆,以防止逆向工程。混淆会更改类、方法和字段名的符号至难以理解的字符组合,从而提高代码的保密性。

如果你不需要混淆你的代码(比如,你的应用不包含敏感逻辑或者专有算法),你可以不加这个选项。同时,如果你不使用--obfuscate,在发生异常时,堆栈跟踪中的信息会更清晰、更容易直接与你的源代码对应起来,这将直接简化调试过程。

在不使用混淆的情况下,你仍然可以使用--split-debug-info选项将符号信息拆分到一个单独的文件夹中,这样做的好处是减小了发布包的大小而没有牺牲太多的可调试性。在需要解析堆栈跟踪信息时,你仍然可以使用这些符号信息文件来还原出清晰的调用栈。
建议两个都加上,实测加上obfuscate解析出来堆栈有行号 对排查bug更有利

安卓生成的.symbols文件有好几个
app.android-arm64.symbols
app.android-arm.symbols

异常日志必须每一行开头是# 上报上去的不分行,需要手动换行 这样才能解析出来

#00 abs 0000007356924e13 virt 00000000004a1e13 _kDartIsolateSnapshotInstructions+0x26b893 
#01 abs 0000007356a9a257 virt 0000000000617257 _kDartIsolateSnapshotInstructions+0x3e0cd7 

bugly上会显示异常的cpu架构
CPU架构
arm64-v8a
v8用app.android-arm64.symbols
v7架构用 app.android-arm.symbols

涉及原生部分
ios上传dSYM 安卓上传mapping.txt文件到lbugy就好了 和原生一样,bugly会自动解析原生异常

封装的flutter基础框架: https:/gitee.com/kuaipai/jd_flutter,你可以参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容