Flutter日志监控插件logcat_monitor的使用

Flutter插件logcat_monitor允许通过命令行工具logcat监控系统消息、堆栈跟踪等流。需要注意的是，此插件目前仅在Android设备上获取日志。

使用方法

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

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

2. 注册你的函数作为监听器以获取日志，并在应用内按需使用。

LogcatMonitor.addListen(_mylistenStream);

3. 启动logcat监视器，传递类似于logcat工具中定义的过滤参数。

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

安装

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

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

安装详情请参考：https://pub.dev/packages/logcat_monitor/install

示例

下面是一个完整的示例代码，用于展示如何在Flutter项目中集成和使用logcat_monitor：

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

import 'package:flutter/services.dart';
import 'package:logcat_monitor/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 {
      LogcatMonitor.addListen(_listenStream);
    } on PlatformException {
      debugPrint('Failed to listen Stream of log.');
    }
    await LogcatMonitor.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('Logcat Monitor example app'),
        ),
        body: Column(
          children: [
            Text("Logcat log:"),
            logboxBuild(context),
            Column(
              children: [
                RadioListTile(
                  title: Text("logcat filter: *.*"),
                  value: 0,
                  groupValue: _groupValue,
                  onChanged: (value) async {
                    setState(() {
                      _groupValue = value;
                      _logBuffer.clear();
                    });
                    await LogcatMonitor.startMonitor("*.*");
                  },
                ),
                RadioListTile(
                  title: Text("logcat filter: flutter,LogcatMonPlugin,S:*"),
                  value: 1,
                  groupValue: _groupValue,
                  onChanged: (value) async {
                    setState(() {
                      _groupValue = value;
                      _logBuffer.clear();
                    });
                    await LogcatMonitor.startMonitor(
                        "flutter:*,LogcatMonPlugin:*,*: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: Center(
        child: Container(
          decoration: BoxDecoration(
            color: Colors.black,
            border: Border.all(
              color: Colors.blueAccent,
              width: 1.0,
            ),
          ),
          child: Scrollbar(
            thickness: 10,
            radius: Radius.circular(20),
            child: SingleChildScrollView(
              reverse: true,
              scrollDirection: Axis.vertical,
              child: Text(
                _logBuffer.toString(),
                style: TextStyle(
                  color: Colors.white,
                  fontSize: 14.0,
                ),
              ),
            ),
          ),
        ),
      ),
    );
  }

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

这个示例展示了如何设置和配置logcat_monitor来捕获和显示日志信息。通过切换不同的过滤选项，可以控制哪些类型的日志被显示。此外，还提供了一个按钮用于触发debugPrint，以及一个清除日志的按钮。