flutter_w_log 0.0.3

A logging framework developed in fluent provides a fast and simple logging solution. All logs are saved to the database and can be exported as local files.

flutter_w_log

Language: English | 中文简体

A logging framework developed in fluent provides a fast and simple logging solution. All logs are saved to the database and can be exported as local files.

Features

• Express positioning. The console log contains the number of lines of code. You can click the link address to locate the code location. Vscode / Android studio is supported
• Full log. When the log printing length exceeds 1000 characters, the automatic line feed uses the log length for printing to ensure that the log content is not lost
• Database save. The log will be saved to the local database and the log data will be persisted
• Encrypted save. Allow encryption to save logs to the local database
• Export logs. The amount data in the local database can be exported to the specified file location, and the time period / log level can be filtered and selected

Todo

• Delete log / filter delete database log
• Get log / filter database log

Getting started

In your package pubspec.yaml file add

dependencies:
  #####
  flutter_w_log: ">=0.0.0 <1.0.0"
  #####

Usage

old print()/debugPrint() Quick Usage

import 'package:flutter_w_log/flutter_w_log.dart';

print("_counter $_counter"); // 旧的
printWLog("_counter $_counter"); // 写法1
WLog.print("_counter $_counter"); // 写法2

debugPrint("_counter $_counter"); // 旧的
debugPrintWLog("_counter $_counter"); // 写法1
WLog.debugPrint("_counter $_counter"); // 写法2

Simple Usage

WLog.d("_counter $_counter");// DEBUG
WLog.i("_counter $_counter");// INFO
WLog.w("_counter $_counter");// WARN
WLog.e("_counter $_counter");// ERROR

Export Simple Log

ElevatedButton(
  child: const Text("export today log"),
  onPressed: () {

    WLog.todayLog2File();

    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(content: Text("export today log succeed")),
    );
  },
),
ElevatedButton(
  child: const Text("export all log"),
  onPressed: () {
    WLog.allLog2File();
    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(content: Text("export all log succeed")),
    );
  },
),
ElevatedButton(
  child: const Text("export before one hours log"),
  onPressed: () {
    final end = DateTime.now();
    final start = end.subtract(const Duration(hours: 1));
    WLog.timeLog2File(start, end);
    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(
          content: Text("export before one hours log succeed")),
    );
  },
),

Export Custom Log

tips: When using custom export files, pay attention to file permissions

ElevatedButton(
  child: const Text("export custom log"),
  onPressed: () async {
    // logFilePath
    Directory? directory;
    if (Platform.isAndroid) {
      directory = await getExternalStorageDirectory();
    } else {
      directory = await getApplicationDocumentsDirectory();
    }
    final logFilePath = join(directory!.path, "customLog.txt");
    // DateTime
    final end = DateTime.parse("2022-03-29 13:27:00");
    final start = DateTime.parse("2022-03-17 22:44:00");
    // WLogLevel
    List<WLogLevel> levelList = [WLogLevel.DEBUG, WLogLevel.INFO];
    // export
    WLog.log2File(logFilePath, start, end, levelList);
    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(content: Text("export custom log succeed")),
    );
  },
),

Custom Config

ElevatedButton(
  child: const Text("custom config"),
  onPressed: () {
    WLog.todayLog2File();
    final _conf = WLog.getDefaultConfig();

    _conf.isEnabled = true; // 总开关

    _conf.dvConfig.isEnabled = true; // 调试台开关
    _conf.dvConfig.isWithLevel = true; // 调试台是否打印日志级别
    _conf.dvConfig.isWithFrame = true; // 调试台是否打印代码link
    _conf.dvConfig.isWithFileName = false; // 调试台是否打印打印位置的文件名
    _conf.dvConfig.isWithMethodName = false; // 调试台是否打印打印位置的函数名

    _conf.dbConfig.isEnabled = true; // 数据库开关
    _conf.dbConfig.encryptionEnabled = false; // 数据库是否加密开关
    _conf.dbConfig.encryptionKey = ""; // 数据库加密密钥
    _conf.dbConfig.exportForma = _exportForma; // 数据库导出的模型转换

    WLog.applyConfig(_conf);
  },
),

String _exportForma(WLogModel m) {
  return m.toString();
}

WLog.dart

void printWLog(Object? object) {}
void debugPrintWLog(String? message, {int? wrapWidth}) {}

class WLog {
    static WLogConfig getDefaultConfig() {}
    static void applyConfig(WLogConfig config) {}
    static void print(Object? object) {}
    static void debugPrint(String? message, {int? wrapWidth}) {}

    static void d(String message, {DateTime? now, Frame? frame}) {}
    static void i(String message, {DateTime? now, Frame? frame}) {}
    static void w(String message, {DateTime? now, Frame? frame}) {}
    static void e(String message, {DateTime? now, Frame? frame}) {}


    static Future<File> todayLog2File([
        String? filePath,
        List<WLogLevel> levelList = WLogLevel.values,
    ]) async {}

    static Future<File> allLog2File([
      String? filePath,
      List<WLogLevel> levelList = WLogLevel.values,
    ]) async {}

    static Future<File> timeLog2File(
        DateTime startTime, [
        DateTime? endTime,
        String? filePath,
        List<WLogLevel> levelList = WLogLevel.values,
    ]) async {}

    static Future<File> log2File(
        String logFilePath, [
        DateTime? startTime,
        DateTime? endTime,
        List<WLogLevel>? levelList,
    ]) async {}

}

WLogDioInterceptor

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

class WLogDioInterceptor extends Interceptor {
  Map<int, DateTime> requestTimeMap = {};
  final bool reqPrint;
  final bool resPrint;
  WLogDioInterceptor({this.reqPrint = false, this.resPrint = true});

  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    super.onRequest(options, handler);
    final requestTime = DateTime.now();
    requestTimeMap.putIfAbsent(options.hashCode, () => requestTime);
    if (reqPrint) {
      final StringBuffer sb = StringBuffer();
      sb.write("-----------------------------------------------------------\n");
      sb.write("### http");
      sb.write("#${options.method} ${options.uri}");
      if (options.data != null) sb.write("\n${options.data}");
      sb.write("-----------------------------------------------------------\n");
      debugPrint(sb.toString());
    }
  }

  @override
  void onResponse(Response response, ResponseInterceptorHandler handler) {
    super.onResponse(response, handler);
    if (resPrint) {
      final options = response.requestOptions;
      final requestTime = requestTimeMap[options.hashCode]!;
      final responseTime = DateTime.now();
      final time = responseTime.millisecondsSinceEpoch -
          requestTime.millisecondsSinceEpoch;
      final StringBuffer sb = StringBuffer();
      sb.write(
          "###$requestTime>>>$responseTime Time:${time}ms Status:${response.statusCode}\n");
      sb.write("${options.method} ${options.uri}\n");
      sb.write("-----------------------------------------------------------\n");
      sb.write("${response.data}\n");
      sb.write("-----------------------------------------------------------");
      debugPrint(sb.toString());
    }
  }

  @override
  void onError(DioError err, ErrorInterceptorHandler handler) {
    super.onError(err, handler);
    if (resPrint) {
      final options = err.requestOptions;
      final requestTime = requestTimeMap[options.hashCode]!;
      final responseTime = DateTime.now();
      final time = responseTime.millisecondsSinceEpoch -
          requestTime.millisecondsSinceEpoch;
      final StringBuffer sb = StringBuffer();
      sb.write("###$requestTime>>>$responseTime Time:${time}ms DioError\n");
      sb.write("${options.method} ${options.uri}\n");
      sb.write("-----------------------------------------------------------\n");
      sb.write("${err.type} ${err.message}\n");
      sb.write("-----------------------------------------------------------");
      debugPrint(sb.toString());
    }
  }
}

Thanks

f_logs

Other

You are welcome to put forward your ideas and feedback issues