Flutter日志监控插件flutter_logcat_monitor的使用

flutter_logcat_monitor 是一个用于通过 logcat 命令行工具监控系统消息、堆栈跟踪等的日志插件。注意，此插件仅在 Android 设备上获取 logcat 日志。

如何使用

1. 创建一个函数来消费 logcat 消息

void _mylistenStream(dynamic value) {
  if (value is String) {
    _logBuffer.writeln(value);
  }
}

2. 注册你的函数作为监听器以获取日志，并在应用中任何地方使用它

FlutterLogcatMonitor.addListen(_mylistenStream);

3. 启动 logcat 监控，传递如 logcat 工具定义的过滤参数

await FlutterLogcatMonitor.startMonitor("*.*");

安装

需要在 AndroidManifest.xml 中添加权限：

<uses-permission android:name="android.permission.READ_LOGS" />

更多安装信息请参见 pub.dev

示例代码

以下是一个完整的示例 demo，展示了如何使用 flutter_logcat_monitor 插件显示和管理日志。

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

import 'package:flutter/services.dart';
import 'package:flutter_logcat_monitor/flutter_logcat_monitor.dart';

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

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  StringBuffer _logBuffer = StringBuffer();
  int _groupValue = 0;

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    try {
      debugPrint('Attempting to add listen Stream of log.');
      FlutterLogcatMonitor.addListen(_listenStream);
    } on PlatformException {
      debugPrint('Failed to listen Stream of log.');
    }
    await FlutterLogcatMonitor.startMonitor("*.*");
  }

  void _listenStream(dynamic value) {
    if (value is String) {
      if (mounted) {
        setState(() {
          _logBuffer.writeln(value);
        });
      } else {
        _logBuffer.writeln(value);
      }
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Flutter Logcat Monitor Example App'),
        ),
        body: Column(
          children: [
            Padding(
              padding: EdgeInsets.all(4),
              child: Text("Logcat log:"),
            ),
            logBoxBuild(context),
            RadioListTile(
              title: Text("logcat filter: *.*"),
              value: 0,
              groupValue: _groupValue,
              onChanged: (int? value) async {
                setState(() {
                  _groupValue = value!;
                  _logBuffer.clear();
                });
                await FlutterLogcatMonitor.startMonitor("*.*");
              },
            ),
            RadioListTile(
              title: Text("logcat filter: flutter,FlutterLogcatMonitorPlugin,S:*"),
              value: 1,
              groupValue: _groupValue,
              onChanged: (int? value) async {
                setState(() {
                  _groupValue = value!;
                  _logBuffer.clear();
                });
                await FlutterLogcatMonitor.startMonitor("flutter:*,FlutterLogcatMonitorPlugin:*,*:S");
              },
            ),
            TextButton(
              child: Text("call debugPrint on flutter"),
              onPressed: () async {
                debugPrint("called debugPrint from flutter!");
              },
              style: TextButton.styleFrom(
                  elevation: 2, backgroundColor: Colors.amber[100]),
            ),
            TextButton(
              child: Text("Clear"),
              onPressed: () async {
                clearLog();
              },
              style: TextButton.styleFrom(
                  elevation: 2, backgroundColor: Colors.amber[100]),
            ),
          ],
        ),
      ),
    );
  }

  Widget logBoxBuild(BuildContext context) {
    return Expanded(
      child: Container(
        alignment: AlignmentDirectional.topStart,
        decoration: BoxDecoration(
          color: Colors.black,
          border: Border.all(
            color: Colors.blueAccent,
            width: 1.0,
          ),
        ),
        child: SingleChildScrollView(
          reverse: true,
          scrollDirection: Axis.vertical,
          child: Text(
            _logBuffer.toString(),
            textDirection: TextDirection.ltr,
            textAlign: TextAlign.start,
            style: TextStyle(
              color: Colors.white,
              fontSize: 14.0,
            ),
          ),
        ),
      ),
    );
  }

  void clearLog() async {
    FlutterLogcatMonitor.clearLogcat;
    await Future.delayed(const Duration(milliseconds: 100));
    setState(() {
      _logBuffer.clear();
      _logBuffer.writeln("log buffer cleared");
    });
  }
}

过滤选项

logcat 的过滤选项如下：

• V：详细（默认）
• D：调试（默认为 ‘*’）
• I：信息
• W：警告
• E：错误
• F：致命
• S：静默（抑制所有输出）

例如：

• *.* 显示所有标签和优先级。
• flutter,FlutterLogcatMonitorPlugin,S:* 显示 flutter 和 FlutterLogcatMonitorPlugin 并抑制所有其他。

通过这些步骤和示例代码，您可以轻松地在您的 Flutter 应用中集成并使用 flutter_logcat_monitor 插件来监控日志。