Flutter日志导出插件log_export的使用

Flutter日志导出插件log_export的使用

log_export 是一个 Flutter 插件，它帮助你在 Android 上导出 logcat 或在 iOS 上导出 stdout 和 stderr 到一个日志文件。这样，当你的测试人员发现一个错误时，他们可以将该文件附加到问题报告中。

注意事项

  • 在 Android 上，可以在任何时候导出文件。
  • 在 iOS 上，只有在没有调试器附加的情况下才能导出日志文件（如果断开调试器连接，你需要重新启动应用后该功能才会生效）。

示例

初始化插件

void main() {
  const isStagingEnvironment = true;
  WidgetsFlutterBinding.ensureInitialized();
  if(isStagingEnvironment) {
    LogExport.init();
  }
  runApp(const MyApp());
}

导出日志文件

try {
  final logFileExportedPath =
      await LogExport.getLogFileExportedPath() ?? '';
  if(logFileExportedPath.isNotEmpty == true) {
    Share.shareFiles([logFileExportedPath], text: 'Log file');
  }
} catch (e,s) {
  print("exportLog error $e $s");
}

完整示例 Demo

以下是完整的示例代码，演示如何初始化插件并导出日志文件。

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:log_export/log_export.dart';
import 'package:share_plus/share_plus.dart';

void main() {
  const isStagingEnvironment = true;
  WidgetsFlutterBinding.ensureInitialized();
  if(isStagingEnvironment) {
    LogExport.init();
  }
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String logFileExportedPath = '未知'; // 初始化为 "未知"

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  // 异步方法，用于导出日志
  Future<void> exportLog() async {
    print("即将导出日志");
    String logFileExportedPath = "";
    
    // 尝试获取日志文件路径，并处理可能的异常
    try {
      logFileExportedPath =
          await LogExport.getLogFileExportedPath() ?? '';
      if(logFileExportedPath.isNotEmpty == true) {
        Share.shareFiles([logFileExportedPath], text: '日志文件');
      }
    } catch (e,s) {
      print("导出日志时发生错误: $e $s");
    }
    
    // 更新 UI 状态
    if (!mounted) return;
    setState(() {
      this.logFileExportedPath = logFileExportedPath;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Column(
            children: [
              Text('导出的日志路径: $logFileExportedPath\n'), // 显示导出的日志路径
              TextButton( // 按钮，点击时调用导出日志方法
                onPressed: () {
                  exportLog();
                },
                child: Text("导出日志"),
              )
            ],
          ),
        ),
      ),
    );
  }
}

更多关于Flutter日志导出插件log_export的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter日志导出插件log_export的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中使用log_export插件来导出日志的详细步骤和代码案例。log_export插件允许你将Flutter应用中的日志导出为文件，以便后续分析和调试。

1. 添加依赖

首先，你需要在pubspec.yaml文件中添加log_export依赖：

dependencies:
  flutter:
    sdk: flutter
  log_export: ^最新版本号  # 请替换为实际的最新版本号

然后运行flutter pub get来安装依赖。

2. 导入插件

在你的Dart文件中导入log_export插件：

import 'package:log_export/log_export.dart';

3. 初始化LogExporter

在应用启动时初始化LogExporter。你可以在main.dart文件中完成此操作：

import 'package:flutter/material.dart';
import 'package:log_export/log_export.dart';

void main() {
  // 初始化LogExporter
  LogExporter.instance.init(
    // 设置日志存储目录（可选，默认为应用文档目录）
    directory: (await getApplicationDocumentsDirectory()).path,
    // 设置日志文件名（可选，默认为"app_logs"）
    fileName: "my_app_logs",
    // 设置日志级别（可选，默认为LogLevel.all）
    logLevel: LogLevel.all,
    // 设置日志格式（可选，默认为LogFormat.json）
    logFormat: LogFormat.json,
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Log Export Example'),
        ),
        body: Center(
          child: LogExportExample(),
        ),
      ),
    );
  }
}

4. 记录日志

使用LogExporter.instance.log方法来记录日志：

class LogExportExample extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ElevatedButton(
          onPressed: () {
            // 记录信息日志
            LogExporter.instance.log(
              LogLevel.info,
              "This is an info log message.",
            );
          },
          child: Text('Log Info'),
        ),
        ElevatedButton(
          onPressed: () {
            // 记录错误日志
            LogExporter.instance.log(
              LogLevel.error,
              "This is an error log message.",
              stackTrace: StackTrace.current(),  // 可选，提供堆栈跟踪信息
            );
          },
          child: Text('Log Error'),
        ),
        ElevatedButton(
          onPressed: () async {
            // 导出日志
            final exportPath = await LogExporter.instance.exportLogs();
            if (exportPath != null) {
              // 显示导出路径（实际应用中，你可能希望以更友好的方式通知用户）
              ScaffoldMessenger.of(context).showSnackBar(
                SnackBar(
                  content: Text("Logs exported to $exportPath"),
                ),
              );
            } else {
              // 处理导出失败的情况
              ScaffoldMessenger.of(context).showSnackBar(
                SnackBar(
                  content: Text("Failed to export logs"),
                  backgroundColor: Colors.red,
                ),
              );
            }
          },
          child: Text('Export Logs'),
        ),
      ],
    );
  }
}

5. 运行应用

现在，你可以运行你的Flutter应用，并使用按钮来记录日志和导出日志。导出的日志文件将保存在你指定的目录中，并且你可以通过文件管理器访问它们。

注意事项

  • 确保你拥有访问设备存储的权限（特别是在Android和iOS上）。
  • log_export插件可能在不同版本的Flutter和Dart中有所不同，因此请参考插件的官方文档和示例代码以获取最新信息。

通过以上步骤，你应该能够在Flutter项目中成功使用log_export插件来导出日志。

回到顶部