前言
Crashlytics的作用是在移动应用程序发生崩溃时，及时收集崩溃信息并发送给开发人员，以帮助开发人员快速定位和修复问题，从而提高应用程序的稳定性和用户体验
Crashlytics的原理是通过集成到应用程序中的SDK，在应用程序崩溃时收集崩溃信息并在App重启时上传到Crashlytics服务器。SDK会收集崩溃堆栈、设备信息、应用程序版本等信息，并生成一个唯一的崩溃ID。开发人员可以通过Crashlytics的控制台查看和分析崩溃信息，以便更好地理解和解决应用程序崩溃问题。
除了崩溃报告，Crashlytics还提供了其他功能，如实时崩溃报告、堆栈跟踪、用户和设备信息等，以帮助开发人员更好地理解和解决应用程序崩溃问题。
操作步骤
一、Flutter集成Firebase框架
二、在Firebase网页端查看项目
访问https://console.firebase.google.com/u/0/，点击自己的项目后再点击左侧的发布与监控，然后再点击Crashlytics，即可看到崩溃收集界面
三、在代码中添加crashlytics
在代码功收集错误并上传到云端
安装firebase_crashlytics插件
flutter pub add firebase_crashlytics # ios的额外步骤 cd ios #如果下面指令报错，则删除Podfile.lock文件再执行下面指令 pod install --repo-update |
使用测试的main.dart
import 'dart:async';
import 'dart:io';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_crashlytics/firebase_crashlytics.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'firebase_options.dart';
// Toggle this to cause an async error to be thrown during initialization
// and to test that runZonedGuarded() catches the error
const _kShouldTestAsyncErrorOnInit = false;
// Toggle this for testing Crashlytics in your app locally.
const _kTestingCrashlytics = true;
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
const fatalError = true;
// Non-async exceptions
FlutterError.onError = (errorDetails) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
}
};
// Async exceptions
PlatformDispatcher.instance.onError = (error, stack) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack);
}
return true;
};
runApp(MyApp());
}
class MyApp extends StatefulWidget {
MyApp({Key? key}) : super(key: key);
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
late Future<void> _initializeFlutterFireFuture;
Future<void> _testAsyncErrorOnInit() async {
Future<void>.delayed(const Duration(seconds: 2), () {
final List<int> list = <int>[];
print(list[100]);
});
}
// Define an async function to initialize FlutterFire
Future<void> _initializeFlutterFire() async {
if (_kTestingCrashlytics) {
// Force enable crashlytics collection enabled if we're testing it.
await FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
} else {
// Else only enable it in non-debug builds.
// You could additionally extend this to allow users to opt-in.
await FirebaseCrashlytics.instance
.setCrashlyticsCollectionEnabled(!kDebugMode);
}
if (_kShouldTestAsyncErrorOnInit) {
await _testAsyncErrorOnInit();
}
}
@override
void initState() {
super.initState();
_initializeFlutterFireFuture = _initializeFlutterFire();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Crashlytics example app'),
),
body: FutureBuilder(
future: _initializeFlutterFireFuture,
builder: (context, snapshot) {
switch (snapshot.connectionState) {
case ConnectionState.done:
if (snapshot.hasError) {
return Center(
child: Text('Error: ${snapshot.error}'),
);
}
return Center(
child: Column(
children: <Widget>[
ElevatedButton(
onPressed: () {
FirebaseCrashlytics.instance
.setCustomKey('example', 'flutterfire');
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Custom Key "example: flutterfire" has been set \n'
'Key will appear in Firebase Console once an error has been reported.'),
duration: Duration(seconds: 5),
));
},
child: const Text('Key'),
),
ElevatedButton(
onPressed: () {
FirebaseCrashlytics.instance
.log('This is a log example');
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'The message "This is a log example" has been logged \n'
'Message will appear in Firebase Console once an error has been reported.'),
duration: Duration(seconds: 5),
));
},
child: const Text('Log'),
),
ElevatedButton(
onPressed: () async {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('App will crash is 5 seconds \n'
'Please reopen to send data to Crashlytics'),
duration: Duration(seconds: 5),
));
// Delay crash for 5 seconds
sleep(const Duration(seconds: 5));
// Use FirebaseCrashlytics to throw an error. Use this for
// confirmation that errors are being correctly reported.
FirebaseCrashlytics.instance.crash();
},
child: const Text('Crash'),
),
ElevatedButton(
onPressed: () {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Thrown error has been caught and sent to Crashlytics.'),
duration: Duration(seconds: 5),
));
// Example of thrown error, it will be caught and sent to
// Crashlytics.
throw StateError('Uncaught error thrown by app');
},
child: const Text('Throw Error'),
),
ElevatedButton(
onPressed: () {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Uncaught Exception that is handled by second parameter of runZonedGuarded.'),
duration: Duration(seconds: 5),
));
// Example of an exception that does not get caught
// by `FlutterError.onError` but is caught by
// `runZonedGuarded`.
runZonedGuarded(() {
Future<void>.delayed(const Duration(seconds: 2),
() {
final List<int> list = <int>[];
print(list[100]);
});
}, FirebaseCrashlytics.instance.recordError);
},
child: const Text('Async out of bounds'),
),
ElevatedButton(
onPressed: () async {
try {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('Recorded Error'),
duration: Duration(seconds: 5),
));
throw Error();
} catch (e, s) {
// "reason" will append the word "thrown" in the
// Crashlytics console.
await FirebaseCrashlytics.instance.recordError(e, s,
reason: 'as an example of fatal error',
fatal: true);
}
},
child: const Text('Record Fatal Error'),
),
ElevatedButton(
onPressed: () async {
try {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('Recorded Error'),
duration: Duration(seconds: 5),
));
throw Error();
} catch (e, s) {
// "reason" will append the word "thrown" in the
// Crashlytics console.
await FirebaseCrashlytics.instance.recordError(e, s,
reason: 'as an example of non-fatal error');
}
},
child: const Text('Record Non-Fatal Error'),
),
],
),
);
default:
return const Center(child: Text('Loading'));
}
},
),
),
);
}
} |
添加后运行程序到手机中，项目起来后我们在回到Crashlytics控制台，就可以看到已经添加成功了
此时，iOS的崩溃收集中能会出现请上传 1 个 dSYM 文件以处理崩溃问题。这就需要再进行以下额外步骤了
用Xcode打开项目，点击Runner——>TARGETS——>Runner——>Build Phases中最后一项是否为Run Script，且shell中是否有$PODS_ROOT/FirebaseCrashlytics/upload-symbols 如果有则查看内容和下方步骤中的内容是否一致。如果没有则按照下方步骤添加
在 Firebase 控制台中，前往 settings > 项目设置。向下滚动到“您的应用”卡片，然后点击您的 Firebase Apple 应用以查看该应用的信息，包括其应用 ID，记住这个应用ID，后面能用到
点击+号然后点击New Run Script Phase
在shell下方的输入框中输入以下内容，将1:444101146525:ios:3142748fc11e74b7192174替换你自己的应用ID
$PODS_ROOT/FirebaseCrashlytics/run $PODS_ROOT/FirebaseCrashlytics/upload-symbols --build-phase --validate -ai 1:444101146525:ios:3142748fc11e74b7192174 -- $DWARF_DSYM_FOLDER_PATH/App.framework.dSYM |
然后在Input Files中添加以下内容
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist
$(TARGET_BUILD_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist
$(TARGET_BUILD_DIR)/$(EXECUTABLE_PATH) |
pod install --repo-update |
重新运行iOS程序，执行崩溃代码后再次运行iOS程序。等待一会后刷新崩溃收集后台既可以看到问题没有了
至此所有的配置都完成了，修改回自己的main.dart函数并添加以下内容
void main() async {
//用于确保Flutter的Widgets绑定已经初始化。
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
const fatalError = true;
// Non-async exceptions
FlutterError.onError = (errorDetails) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
}
};
// Async exceptions
PlatformDispatcher.instance.onError = (error, stack) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack);
}
return true;
};
// 如果有其他的初始化内容在这里添加即可
runApp(const MyApp());
} |