Flutter上下文菜单插件contextual的使用

contextual 是一个强大的 Dart 日志库，提供了结构化日志记录、多种日志级别、灵活格式化等功能。本文将介绍如何在 Flutter 应用中使用 contextual 插件进行日志记录。

安装

首先，在 pubspec.yaml 文件中添加 contextual 依赖：

dependencies:
  contextual: ^1.0.0

然后运行 flutter pub get 来安装依赖。

快速开始

下面是一个简单的示例，展示如何使用 contextual 进行日志记录：

import 'package:contextual/contextual.dart';

void main() {
  // 创建一个 logger 实例
  final logger = Logger()
    ..withContext({'app': 'MyApp'});

  // 基本日志记录
  logger.info('Application started');
  logger.debug('Configuration loaded');
  logger.error('Something went wrong');

  // 带上下文的日志记录
  logger.warning(
    'Database connection failed',
    Context({
      'host': 'localhost',
      'port': 5432,
      'attempts': 3
    })
  );
}

配置

你可以从 JSON 加载配置来设置多个输出通道和格式化器：

final config = LogConfig.fromJson({
  'channels': {
    'console': {
      'driver': 'console',
      'env': 'development',
      'formatter': 'pretty' // 使用 pretty formatter 对控制台输出
    },
    'file': {
      'driver': 'daily',
      'path': 'logs/app.log',
      'days': 7,
      'env': 'production',
      'formatter': 'json' // 使用 JSON formatter 对文件输出
    },
    'slack': {
      'driver': 'webhook',
      'webhookUrl': 'https://hooks.slack.com/...',
      'username': 'Logger',
      'emoji': ':warning:',
      'env': 'production',
      'formatter': 'plain' // 使用 plain text formatter 对 Slack 输出
    }
  },
  'defaults': {
    'formatter': 'plain' // 默认 formatter 如果没有指定 per channel
  }
});

final logger = Logger(config: config);

日志模式

contextual 支持两种日志处理模式：Sink-based 模式和 Listener 模式。

Sink-based 模式（默认）

final logger = Logger(
  sinkConfig: LogSinkConfig(
    batchSize: 50,  // 批量处理前的数量
    flushInterval: Duration(seconds: 5),  // 自动刷新的时间间隔
    maxRetries: 3,  // 失败操作的最大重试次数
    autoFlush: true  // 启用或禁用自动刷新
  )
);

// 确保所有日志在关闭前都被发送
await logger.shutdown();

Listener 模式

final logger = Logger();

// 设置一个简单的监听器
logger.setListener((level, message, time) {
  print('[$time] $level: $message');
});

// 所有日志现在都发送到监听器
logger.info('This goes to the listener');

示例 Demo

以下是一个完整的 Flutter 示例应用，展示如何使用 contextual 进行日志记录：

import 'package:flutter/material.dart';
import 'package:contextual/contextual.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final logger = Logger()
    ..withContext({'app': 'FlutterDemo'})
    ..environment('development')
    ..formatter(PrettyLogFormatter());

  void _logExample() {
    logger.info('User opened the app');
    logger.debug('Loading configuration...');
    try {
      throw Exception('Test exception');
    } catch (e) {
      logger.error(e);
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Contextual Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: _logExample,
              child: Text('Log Example'),
            ),
          ],
        ),
      ),
    );
  }

  @override
  void dispose() {
    // 确保所有日志在应用退出前都被发送
    logger.shutdown();
    super.dispose();
  }
}

结论

contextual 提供了一个灵活且强大的日志解决方案，适用于各种 Dart 应用程序。通过允许每个通道的格式化器，你可以自定义每个日志目的地的输出以满足你的需求。无论是开发简单应用程序还是复杂系统，contextual 都为你提供了实现高效和信息丰富的日志记录所需的工具。

更多详细信息和高级用法，请参考 官方文档。