การเริ่มต้นอย่างรวดเร็วนี้จะอธิบายวิธีตั้งค่า Firebase Crashlytics ในแอปด้วยปลั๊กอิน Crashlytics Flutter เพื่อให้คุณได้รับรายงานข้อขัดข้องที่ครอบคลุมในคอนโซล Firebase
การตั้งค่า Crashlytics ต้องใช้ทั้งเครื่องมือบรรทัดคำสั่งและ IDE ในการตั้งค่าให้เสร็จสิ้น คุณจะต้องบังคับให้มีการส่งข้อยกเว้นการทดสอบเพื่อส่งรายงานข้อขัดข้องรายการแรกไปยัง Firebase
ก่อนเริ่มต้น
หากยังไม่ได้ดำเนินการ ให้กำหนดค่าและเริ่มต้น Firebase ในโปรเจ็กต์ Flutter
แนะนำ: หากต้องการรับบันทึกเบรดครัมบ์โดยอัตโนมัติเพื่อทำความเข้าใจการดำเนินการของผู้ใช้ซึ่งนำไปสู่เหตุการณ์ข้อขัดข้อง ไม่ร้ายแรง หรือ ANR คุณต้องเปิดใช้ Google Analytics ในโปรเจ็กต์ Firebase
หากโปรเจ็กต์ Firebase ที่มีอยู่ไม่ได้เปิดใช้ Google Analytics คุณสามารถเปิดใช้ Google Analytics ได้จากแท็บการผสานรวมของ
ในคอนโซล Firebase > การตั้งค่าโปรเจ็กต์ หากคุณกำลังสร้างโปรเจ็กต์ Firebase ใหม่ ให้เปิดใช้ Google Analytics ในระหว่างขั้นตอนการสร้างโปรเจ็กต์
โปรดทราบว่าบันทึกเบรดครัมบ์พร้อมใช้งานสำหรับแพลตฟอร์ม Android และ Apple ทั้งหมดที่ Crashlytics รองรับ (ยกเว้น watchOS)
ขั้นตอนที่ 1: เพิ่ม Crashlytics ลงในโปรเจ็กต์ Flutter
จากรูทของโปรเจ็กต์ Flutter ให้เรียกใช้คำสั่งต่อไปนี้เพื่อติดตั้งปลั๊กอิน Flutter สำหรับ Crashlytics
หากต้องการใช้ประโยชน์จากบันทึกเบรดครัมบ์ ให้เพิ่มปลั๊กอิน Flutter สำหรับ Google Analytics ลงในแอปด้วย ตรวจสอบว่า เปิดใช้ Google Analytics ในโปรเจ็กต์ Firebase แล้ว
flutter pub add firebase_crashlytics && flutter pub add firebase_analytics
เรียกใช้คำสั่งต่อไปนี้จากไดเรกทอรีรูทของโปรเจ็กต์ Flutter
flutterfire configure
การเรียกใช้คำสั่งนี้จะช่วยให้การกำหนดค่า Firebase ของแอป Flutter เป็นเวอร์ชันล่าสุด และสำหรับ Android ให้เพิ่มปลั๊กอิน Crashlytics Gradle ที่จำเป็นลงในแอป
เมื่อดำเนินการเสร็จแล้ว ให้สร้างโปรเจ็กต์ Flutter อีกครั้งดังนี้
flutter run
(ไม่บังคับ) หากโปรเจ็กต์ Flutter ใช้แฟล็ก
--split-debug-info
(และอาจรวมถึงแฟล็ก--obfuscate
ด้วย) คุณจำเป็นต้องทำขั้นตอนเพิ่มเติมเพื่อแสดงสแต็กเทรซที่อ่านได้สำหรับแอปแพลตฟอร์ม Apple: ตรวจสอบว่าโปรเจ็กต์ใช้การกำหนดค่าเวอร์ชันที่แนะนำ (Flutter 3.12.0+ และปลั๊กอิน Crashlytics 3.3.4+) เพื่อให้โปรเจ็กต์สร้างและอัปโหลดสัญลักษณ์ Flutter (ไฟล์ dSYM) ไปยัง Crashlytics ได้โดยอัตโนมัติ
Android: ใช้ Firebase CLI (v.11.9.0+) เพื่ออัปโหลดสัญลักษณ์การแก้ไขข้อบกพร่องของ Flutter คุณต้องอัปโหลดสัญลักษณ์การแก้ไขข้อบกพร่องก่อน รายงานข้อขัดข้องจากบิลด์โค้ดที่ปรับให้ยากต่อการอ่าน (Obfuscate)
จากไดเรกทอรีรูทของโปรเจ็กต์ Flutter ให้เรียกใช้คำสั่งต่อไปนี้
firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols
FIREBASE_APP_ID: รหัสแอป Firebase Android (ไม่ใช่ชื่อแพ็กเกจ)
ตัวอย่างรหัสแอป Firebase บน Android:1:567383003300:android:17104a2ced0c9b9b
PATH/TO/symbols
: ไดเรกทอรีเดียวกับที่คุณ ส่งไปยังแฟล็ก--split-debug-info
เมื่อสร้างแอปพลิเคชัน
ขั้นตอนที่ 2: กำหนดค่าเครื่องจัดการข้อขัดข้อง
คุณตรวจหาข้อผิดพลาดทั้งหมดที่อยู่ในเฟรมเวิร์ก Flutter ได้โดยอัตโนมัติด้วยการลบล้าง FlutterError.onError
ด้วย 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());
}
หากต้องการตรวจจับข้อผิดพลาดแบบไม่พร้อมกันที่เฟรมเวิร์ก Flutter ไม่ได้จัดการ ให้ใช้ 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());
}
ดูตัวอย่างวิธีจัดการข้อผิดพลาดประเภทอื่นๆ ได้ที่ปรับแต่งรายงานข้อขัดข้อง
ขั้นตอนที่ 3: บังคับให้เกิดข้อขัดข้องจากการทดสอบเพื่อตั้งค่าให้เสร็จสิ้น
คุณต้องบังคับให้มีการส่งข้อยกเว้นการทดสอบเพื่อตั้งค่า Crashlytics และดูข้อมูลเริ่มต้นในแดชบอร์ด Crashlytics ของคอนโซล Firebase ให้เสร็จสิ้น
เพิ่มโค้ดลงในแอปที่คุณสามารถใช้เพื่อบังคับให้มีการส่งข้อยกเว้นทดสอบ
ถ้าเพิ่มเครื่องจัดการข้อผิดพลาดที่เรียกใช้
FirebaseCrashlytics.instance.recordError(error, stack, fatal: true)
ไปยังZone
ระดับบนสุดแล้ว คุณจะใช้โค้ดต่อไปนี้เพื่อเพิ่มปุ่มลงในแอปได้ ซึ่งเมื่อกดแล้วจะทำให้เกิดข้อยกเว้นการทดสอบTextButton( onPressed: () => throw Exception(), child: const Text("Throw Test Exception"), ),
สร้างและเรียกใช้แอป
บังคับให้มีการส่งข้อยกเว้นการทดสอบเพื่อส่งรายงานแรกของแอป
เปิดแอปจากอุปกรณ์หรือโปรแกรมจำลองทดสอบ
ในแอป ให้กดปุ่มข้อยกเว้นทดสอบที่คุณเพิ่มโดยใช้โค้ดด้านบน
ไปที่แดชบอร์ด Crashlytics ของคอนโซล Firebase เพื่อดูข้อขัดข้องในการทดสอบ
หากคุณได้รีเฟรชคอนโซลแล้ว แต่ยังไม่เห็นข้อขัดข้องการทดสอบหลังผ่านไป 5 นาที ให้เปิดใช้การบันทึกการแก้ไขข้อบกพร่องเพื่อดูว่าแอปส่งรายงานข้อขัดข้องหรือไม่
เท่านี้ก็เรียบร้อย Crashlytics กำลังตรวจสอบแอปเพื่อหาข้อขัดข้อง รวมถึงข้อผิดพลาดที่ไม่ร้ายแรงและ ANR ใน Android ไปที่
แดชบอร์ด Crashlytics
เพื่อดูและตรวจสอบรายงานและสถิติทั้งหมด
ขั้นตอนถัดไป
ปรับแต่งการตั้งค่ารายงานข้อขัดข้องโดยเพิ่มการรายงานการเลือกใช้ บันทึก คีย์ และการติดตามข้อผิดพลาดที่ไม่ร้ายแรงเพิ่มเติม
ผสานรวมกับ Google Play เพื่อให้คุณกรองรายงานข้อขัดข้องของแอป Android ตามแทร็ก Google Play ได้โดยตรงในแดชบอร์ด Crashlytics ซึ่งช่วยให้คุณโฟกัสที่หน้าแดชบอร์ด กับบิลด์เฉพาะได้ดียิ่งขึ้น
ดูสแต็กเทรซและสถิติข้อขัดข้องควบคู่ไปกับโค้ด ด้วยหน้าต่างข้อมูลเชิงลึกเกี่ยวกับคุณภาพของแอปใน Android Studio (พร้อมให้ใช้งานตั้งแต่ Electric Eel 2022.1.1)