Flutter版Logan日志系统使用指南

Flutter版Logan日志系统使用指南

Logan Logan is a lightweight case logging system based on mobile platform. 项目地址: https://gitcode.com/gh_mirrors/log/Logan

什么是Logan

Logan是一款轻量级的移动端日志系统，由美团点评团队开发并开源。它能够高效地收集、存储和管理移动应用产生的日志数据，特别适合在移动应用开发和生产环境中使用。

Flutter版Logan简介

Flutter版Logan是一个插件，它通过MethodChannel调用原生Logan的功能，使得Flutter开发者能够像使用原生Logan一样在Flutter应用中使用它。虽然需要依赖原生部分的Logan实现，但由于Logan本身设计轻量，不会显著增加应用包体积。

核心功能

1. 日志记录：支持按级别记录日志
2. 日志存储：自动管理日志文件存储
3. 日志上传：支持将日志上传到服务器
4. 日志清理：可清理所有本地日志

快速开始

初始化Logan

在使用Logan之前，必须进行初始化操作。初始化可以在Flutter端(FlutterLogan.init)或原生端(loganInit)完成。

重要提示：必须替换示例中的key和iv为你自己的值。建议在新版本中更换key和iv以提高安全性。

String result = '初始化日志失败';
try {
  final bool back = await FlutterLogan.init(
      '0123456789012345',  // 替换为你自己的key
      '0123456789012345',  // 替换为你自己的iv
      1024 * 1024 * 10);    // 最大日志文件大小(10MB)
  if (back) {
    result = '日志初始化成功';
  }
} on PlatformException {
  result = '初始化日志失败';
}

记录日志

String result = '写入日志成功';
try {
  await FlutterLogan.log(10, '这是要记录的日志内容');
} on PlatformException {
  result = '写入日志失败';
}

立即写入文件

默认情况下，日志会先缓存在内存中。如果需要立即写入文件，可以调用flush方法：

String result = '刷新日志成功';
try {
  await FlutterLogan.flush();
} on PlatformException {
  result = '刷新日志失败';
}

高级功能

日志上传

Logan提供了直接上传日志到服务器的功能：

String result = '上传日志到服务器失败';
try {
  final today = DateTime.now();
  final date = "${today.year.toString()}-${today.month.toString().padLeft(2, '0')}-${today.day.toString().padLeft(2, '0')}";
  final bool back = await FlutterLogan.upload(
      'http://your.server.url/logupload',
      date,
      'YourAppId',
      'YourUnionId',
      'YourDeviceId'
      );
  if (back) {
    result = '上传日志到服务器成功';
  }
} on PlatformException {
  result = '上传日志到服务器失败';
}

获取日志文件路径

如果需要自定义上传逻辑，可以先获取日志文件路径：

String result;
try {
  final today = DateTime.now();
  final date = "${today.year.toString()}-${today.month.toString().padLeft(2, '0')}-${today.day.toString().padLeft(2, '0')}";
  final String path = await FlutterLogan.getUploadPath(date);
  if (path != null) {
    result = '上传路径 = ' + path;
    // 在这里实现自定义上传逻辑
  } else {
    result = '获取上传路径失败';
  }
} on PlatformException {
  result = '获取上传路径失败';
}

清理所有日志

String result = '清理日志成功';
try {
  await FlutterLogan.cleanAllLogs();
} on PlatformException {
  result = '清理日志失败';
}

最佳实践建议

1. 密钥管理：务必使用自己的key和iv，并定期更换以提高安全性
2. 初始化时机：建议在应用启动时尽早初始化Logan
3. 日志级别：合理使用不同日志级别(如debug、info、error等)
4. 上传策略：考虑在网络条件良好时上传日志，或实现失败重试机制
5. 日志大小：根据应用需求调整最大日志文件大小

常见问题

1. 初始化失败：检查是否提供了有效的key和iv
2. 写入失败：检查存储权限是否已获取
3. 上传失败：检查网络连接和服务器配置
4. 性能影响：Logan设计轻量，通常不会显著影响应用性能

通过合理使用Flutter版Logan，开发者可以高效地收集和管理应用日志，为问题排查和性能优化提供有力支持。

Logan Logan is a lightweight case logging system based on mobile platform. 项目地址: https://gitcode.com/gh_mirrors/log/Logan