Flutter日志管理插件proxima_logger的使用

简介

强大的日志管理插件proxima_logger

这是一款易于使用且可定制的日志管理插件，可以打印出美观的日志信息。它支持多种自定义选项和样式，让你能够根据需求调整日志输出。

开始使用

1. 添加插件到项目

在pubspec.yaml文件中添加插件：

dependencies:
  proxima_logger: ^x.x.x

然后运行以下命令来安装插件：

dart pub get

2. 创建一个proxima_logger实例

你可以通过设置一些通用的参数来创建一个proxima_logger实例，如日志部分的顺序、边框样式等。

final logger = ProximaLogger(
  settings: (logType) => switch (logType) {
    Log.debug => const LogSettings(
        logParts: [
          LogPart.stack,
          LogPart.message,
        ],
        logDecorations: LogDecorations.rounded(),
      ),
    Log.error => const LogSettings(
        logDecorations: LogDecorations.thick(),
      ),
    Log.wtf || Log.nothing => const LogSettings(
        logDecorations: LogDecorations.thin(),
      ),
    _ => const LogSettings(
        logParts: [
          LogPart.stack,
          LogPart.error,
          LogPart.time,
          LogPart.divider,
          LogPart.message,
        ],
        printEmoji: true,
        printTitle: true,
        printLogTypeLabel: true,
      ),
  }
);

使用方法

你可以在程序的任何地方使用logger.log()或其便捷方法如logger.info, logger.warning, logger.error等来记录日志。

// 记录信息日志
logger.log(
  Log.info,
  title: 'Log title',
);

// 记录调试日志
logger.debug(message: 'Debug message');

// 捕获异常并记录错误日志
try {
  // 你的代码
} catch (e, s) {
  logger.error(
    title: 'Some error',
    error: e,
    stack: s,
  );
}

错误处理

为了自动处理错误，你可以在main()函数中添加runZonedGuarded()方法。

void main() {
  bool recordError(Object error, StackTrace stackTrace) {
    logger.log(Log.error, error: error, stack: stackTrace);
    return true;
  }

  void recordFlutterError(FlutterErrorDetails error) {
    logger.log(Log.error, error: error, stack: error.stack);
  }

  FlutterError.onError = recordFlutterError;
  PlatformDispatcher.instance.onError = recordError;

  runApp(const MyApp());
}

自定义日志类型

你可以创建自己的日志类型，并将其集成到proxima_logger中。

enum Log implements ILogType {
  custom(
    label: 'custom',
    emoji: '🦄',
    ansiPen: AnsiPen.purple(),
  );

  [@override](/user/override)
  final String label;
  [@override](/user/override)
  final String emoji;
  [@override](/user/override)
  final AnsiPen ansiPen;
  [@override](/user/override)
  final AnsiPen ansiPenOnBackground;

  const Log({
    required this.label,
    required this.emoji,
    required this.ansiPen,
    this.ansiPenOnBackground = const AnsiPen.black(),
  });
}

日志输出示例

完整示例代码

下面是一个完整的示例代码，展示了如何使用proxima_logger来记录各种类型的日志。

import 'package:dio/dio.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

import 'logger.dart' show Log;

import 'logger.dart' show logger;
//or
//import 'logger_custom.dart' show logger;

import 'src/large_nesting_widget.dart';
import 'src/model.dart';

void main() {
  bool recordError(Object error, StackTrace stackTrace) {
    logger.log(Log.error, error: error, stack: stackTrace);
    return true;
  }

  void recordFlutterError(FlutterErrorDetails error) {
    logger.log(Log.error, error: error, stack: error.stack);
  }

  FlutterError.onError = recordFlutterError;
  PlatformDispatcher.instance.onError = recordError;

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  bool b = false;
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () {
                logger.log(
                  Log.info,
                  title: 'Info Title',
                  error: Exception('wepijfowief'),
                );
              },
              child: const Text('info'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                logger.log(
                  Log.debug,
                  message: 'Debug message',
                );
              },
              child: const Text('debug'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                logger.log(
                  Log.warning,
                  error: Exception('warning'),
                );
              },
              child: const Text('warning'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                try {
                  throw Exception('Error');
                } catch (e, s) {
                  logger.log(
                    Log.error,
                    title: 'ElevatedButton error',
                    error: e,
                    stack: s,
                  );
                }
              },
              child: const Text('error'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                logger.log(
                  Log.wtf,
                );
              },
              child: const Text('wtf'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                logger.log(
                  Log.wtf,
                  title: 'Task json',
                  error: Exception('WTF EXCEPTION'),
                  message: Task.random().toMap(),
                );
              },
              child: const Text('json'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                setState(() {
                  b = !b;
                });
              },
              child: const Text('exception'),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () async {
                final response = await Dio(
                  BaseOptions(
                    baseUrl: 'https://realty.neirodev.ru/mehanik/',
                    connectTimeout: const Duration(seconds: 10),
                  ),
                ).get(
                  '/partAnnouncements',
                  queryParameters: {
                    'pageNum': 0,
                    'pageSize': 1,
                  },
                );
                logger.log(
                  Log.response,
                  title:
                      '| ${response.requestOptions.method} | ${response.statusCode} | ${response.requestOptions.path}',
                  message: response.data,
                );
              },
              child: const Text('request'),
            ),
            if (b) const LargeNestingWidget(),
          ],
        ),
      ),
    );
  }
}