Flutter日志记录插件fiona_logger的使用

本包可以帮助您记录应用程序的消息。

功能

使用FionaLogger可以将您的应用程序消息记录到不同的存储库中。存储库可以是系统控制台、文件、数据库表等，您可以定义任何想要作为存储库的东西。

入门

该包实现了一个简单的存储库，用于将消息写入系统控制台，但之后您可以定义自己的自定义存储库。

要了解该想法和结构，您可以阅读这篇文章： https://medium.com/nerd-for-tech/logger-for-flutter-how-to-log-your-messages-in-flutter-944df9be487c

使用方法

您可以在example目录下找到一个完整的示例。

您必须使用GetIt包来注册日志及其存储库。该包包含使用系统控制台（LogInConsole）的存储库。

GetIt.instance.registerFactory<LogDataRepository>(() => LogInConsole());
GetIt.instance.registerFactory<FionaLogger>(() => FionaLogger(level: Level.verbose));

然后您就可以使用它：

FionaLogger logger = GetIt.instance<FionaLogger>();

logger.d("一条调试信息");
logger.i("一条信息");
logger.e("一条错误信息");

您还可以定义自己的存储库。例如，在我的项目中，我使用了这个包，并创建了一个LogDataRepository来使用SQLite：

class LogDataSQLite implements LogDataRepository {

  SQLiteDatabase _sqlite = DependencyManager().get<SQLiteDatabase>();

  [@override](/user/override)
  Future<void> clear() async {
    final Database db = await _sqlite.initializeDB();
    try {
      await db.delete(SQLiteScheme.logData_tableName);
    } catch (err) {
      // 错误处理
    }
  }

  [@override](/user/override)
  Future<void> add(LogData logData) async {
    final Database db = await _sqlite.initializeDB();
    await db.insert(
        SQLiteScheme.logData_tableName, logData.toMap(),
        conflictAlgorithm: ConflictAlgorithm.replace);
  }

  [@override](/user/override)
  Future<List<LogData>> getAll() async {
    final Database db = await _sqlite.initializeDB();
    final List<Map<String, Object?>> queryResult =
    await db.query(SQLiteScheme.logData_tableName, orderBy: 'datetime DESC');
    return queryResult.map((e) => LogData.fromMap(e)).toList();
  }
}

然后在项目的启动设置中，注入该数据存储库的依赖项：

GetIt.instance.registerLazySingleton<LogDataRepository>(() => LogDataSQLite());

示例代码

以下是一个完整的示例代码，展示了如何使用fiona_logger插件进行日志记录。

import 'package:fiona_logger/fiona_logger.dart';
import 'package:flutter/material.dart';
import 'package:get_it/get_it.dart';

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

  // 注册日志存储库和FionaLogger
  GetIt.instance.registerFactory<LogDataRepository>(() => LogInConsole());
  GetIt.instance
      .registerFactory<FionaLogger>(() => FionaLogger(level: Level.verbose));

  runApp(const MyApp());
}

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

  // 应用程序根组件
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'i18n Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: MyHomePage(title: 'i18n Example Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({super.key, required this.title});
  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  FionaLogger logger = GetIt.instance<FionaLogger>();

  [@override](/user/override)
  Widget build(BuildContext context) {
    List<Widget> children = List.empty(growable: true);

    String message = "Example message to log";

    children.add(Center(
        child: Text(
      "FionaLogger示例",
      style: const TextStyle(fontSize: 20),
    )));

    children.add(Row(
      crossAxisAlignment: CrossAxisAlignment.center,
      children: [
        Expanded(
            flex: 5,
            child: ElevatedButton(
              onPressed: () async {
                logger.d(message); // 记录调试信息
                setState(() {});
              },
              child: const Text("调试日志"),
            )),
        Expanded(
            flex: 5,
            child: ElevatedButton(
              onPressed: () async {
                logger.i(message); // 记录信息日志
                setState(() {});
              },
              child: const Text("信息日志"),
            ))
      ],
    ));

    children.add(Row(
      crossAxisAlignment: CrossAxisAlignment.center,
      children: [
        Expanded(
            flex: 5,
            child: ElevatedButton(
              onPressed: () async {
                logger.e(message); // 记录错误日志
                setState(() {});
              },
              child: const Text("错误日志"),
            )),
        Expanded(
            flex: 5,
            child: ElevatedButton(
              onPressed: () async {
                logger.w(message); // 记录警告日志
                setState(() {});
              },
              child: const Text("警告日志"),
            )),
      ],
    ));
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: ListView(
        children: [
          Padding(
            padding: const EdgeInsets.all(10),
            child: Column(
              children: children,
            ),
          )
        ],
      ),
    );
  }
}