Flutter项目开发之项目日志和错误捕获

使用框架的功能开发错误的捕获&＃xff0c;可以写项目日志&＃xff0c;可以记录设备信息&＃xff0c;代码如下&＃xff1a;


import &＃39;dart:io&＃39;;
import &＃39;dart:async&＃39;;
import &＃39;package:flutter/foundation.dart&＃39;;
import &＃39;package:path_provider/path_provider.dart&＃39;;
import &＃39;package:device_info/device_info.dart&＃39;;/// ### 记录项目日志、捕获项目错误、缓存所有记录、写入文件、上传服务器
/// * 初始化&＃xff1a;
/// &＃96;&＃96;&＃96;dart
/// ErrorLog.log &＃61; new ErrorLog(
/// reportZone: () async {
/// runApp(new MyApp());
/// },
/// debugMode: true,
/// uploadFile: (file) async {},
/// minutesWait: 30,
/// [fileName: &＃39;error_log.txt&＃39;]
/// );
/// &＃96;&＃96;&＃96;
///
/// ### 项目日志
/// 默认标记的项目日志可以使用相应的方法&＃xff1b;自定义标记的项目日志可以使用基础方法。
/// * 使用方式&＃xff1a;
/// &＃96;&＃96;&＃96;dart
/// ErrorLog.log.debug(&＃39;msg&＃39;*8);
/// ErrorLog.log.info(&＃39;msg&＃39;*8);
/// ErrorLog.log.warn(&＃39;msg&＃39;*8);
/// ErrorLog.log.error(&＃39;msg&＃39;*8);
/// ErrorLog.log.fatal(&＃39;msg&＃39;*8);
/// ErrorLog.log.collectLog(&＃39;msg&＃39;*8, &＃39;error&＃39;); // 都是调用这个基础方法
/// &＃96;&＃96;&＃96;
/// * 输出格式&＃xff1a;
/// #### [2019-04-18 11:50:29.844858][error] msgmsgmsgmsgmsgmsgmsgmsg
///
/// ### 错误报告
/// 错误报告的信息比较多&＃xff0c;标记为&＃96;report&＃96;。
/// * 使用方式&＃xff1a;
/// 自动捕获错误&＃xff0c;不包含 &＃96;try/catch&＃96;&＃xff0c;不包含 &＃96;print&＃96;。
/// * 输出格式&＃xff1a;
/// #### [2019-04-18 14:05:03.578755][report]
/// #### 所有错误信息
///
/// ### 写入文件
/// 所有记录都缓存在一个数组里&＃xff0c;如果&＃96;debugMode&＃96;为真&＃xff0c;打印到控制台&＃xff1b;
/// 否则根据数组索引异步写入文件&＃96;error_log.txt&＃96;&＃xff0c;在初始化时可传参&＃96;fileName&＃96;。
/// * 使用方式&＃xff1a;
/// &＃96;&＃96;&＃96;dart
/// ErrorLog.log.printBuffer(); // 打印记录缓存
/// ErrorLog.log.clearFile(); // 清空记录文件
/// ErrorLog.log.printFile(); // 打印文件内容
/// &＃96;&＃96;&＃96;
///
/// ### 上传服务器
/// 打开应用时上传一次&＃xff0c;然后设置计时器&＃xff0c;建议30分钟上传一次。调试模式下&＃xff0c;没有写入文件&＃xff0c;不会调用上传接口。
/// * 使用方式&＃xff1a;
/// 初始化时传参&＃96;uploadFile&＃96;和&＃96;minutesWait&＃96;&＃xff0c;获取记录的文件&＃96;ErrorLog.log.logFile&＃96;。
///
/// ### 设备信息
/// 使用 [device_info](https://pub.dartlang.org/packages/device_info)&＃xff0c;应用启动时会获取和记录。
/// * 使用方式&＃xff1a;
/// &＃96;&＃96;&＃96;dart
/// await ErrorLog.log.getDeviceInfo(); // 异步返回设备信息
/// &＃96;&＃96;&＃96;
/// * 输出格式&＃xff1a;
/// 字符串&＃xff0c;Future
/// #### [2019-04-24 10:05:11.413469][info] 设备信息 [device_info](https://pub.dartlang.org/packages/device_info)
/// #### [androidInfo] androidId: 1a08f53b320ccfef, ...
///
class ErrorLog {/// 实例&＃xff0c;静态属性static ErrorLog log;/// 捕获错误的区域Function _reportZone;/// 是否调试模式bool _debugMode;/// 缓存记录的数组List _logBuffer;/// 文件记录File _logFile;File get logFile &＃61;> _logFile;/// 文件记录的起点int _startIndex;/// 文件记录的终点int _endIndex;/// 上传记录文件Function _uploadFile;/// 上传时间间隔int _minutesWait;/// 记录文件是否变化bool _fileChange;/// 记录文件的名称String fileName;ErrorLog({&＃64;required Function reportZone, &＃64;required bool debugMode,&＃64;required Function uploadFile,&＃64;required int minutesWait,this.fileName &＃61; &＃39;error_log.txt&＃39;}) {_reportZone &＃61; reportZone;_debugMode &＃61; debugMode;_uploadFile &＃61; uploadFile;_minutesWait &＃61; minutesWait;init();}/// 初始化void init() async {_logBuffer &＃61; [];_startIndex &＃61; 0;_endIndex &＃61; 0;_fileChange &＃61; false;FlutterError.onError &＃61; (FlutterErrorDetails details) {reportError(details);};runZoned(_reportZone, onError: (Object obj, StackTrace stack) {var details &＃61; makeDetails(obj, stack);reportError(details);});_logFile &＃61; await _getLocalFile();info(&＃39;应用启动成功。&＃39;);getDeviceInfo();if( !_debugMode ) _uploadFile(_logFile);Timer.periodic(Duration(minutes: _minutesWait), (timer) async {if ( _fileChange && !_debugMode ) {await _uploadFile(_logFile);_fileChange &＃61; false;}});}/// * 获取设备信息/// * [device_info](https://pub.dartlang.org/packages/device_info)Future getDeviceInfo() async {DeviceInfoPlugin deviceInfo &＃61; DeviceInfoPlugin();String details &＃61; &＃39;设备信息[device_info](https://pub.dartlang.org/packages/device_info)\n &＃39;;try {IosDeviceInfo iosInfo &＃61; await deviceInfo.iosInfo;details &＃43;&＃61; &＃39;[iosInfo] identifierForVendor: ${iosInfo.identifierForVendor}, &＃39;;details &＃43;&＃61; &＃39;isPhysicalDevice: ${iosInfo.isPhysicalDevice}, &＃39;;details &＃43;&＃61; &＃39;localizedModel: ${iosInfo.localizedModel}, &＃39;;details &＃43;&＃61; &＃39;model: ${iosInfo.model}, &＃39;;details &＃43;&＃61; &＃39;name: ${iosInfo.name}, &＃39;;details &＃43;&＃61; &＃39;systemName: ${iosInfo.systemName}, &＃39;;details &＃43;&＃61; &＃39;systemVersion: ${iosInfo.systemVersion}. &＃39;;details &＃43;&＃61; &＃39;\n [iosInfo.utsname] machine: ${iosInfo.utsname.machine}, &＃39;;details &＃43;&＃61; &＃39;nodename: ${iosInfo.utsname.nodename}, &＃39;;details &＃43;&＃61; &＃39;release: ${iosInfo.utsname.release}, &＃39;;details &＃43;&＃61; &＃39;sysname: ${iosInfo.utsname.sysname}, &＃39;;details &＃43;&＃61; &＃39;version: ${iosInfo.utsname.version}. &＃39;;} catch(e) {error(&＃39;无法获取 ios 设备信息。&＃39;);}try {AndroidDeviceInfo androidInfo &＃61; await deviceInfo.androidInfo;details &＃43;&＃61; &＃39;[androidInfo] androidId: ${androidInfo.androidId}, &＃39;;details &＃43;&＃61; &＃39;board: ${androidInfo.board}, &＃39;;details &＃43;&＃61; &＃39;bootloader: ${androidInfo.bootloader}, &＃39;;details &＃43;&＃61; &＃39;brand: ${androidInfo.brand}, &＃39;;details &＃43;&＃61; &＃39;device: ${androidInfo.device}, &＃39;;details &＃43;&＃61; &＃39;display: ${androidInfo.display}, &＃39;;details &＃43;&＃61; &＃39;fingerprint: ${androidInfo.fingerprint}, &＃39;;details &＃43;&＃61; &＃39;hardware: ${androidInfo.hardware}, &＃39;;details &＃43;&＃61; &＃39;host: ${androidInfo.host}, &＃39;;details &＃43;&＃61; &＃39;id: ${androidInfo.id}, &＃39;;details &＃43;&＃61; &＃39;isPhysicalDevice: ${androidInfo.isPhysicalDevice}, &＃39;;details &＃43;&＃61; &＃39;manufacturer: ${androidInfo.manufacturer}, &＃39;;details &＃43;&＃61; &＃39;model: ${androidInfo.model}, &＃39;;details &＃43;&＃61; &＃39;product: ${androidInfo.product}, &＃39;;details &＃43;&＃61; &＃39;supported32BitAbis: ${androidInfo.supported32BitAbis}, &＃39;;details &＃43;&＃61; &＃39;supported64BitAbis: ${androidInfo.supported64BitAbis}, &＃39;;details &＃43;&＃61; &＃39;supportedAbis: ${androidInfo.supportedAbis}, &＃39;;details &＃43;&＃61; &＃39;tags: ${androidInfo.tags}, &＃39;;details &＃43;&＃61; &＃39;type: ${androidInfo.type}. &＃39;;details &＃43;&＃61; &＃39;\n [androidInfo.version] baseOS: ${androidInfo.version.baseOS}, &＃39;;details &＃43;&＃61; &＃39;codename: ${androidInfo.version.codename}, &＃39;;details &＃43;&＃61; &＃39;incremental: ${androidInfo.version.incremental}, &＃39;;details &＃43;&＃61; &＃39;previewSdkInt: ${androidInfo.version.previewSdkInt}, &＃39;;details &＃43;&＃61; &＃39;release: ${androidInfo.version.release}, &＃39;;details &＃43;&＃61; &＃39;sdkInt: ${androidInfo.version.sdkInt}, &＃39;;details &＃43;&＃61; &＃39;securityPatch: ${androidInfo.version.securityPatch}. &＃39;;} catch(e) {error(&＃39;无法获取 android 设备信息。&＃39;);}info(details);return details;}/// 错误报告void reportError(FlutterErrorDetails details) {String errorMeta &＃61; &＃39;[&＃39; &＃43; (new DateTime.now().toString()) &＃43; &＃39;][report]&＃39;;_logBuffer.add(errorMeta &＃43; &＃39;\n&＃39; &＃43; details.toString());if (_debugMode) {print(errorMeta);print(details.toString());} else {_writeFile();}}/// 项目日志collectLog(String line, String label) {String contents &＃61; &＃39;[&＃39; &＃43; (new DateTime.now().toString()) &＃43; &＃39;][&＃39; &＃43; label &＃43; &＃39;] &＃39; &＃43; line;_logBuffer.add(contents &＃43; &＃39;\n&＃39;);if (_debugMode) {print(contents);} else {_writeFile();}}/// 打印文件Future printFile() async {_readLocalFile().then((contents) {print(contents);});}/// 打印缓存Future printBuffer() async {print( _logBuffer.toString() );}/// 清空文件Future clearFile() async {await _logFile.writeAsString(&＃39;&＃39;, mode: FileMode.write);}/// 实时写入文件&＃xff0c;防止意外Future _writeFile() async {int len &＃61; _logBuffer.length;if (len > _endIndex) {_startIndex &＃61; _endIndex;_endIndex &＃61; len;Iterable range &＃61; _logBuffer.getRange(_startIndex, _endIndex);await _writeLocalFile( range.join(&＃39;\n&＃39;) );_fileChange &＃61; true;} }/// 获取文件Future _getLocalFile() async {String dir &＃61; (await getApplicationDocumentsDirectory()).path;return new File(&＃39;$dir/&＃39; &＃43; fileName);}/// 读取文件Future _readLocalFile() async {String contents &＃61; await _logFile.readAsString();return contents;}/// 写入文件Future _writeLocalFile(String contents) async {await _logFile.writeAsString(contents, mode: FileMode.append, flush: false);}/// 构建错误信息FlutterErrorDetails makeDetails(Object obj, StackTrace stack) {return FlutterErrorDetails(exception: obj, stack: stack);}/// 调试void debug(String msg) {collectLog(msg, &＃39;debug&＃39;);}/// 信息void info(String msg) {collectLog(msg, &＃39;info&＃39;);}/// 警告void warn(String msg) {collectLog(msg, &＃39;warn&＃39;);}/// 错误void error(String msg) {collectLog(msg, &＃39;error&＃39;);}/// 致命错误void fatal(String msg) {collectLog(msg, &＃39;fatal&＃39;);}}

参考的文档&＃xff1a;
文件操作
异常捕获
日志处理
设备信息

关联的公众号&＃xff1a;三学子&＃xff0c;满足您不一样的阅读需求。