Flutter 框架會捕獲由框架本身觸發的回撥過程中發生的錯誤,包括在構建、佈局和繪製階段遇到的錯誤。不在 Flutter 回撥中的錯誤無法被框架捕獲,但您可以透過在 PlatformDispatcher 上設定錯誤處理程式來處理它們。

所有被 Flutter 捕獲的錯誤都會被路由到 FlutterError.onError 處理程式。預設情況下,這會呼叫 FlutterError.presentError,它會將錯誤轉儲到裝置日誌中。從 IDE 執行時,檢查器會覆蓋此行為,以便錯誤也可以被路由到 IDE 的控制檯,讓您可以檢查訊息中提到的物件。

當在構建階段發生錯誤時,會呼叫 ErrorWidget.builder 回撥來構建將用於替換失敗的小部件的小部件。預設情況下,在除錯模式下,這會顯示一個紅色的錯誤訊息,而在釋出模式下,它會顯示一個灰色的背景。

當出現沒有 Flutter 回撥在呼叫堆疊中的錯誤時,它們由 PlatformDispatcher 的錯誤回撥處理。預設情況下,這隻會列印錯誤,不做其他任何事情。

您可以自定義這些行為,通常是在您的 void main() 函式中設定它們的值。

下面對每種錯誤型別的處理進行了說明。底部有一個處理所有型別錯誤的示例程式碼片段。儘管您可以直接複製貼上此程式碼片段,但我們建議您首先熟悉每種錯誤型別。

Flutter 捕獲的錯誤

#

例如,要在釋出模式下使您的應用程式在捕獲到 Flutter 錯誤時立即退出,您可以使用以下處理程式:

dart
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...

此處理程式也可用於將錯誤報告給日誌記錄服務。有關更多詳細資訊,請參閱我們的 錯誤報告到服務 食譜章節。

為構建階段錯誤定義自定義錯誤小部件

#

要定義一個自定義錯誤小部件,該小部件將在構建器無法構建小部件時顯示,請使用 MaterialApp.builder

dart
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(或幾乎任何外掛)。例如:

dart
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

dart
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());
}

處理所有型別的錯誤

#

假設您想在任何異常發生時退出應用程式,並在構建器小部件失敗時顯示自定義錯誤小部件 - 您可以基於以下程式碼片段處理您的錯誤:

dart
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');
      },
    );
  }
}