Flutter日志记录插件app_logger的使用

本篇文档将详细介绍如何在Flutter项目中使用app_logger插件来记录异常、HTTP请求和导航日志。

使用

首先，在你的pubspec.yaml文件中添加app_logger依赖：

dependencies:
  app_logger: ^0.0.5

接下来，在你的Dart文件中导入app_logger包：

import 'package:app_logger/app_logger.dart';

然后初始化插件：

void main() {
  AppLogger.init(
    baseUrl: 'https://example.com',
    httpLog: true,
    navigationLog: true,
    appId: 'example',
    appRunner: () => runApp(const MyApp()),
  );
}

接着，你可以修改插件的配置。例如，设置用户信息：

AppLogger.instance.configuration.setUser(
  AppLoggerUser(id: '123123213123', username: 'Mustafa'),
);

对于导航日志，你需要将NavigationLogger实例添加到MaterialApp的navigatorObservers属性中：

MaterialApp(
  navigatorObservers: [NavigationLogger.instance],
  onGenerateRoute: MyRouteFactory().main.onGenerateRoute,
);

对于API日志，你可以在HTTP请求完成后调用HttpLogger来记录日志：

Future<void> getRequest() async {
  final uri = Uri.https('jsonplaceholder.typicode.com', 'todos/1');
  final res = await http.get(
    uri,
    headers: {"content-type": "application/json"},
  );
  HttpLogger.instance.log(
    url: uri.toString(),
    statusCode: res.statusCode,
    header: {},
    requestBody: {},
    responseBody: res.body,
  );
}

参数

以下是AppLogger.init方法的参数列表及其描述：

完整示例代码

下面是完整的示例代码，展示了如何在Flutter项目中使用app_logger插件。

import 'package:app_logger/app_logger.dart';
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:http/http.dart' as http;

void main() {
  AppLogger.init(
    baseUrl: 'https://example.com',
    httpLog: true,
    navigationLog: true,
    appId: 'example',
    appRunner: () => runApp(const MyApp()),
  );
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  initState() {
    super.initState();
    AppLogger.instance.configuration.setUser(
      AppLoggerUser(id: '123123213123', username: 'Mustafa'),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('App Logger'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(onPressed: getRequest, child: const Text('Http Log')),
            ElevatedButton(onPressed: navigationLog, child: const Text('Navigation Log')),
          ],
        ),
      ),
    );
  }

  void navigationLog() {
    // NavigationLogger.instance.log(
    //   const RouteSettings(
    //     name: 'AppLoggerDetailScreen',
    //     arguments: {'userName': 'Mto', 'userId': 1},
    //   ),
    // );
  }

  Future<void> getRequest() async {
    final uri = Uri.https('jsonplaceholder.typicode.com', 'todos/1');
    final res = await http.get(
      uri,
      headers: {"content-type": "application/json"},
    );
    HttpLogger.instance.log(
      url: uri.toString(),
      statusCode: res.statusCode,
      header: {},
      requestBody: {},
      responseBody: res.body,
    );
  }
}