Flutter日志管理插件flutter_xlog的使用

flutter_xlog

这是一个用于在Flutter项目中使用腾讯Mars-XLog的日志管理插件。

使用

导入包

首先，你需要在pubspec.yaml文件中添加flutter_xlog依赖。然后在你的Dart文件中导入这个包：

import 'package:flutter_xlog/flutter_xlog.dart';

打开XLog

在使用XLog之前，你需要先调用XLog.open()方法来初始化XLog。以下是一个示例：

import 'dart:io';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_xlog/flutter_xlog.dart';
import 'package:path_provider/path_provider.dart';

var cacheDir = '';
var logDir = '';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 获取缓存目录
  cacheDir = (await getApplicationCacheDirectory()).path;

  // 根据平台获取日志目录
  if (Platform.isAndroid) {
    logDir = (await getExternalCacheDirectories())?[0].path ?? cacheDir;
  } else if (Platform.isIOS) {
    logDir = (await getApplicationSupportDirectory()).path;
  }

  // 初始化XLog
  await XLog.open(XLogConfig(cacheDir: cacheDir, logDir: logDir, consoleLogOpen: true));

  // 启动应用
  runApp(const MyApp());
}

写日志

在应用运行过程中，你可以使用XLog类的不同方法来记录不同级别的日志。例如：

class _MyAppState extends State<MyApp> {

  @override
  Widget build(BuildContext context) {
    // 记录信息级别的日志
    XLog.i("MyApp", "build _MyAppState");

    // 在隔离进程中记录日志
    compute((message) {
      XLog.i("MyApp", "$message in Isolate");
    }, "compute in build");

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('FlutterXLog example app'),
        ),
        body: Column (
          children: [
            Text('缓存的XLog位于$cacheDir\n写入的XLog位于$logDir\n'),
            TextButton(onPressed: () {
              XLog.i("MyApp", "点击事件");
              XLog.close();
            }, child: const Text('关闭XLog'))
          ]
        ),
      ),
    );
  }
}

关闭XLog

如果你需要切换用户账户，可能需要关闭XLog。可以使用XLog.close()方法来关闭它：

TextButton(onPressed: () {
  XLog.i("MyApp", "点击事件");
  XLog.close();
}, child: const Text('关闭XLog'))

Android问题

保持XLog类在proguard文件中

如果你使用了ProGuard来混淆代码，你需要确保保留XLog相关的类。在你的ProGuard配置文件中加入以下规则：

-keep class com.tencent.mars.** { *; }

选择libc++_shared

当你以调试模式运行时，可能会遇到这样的问题：

2 files found with path 'lib/arm64-v8a/libc++_shared.so' from inputs:
- xxxx
- xxxx

为了解决这个问题，你可以将libc++_shared.so复制到你的应用项目中，并在build.gradle中进行选择：

packagingOptions {
    pickFirst 'jniLibs/armeabi-v7a/libc++_shared.so'
    pickFirst 'jniLibs/arm64-v8a/libc++_shared.so'
}