在 Flutter 中处理错误
Flutter 框架会捕获在框架自身触发的回调中发生的错误,包括在构建、布局和绘制阶段遇到的错误。未在 Flutter 回调中发生的错误无法被框架捕获,但你可以通过在 PlatformDispatcher
上设置错误处理器来处理它们。
Flutter 捕获的所有错误都会路由到 FlutterError.onError
处理器。默认情况下,它会调用 FlutterError.presentError
,将错误转储到设备日志。当从 IDE 运行时,检查器会覆盖此行为,以便错误也可以路由到 IDE 的控制台,从而允许你检查消息中提及的对象。
当在构建阶段发生错误时,会调用 ErrorWidget.builder
回调来构建用于替换失败 widget 的 widget。默认情况下,在调试模式下,这会显示红色错误消息;在发布模式下,则显示灰色背景。
当错误在调用栈上没有 Flutter 回调时发生,它们由 PlatformDispatcher
的错误回调处理。默认情况下,这只会打印错误,不执行其他操作。
你可以自定义这些行为,通常通过在 void main()
函数中设置它们的值来实现。
下面解释了每种错误类型的处理方法。在底部有一个代码片段,可以处理所有类型的错误。尽管你可以直接复制粘贴该片段,但我们建议你首先熟悉每种错误类型。
Flutter 捕获的错误
#例如,为了让你的应用程序在发布模式下Flutter捕获到任何错误时立即退出,你可以使用以下处理器
import 'dart:io';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
void main() {
FlutterError.onError = (details) {
FlutterError.presentError(details);
if (kReleaseMode) exit(1);
};
runApp(const MyApp());
}
// The rest of the `flutter create` code...
此处理器还可以用于向日志服务报告错误。有关更多详细信息,请参阅我们的食谱章节:向服务报告错误。
为构建阶段错误定义自定义错误 widget
#要定义一个自定义错误 widget,在构建器未能构建 widget 时显示,请使用 MaterialApp.builder
。
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
builder: (context, widget) {
Widget error = const Text('...rendering error...');
if (widget is Scaffold || widget is Navigator) {
error = Scaffold(body: Center(child: error));
}
ErrorWidget.builder = (errorDetails) => error;
if (widget != null) return widget;
throw StateError('widget is null');
},
);
}
}
Flutter 未捕获的错误
#考虑一个 onPressed
回调,它调用一个异步函数,例如 MethodChannel.invokeMethod
(或几乎任何插件)。例如
OutlinedButton(
child: const Text('Click me!'),
onPressed: () async {
const channel = MethodChannel('crashy-custom-channel');
await channel.invokeMethod('blah');
},
)
如果 invokeMethod
抛出错误,它不会被转发到 FlutterError.onError
。相反,它被转发到 PlatformDispatcher
。
要捕获此类错误,请使用 PlatformDispatcher.instance.onError
。
import 'package:flutter/material.dart';
import 'dart:ui';
void main() {
MyBackend myBackend = MyBackend();
PlatformDispatcher.instance.onError = (error, stack) {
myBackend.sendError(error, stack);
return true;
};
runApp(const MyApp());
}
处理所有类型的错误
#假设你希望在任何异常发生时退出应用程序,并在 widget 构建失败时显示自定义错误 widget - 你可以基于以下代码片段进行错误处理
import 'package:flutter/material.dart';
import 'dart:ui';
Future<void> main() async {
await myErrorsHandler.initialize();
FlutterError.onError = (details) {
FlutterError.presentError(details);
myErrorsHandler.onErrorDetails(details);
};
PlatformDispatcher.instance.onError = (error, stack) {
myErrorsHandler.onError(error, stack);
return true;
};
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
builder: (context, widget) {
Widget error = const Text('...rendering error...');
if (widget is Scaffold || widget is Navigator) {
error = Scaffold(body: Center(child: error));
}
ErrorWidget.builder = (errorDetails) => error;
if (widget != null) return widget;
throw StateError('widget is null');
},
);
}
}