Flutter日志记录插件flogged的使用

Flutter日志记录插件flogged的使用

flogged 是一个用于将日志发送到 Logstash 实例的日志记录器。它依赖于 lumberdash 包。

安装与配置

1. 添加依赖包

在 pubspec.yaml 文件中添加以下内容：

dependencies:
  # 其他依赖项...
  lumberdash: ^2.1.1 # flogged 需要此包才能正常工作
  flogged:
    git: git@github.com:netsells/flogged

2. 设置 Android 清单文件

在 AndroidManifest.xml 文件中的 <application> 标签内添加以下属性：

android:usesCleartextTraffic="true"

3. 更新 Info.plist 文件

在 Info.plist 文件中添加以下内容，并替换为实际的 Logstash 实例域名：

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
    <key>NSExceptionDomains</key>
    <dict>
        <key>my.logstash.instance</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
    </dict>
</dict>

4. 初始化日志记录器

在 main.dart 文件中，在调用 runApp 之前添加以下代码：

import 'package:flogged/flogged.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:lumberdash/lumberdash.dart';
import 'package:package_info/package_info.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 动态获取应用版本信息
  final pInfo = await PackageInfo.fromPlatform();
  
  // 初始化日志记录器
  putLumberdashToWork(withClients: [
    FloggedLumberdash(
      appName: 'Flogged Test',
      appVersionName: pInfo.version,
      appVersionCode: int.parse(pInfo.buildNumber),
      environment: kReleaseMode ? 'production' : 'debug',
      logstashUrl: 'http://my.logstash.instance',
      logstashPort: 5001,
    ),
  ]);

  runApp(MyApp());
}

5. 记录日志

在应用程序中添加按钮来记录消息和异常：

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

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

class _MyHomePageState extends State<MyHomePage> {
  void logMessage(String message) {
    log(message); // 记录普通消息
  }

  void logError(dynamic error, {StackTrace? stacktrace}) {
    log(error, level: LogLevel.error, stacktrace: stacktrace); // 记录错误
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          ElevatedButton(
            child: const Text('Log Message'),
            onPressed: () {
              logMessage('This is a test message!');
            },
          ),
          ElevatedButton(
            child: const Text('Log Exception'),
            onPressed: () {
              try {
                final l = [0, 1, 2];
                final i = l[4]; // 故意引发 RangeError 异常
              } on RangeError catch (e, stacktrace) {
                logError(e, stacktrace: stacktrace);
              }
            },
          ),
        ],
      ),
    );
  }
}

更多关于Flutter日志记录插件flogged的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter日志记录插件flogged的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


flogged 是一个用于 Flutter 应用的日志记录插件，它可以帮助开发者更轻松地管理和记录应用中的日志信息。以下是 flogged 插件的基本使用步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 flogged 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  flogged: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 初始化 flogged

在你的应用的 main.dart 文件中，初始化 flogged：

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

void main() {
  // 初始化 flogged
  Flogged.init(
    logLevel: LogLevel.verbose, // 设置日志级别
    showTime: true,             // 是否显示时间
    showEmoji: true,            // 是否显示表情符号
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flogged Example',
      home: HomeScreen(),
    );
  }
}

3. 使用 flogged 记录日志

在你的应用中，你可以使用 flogged 提供的不同方法来记录日志。flogged 支持多种日志级别，包括 verbose, debug, info, warning, error, 和 wtf。

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

class HomeScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // 记录不同级别的日志
    Flogged.v("This is a verbose log.");
    Flogged.d("This is a debug log.");
    Flogged.i("This is an info log.");
    Flogged.w("This is a warning log.");
    Flogged.e("This is an error log.");
    Flogged.wtf("What a terrible failure!");

    return Scaffold(
      appBar: AppBar(
        title: Text('Flogged Example'),
      ),
      body: Center(
        child: Text('Check the console for logs.'),
      ),
    );
  }
}

4. 日志级别

flogged 允许你通过 LogLevel 来设置日志的级别。只有高于或等于指定级别的日志才会被记录。例如，如果你设置 LogLevel.warning，那么只有 warning, error, 和 wtf 级别的日志会被记录。

Flogged.init(
  logLevel: LogLevel.warning, // 只记录 warning 及以上级别的日志
  showTime: true,
  showEmoji: true,
);

5. 自定义日志输出

你可以通过 Flogged.init 方法来自定义日志的输出格式和行为。例如，你可以选择是否显示时间、是否显示表情符号等。

6. 日志文件输出（可选）

flogged 还支持将日志输出到文件中。你可以通过以下方式将日志保存到文件中：

Flogged.init(
  logLevel: LogLevel.verbose,
  showTime: true,
  showEmoji: true,
  logToFile: true, // 启用日志文件输出
  logFilePath: '/path/to/logfile.txt', // 指定日志文件路径
);

7. 清空日志文件

你可以使用 Flogged.clearLogFile() 方法来清空日志文件。

Flogged.clearLogFile();

8. 获取日志文件内容

你可以使用 Flogged.getLogFileContent() 方法来获取日志文件的内容。

String logContent = await Flogged.getLogFileContent();
print(logContent);
回到顶部