Bắt đầu sử dụng Crashlytics cho Flutter

Chọn nền tảng: iOS+ Android Android NDK Flutter Unity


Hướng dẫn này mô tả cách bắt đầu sử dụng Firebase Crashlytics trong ứng dụng Flutter.

Sau khi thiết lập trình bổ trợ Crashlytics Flutter trong ứng dụng, bạn có thể xem báo cáo sự cố toàn diện trong bảng điều khiển Firebase.

Việc thiết lập Crashlytics bao gồm sử dụng cả công cụ dòng lệnh và IDE. Để hoàn tất quá trình thiết lập, bạn cần buộc một ngoại lệ kiểm thử được gửi để gửi báo cáo sự cố đầu tiên đến Firebase.

Trước khi bắt đầu

  1. Nếu chưa có, hãy định cấu hình và khởi chạy Firebase trong dự án Flutter.

  2. Đề xuất: Để tự động nhận nhật ký đường dẫn để hiểu các hành động của người dùng dẫn đến sự cố, sự kiện không nghiêm trọng hoặc sự kiện ANR, bạn cần bật Google Analytics trong dự án Firebase.

    • Nếu dự án Firebase hiện có chưa bật Google Analytics, bạn có thể bật Google Analytics từ thẻ Tích hợp trong phần cài đặt > Cài đặt dự án trong bảng điều khiển của Firebase.

    • Nếu bạn đang tạo dự án Firebase mới, hãy bật Google Analytics trong quy trình tạo dự án.

    Xin lưu ý rằng nhật ký đường dẫn có sẵn cho tất cả các nền tảng Android và Apple mà Crashlytics hỗ trợ (ngoại trừ watchOS).

Bước 1: Thêm Crashlytics vào dự án Flutter

  1. Từ thư mục gốc của dự án Flutter, hãy chạy lệnh sau để cài đặt trình bổ trợ Flutter cho Crashlytics.

    Để tận dụng nhật ký đường dẫn, hãy thêm trình bổ trợ Flutter cho Google Analytics vào ứng dụng. Đảm bảo rằng Google Analytics được bật trong dự án Firebase.

    flutter pub add firebase_crashlytics && flutter pub add firebase_analytics

  2. Từ thư mục gốc của dự án Flutter, hãy chạy lệnh sau:

    flutterfire configure

    Việc chạy lệnh này đảm bảo rằng cấu hình Firebase của ứng dụng Flutter luôn được cập nhật và đối với Android, sẽ thêm trình bổ trợ Gradle bắt buộc vào ứng dụng.Crashlytics

  3. Sau khi hoàn tất, hãy xây dựng lại dự án Flutter:

    flutter run

  4. (Không bắt buộc) Nếu dự án Flutter sử dụng cờ --split-debug-info (và tuỳ ý, cả cờ --obfuscate), bạn cần thực hiện thêm các bước để hiển thị dấu vết ngăn xếp có thể đọc được cho ứng dụng.

    • Nền tảng Apple: Đảm bảo rằng dự án của bạn đang sử dụng cấu hình phiên bản được đề xuất (Flutter 3.12.0 trở lên và trình bổ trợ Flutter 3.3.4 trở lên) để dự án có thể tự động tạo và tải biểu tượng Flutter (tệp dSYM) lên Crashlytics.CrashlyticsCrashlytics

    • Android: Sử dụng Firebase CLI (phiên bản 11.9.0 trở lên) để tải biểu tượng gỡ lỗi Flutter lên. Bạn cần tải biểu tượng gỡ lỗi lên trước khi báo cáo sự cố từ bản dựng mã bị xáo trộn.

      Từ thư mục gốc của dự án Flutter, hãy chạy lệnh sau:

      firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols

      • FIREBASE_APP_ID: Your Firebase Android App ID (not your package name)
        Example Firebase Android App ID: 1:567383003300:android:17104a2ced0c9b9b

      • PATH/TO/symbols: The same directory that you pass to the --split-debug-info flag when building the application

Bước 2: Định cấu hình trình xử lý sự cố

Bạn có thể tự động nắm bắt tất cả các lỗi được gửi trong khung Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError:

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();

  // Pass all uncaught "fatal" errors from the framework to Crashlytics
  FlutterError.onError = FirebaseCrashlytics.instance.recordFlutterFatalError;

  runApp(MyApp());
}

Để nắm bắt các lỗi không đồng bộ mà khung Flutter không xử lý, hãy sử dụng PlatformDispatcher.instance.onError:

Future<void> main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await Firebase.initializeApp();
    FlutterError.onError = (errorDetails) {
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    };
    // Pass all uncaught asynchronous errors that aren't handled by the Flutter framework to Crashlytics
    PlatformDispatcher.instance.onError = (error, stack) {
      FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
      return true;
    };
    runApp(MyApp());

}

Để biết ví dụ về cách xử lý các loại lỗi khác, hãy xem bài viết Tuỳ chỉnh báo cáo sự cố.

Bước 3: Xác định sự cố kiểm thử để hoàn tất việc thiết lập

Để hoàn tất việc thiết lập Crashlytics và xem dữ liệu ban đầu trên trang tổng quan Crashlytics trong bảng điều khiển của Firebase, bạn cần buộc một ngoại lệ kiểm thử được gửi.

  1. Thêm mã vào ứng dụng mà bạn có thể dùng để buộc một ngoại lệ kiểm thử được gửi.

    Nếu đã thêm trình xử lý lỗi gọi FirebaseCrashlytics.instance.recordError(error, stack, fatal: true) vào Zone cấp cao nhất, bạn có thể sử dụng mã sau để thêm nút vào ứng dụng. Khi nhấn, nút này sẽ gửi một ngoại lệ kiểm thử:

    TextButton(
    onPressed: () => throw Exception(),
    child: const Text("Throw Test Exception"),
),

  2. Tạo và chạy ứng dụng của bạn.

  3. Buộc ngoại lệ kiểm thử được gửi để gửi báo cáo đầu tiên của ứng dụng:

    1. Mở ứng dụng trên thiết bị thử nghiệm hoặc trình mô phỏng.

    2. Trong ứng dụng, hãy nhấn vào nút ngoại lệ kiểm thử mà bạn đã thêm bằng mã ở trên.

  4. Chuyển đến trang tổng quan Crashlytics của Firebase bảng điều khiển để xem sự cố kiểm thử.

    Nếu bạn đã làm mới bảng điều khiển và vẫn không thấy sự cố kiểm thử sau 5 phút, hãy bật tính năng ghi nhật ký gỡ lỗi để xem ứng dụng có gửi báo cáo sự cố hay không.


Chỉ vậy thôi! Crashlytics hiện đang theo dõi ứng dụng của bạn để phát hiện sự cố và trên Android, các lỗi không nghiêm trọng và ANR. Hãy truy cập vào trang tổng quan Crashlytics để xem và điều tra tất cả báo cáo và số liệu thống kê.

Các bước tiếp theo