Flutter日志记录插件weboccult_logger的使用

weboccult_logger 是一个用于Dart的简单且漂亮的日志包，适用于Flutter和Web。您还可以将日志添加到服务器。

开始使用

安装

在您的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  weboccult_logger: any # 替换为具体的版本号。

然后导入该库：

import 'package:weboccult_logger/weboccult_logger.dart';

使用

首先初始化日志记录器：

late Logger logger;

// 初始化Firebase应用
await Firebase.initializeApp();

// 获取应用程序文档目录
Directory dir = await getApplicationDocumentsDirectory();

// 设置firebase为true会将日志上传到Firebase存储
logger = Logger(File(dir.path + '/log.txt'), fireBase: true);

接下来，您可以使用不同级别的日志记录方法：

// 简单的日志记录
logger.info(
  _counter.toString(), // 记录的消息内容
  tag: "debugging", // 日志标签
  uploadToServer: false, // 是否上传到服务器
);

logger.verbose(
  _counter.toString(),
  tag: "debugging",
  uploadToServer: false,
);

logger.debug(
  _counter.toString(),
  tag: "debugging",
  uploadToServer: false,
);

logger.warning(
  _counter.toString(),
  tag: "debugging",
  uploadToServer: false,
);

logger.error(
  _counter.toString(),
  tag: "debugging",
  uploadToServer: true, // 将错误日志上传到服务器
);

异常/堆栈跟踪

当捕获异常时，可以记录异常信息和堆栈跟踪：

try {
  throw Exception('这是一个异常。');
} catch (e, st) {
  logger.error(
    _counter.toString(),
    tag: "debugging",
    uploadToServer: true,
    stackTrace: st, // 堆栈跟踪
  );
}

在服务器上上传的日志文件

上传的日志文件可以在服务器上查看。

示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中使用 weboccult_logger 插件。

import 'dart:developer';
import 'dart:io';

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';
import 'package:weboccult_logger/weboccult_logger.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  late Logger logger;

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

  initLogger() async {
    await Firebase.initializeApp();
    Directory dir = await getApplicationDocumentsDirectory();
    logger = Logger(File(dir.path + '/log.txt'), fireBase: true);
  }

  void _incrementCounter() {
    setState(() {
      _counter++;
    });

    // 记录不同级别的日志
    logger.info(
      _counter.toString(),
      tag: "debugging",
      uploadToServer: false,
    );
    logger.verbose(
      _counter.toString(),
      tag: "debugging",
      uploadToServer: false,
    );
    logger.debug(
      _counter.toString(),
      tag: "debugging",
      uploadToServer: false,
    );
    logger.warning(
      _counter.toString(),
      tag: "debugging",
      uploadToServer: false,
    );
    logger.error(
      _counter.toString(),
      tag: "debugging",
      uploadToServer: true,
    );

    // 捕获异常并记录
    try {
      throw Exception('这是一个异常。');
    } catch (e, st) {
      logger.error(
        _counter.toString(),
        tag: "debugging",
        uploadToServer: true,
        stackTrace: st,
      );
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              '你已经按下了按钮多少次：',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: '增加计数',
        child: const Icon(Icons.add),
      ),
    );
  }
}