Flutter里面错误捕获的正确方法
创始人
2024-12-23 02:04:17
0次

背景

我们知道,在软件开发过程中,错误和异常总是在所难免。

不管是客户端的逻辑错误导致的,还是服务器的数据问题导致的,只要出现了异常,我们都需要一个机制来通知我们去处理。

在 APP 的开发过程中,我们通过一些第三方的平台,比如 Fabric、Bugly 等可以实现异常的日志上报。

Flutter 也有一些第三方的平台,比如 Sentry 可以实现异常的日志上报。

但是为了更加通用一些,本篇不具体讲解配合某个第三方平台的异常日志捕获,我们会告知大家如何在 Flutter 里面捕获异常。

至于具体的上报途径,不管是上报到自家的后台服务器,还是通过第三方的 SDK API 接口进行异常上报,都是可以的。

Demo 初始状态

首先我们新建 Flutter 项目,修改 main.dart 代码如下:

import 'package:flutter/material.dart';void main() => runApp(MyApp());class MyApp extends StatelessWidget { // This widget is the root of your application. @override Widget build(BuildContext context) {  return MaterialApp(   home: Scaffold(    appBar: AppBar(title: Text('Flutter Crash Capture'),),    body: MyHomePage(),   ),  ); }}class MyHomePage extends StatelessWidget { @override Widget build(BuildContext context) {  return Container(); }}

效果如下:

捕获错误

我们修改 MyHomePage,添加一个 List 然后进行越界访问,改动部分代码如下:

class MyHomePage extends StatelessWidget { @override Widget build(BuildContext context) {  List numList = ['1', '2'];  print(numList[6]);  return Container(); }}

可以看到控制台报错如下:

flutter: ══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════flutter: The following RangeError was thrown building MyHomePage(dirty):flutter: RangeError (index): Invalid value: Not in range 0..1, inclusive: 6

当然这些错误信息在界面上也有显示(debug 模式)。

那么我们如何捕获呢?

其实很简单,有个通用模板,模板为:

import 'dart:async';import 'package:flutter/material.dart';Future main() async { FlutterError.onError = (FlutterErrorDetails details) async {  Zone.current.handleUncaughtError(details.exception, details.stack); }; runZoned>(() async {  runApp(MyApp()); }, onError: (error, stackTrace) async {  await _reportError(error, stackTrace); });}Future _reportError(dynamic error, dynamic stackTrace) async { // TODO}

在 TODO 里面就可以执行埋点上报操作或者其他处理了。

完整例子如下:

import 'dart:async';import 'package:flutter/material.dart';Future main() async { FlutterError.onError = (FlutterErrorDetails details) async {  Zone.current.handleUncaughtError(details.exception, details.stack); }; runZoned>(() async {  runApp(MyApp()); }, onError: (error, stackTrace) async {  await _reportError(error, stackTrace); });}Future _reportError(dynamic error, dynamic stackTrace) async { print('catch error='+error);}class MyApp extends StatelessWidget { // This widget is the root of your application. @override Widget build(BuildContext context) {  return MaterialApp(   home: Scaffold(    appBar: AppBar(title: Text('Flutter Crash Capture'),),    body: MyHomePage(),   ),  ); }}class MyHomePage extends StatelessWidget { @override Widget build(BuildContext context) {  List numList = ['1', '2'];  print(numList[6]);  return Container(); }}

运行可以看到控制台捕获到错误如下:

flutter: catch error=RangeError (index): Invalid value: Not in range 0..1, inclusive: 6

assert 妙用

我们知道,一般错误上报都是在打包发布到市场后才需要。

平时调试的时候如果遇到错误,我们是会定位问题并修复的。

因此在 debug 模式下,我们不希望上报错误,而是希望直接打印到控制台。

那么,这个时候就需要一种方式来区分现在是 debug 模式还是 release 模式,怎么区分呢?

这个时候就需要用到 assert 了。

bool get isInDebugMode { // Assume you're in production mode. bool inDebugMode = false; // Assert expressions are only evaluated during development. They are ignored // in production. Therefore, this code only sets `inDebugMode` to true // in a development environment. assert(inDebugMode = true); return inDebugMode;}

从注释也可以知道,assert 表达式只在开发环境下会起作用,在生产环境下会被忽略。

因此利用这一个,我们就可以实现我们的需求。

上面的结论要验证也很简单,我们就不演示了。

完整模板

import 'dart:async';import 'package:flutter/material.dart';Future main() async { FlutterError.onError = (FlutterErrorDetails details) async {  if (isInDebugMode) {   FlutterError.dumpErrorToConsole(details);  } else {   Zone.current.handleUncaughtError(details.exception, details.stack);  } }; runZoned>(() async {  runApp(MyApp()); }, onError: (error, stackTrace) async {  await _reportError(error, stackTrace); });}Future _reportError(dynamic error, dynamic stackTrace) async { // TODO}bool get isInDebugMode { // Assume you're in production mode. bool inDebugMode = false; // Assert expressions are only evaluated during development. They are ignored // in production. Therefore, this code only sets `inDebugMode` to true // in a development environment. assert(inDebugMode = true); return inDebugMode;}

debug 模式下,直接将错误打印到控制台,方便定位问题。

release 模式下,将错误信息收集起来,上传到服务器。

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...