搜索插件、代码仓与 APP 分类

插件详情v0.7.0

fimber

适用于 Flutter 的可扩展日志记录 - 基于 Android 上的 Timber,使用类似(在 Dart 语言允许范围内)的方法 API,具有相同的树和种植日志树概念。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
3.4万
喜欢数
78
Pub 分数
140

安装插件

flutter pub add fimber

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Fimber 是一个可扩展的 Flutter 日志包,灵感来自 Android 的 Timber。它提供了一个简洁、一致的日志 API,支持多种日志树,使开发者能够将日志路由到不同的目标,如控制台、文件或远程服务。Fimber 强调简单性和灵活性,支持条件日志记录和结构化输出。其设计与 Timber 的概念高度一致,同时适应 Dart 语言的约束。非常适合在开发和生产环境中进行调试和监控。

适合场景

  • 调试应用程序行为
  • 监控运行时问题
  • 生产环境中的条件日志记录
  • 集中式日志管理
  • 与崩溃报告工具集成
  • 测试日志输出

主要特点

  • 基于树的记录架构
  • 可扩展的日志树系统
  • 与 Android Timber 类似的 API
  • 支持多种输出目标
  • 通过标签进行条件日志记录
  • 简单设置,最小样板

适合对象

  • 寻求结构化日志的 Flutter 开发人员
  • 需要灵活日志路由的团队
  • 需要区分调试和发布模式的应用程序
  • 与外部监控服务集成的项目
  • 熟悉 Android 上 Timber 的开发者

使用建议

  • 高级用例可能需要额外的配置
  • 高频日志记录场景中的性能影响
  • 与功能齐全的日志框架相比,内置格式化功能有限
  • 不适用于大量日志处理或分析
  • 需要手动设置日志树以处理复杂工作流

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Analyze Code Style

fimber

Extensible logging for Dart and Flutter.

Package is based on famous Android logging library API - Timber, this is library for simplify logging for Flutter. Using similar (as far as Dart lang allows) method API with same concepts for tree and planting logging tree. Also check out flutter_fimber which extends fimber to platform specific output and logging style.

Getting Started

To start add using it:

Add fimber to pubspec.yaml
pre-nullsafety
dependencies:
  fimber: ^0.6.6
  • remember about import in file you plan to use Fimber
import 'package:fimber/fimber.dart';

Initialize logging tree on start of your application

void main() {
  Fimber.plantTree(DebugTree());
  // app code here ...
  
  // DebugTree options for time elapsed
  // by default DebugTree will output timestamp of the VM/Flutter app
  // to enable elapsed time since planting the tree log
  Fimber.plantTree(DebugTree.elapsed());
  
}
 
Start using it with static methods:
import 'fimber.dart';


void main() {
  var parameter = 343.0;
  // use directly
  Fimber.i("Test message $argument");
  Fimber.i("Extra error message", ex: Exception("Test thorwable"));
  
  // other log levels
  Fimber.d("DEBUG");
  Fimber.v("VERBOSE");
  Fimber.w("WARN");
  
  try {
    throw Exception("Exception thrown");
  } catch (e, stacktrace) {
    // providing `stacktrace` will better show where issue was thrown
    // if not provided will use log line location.
    Fimber.i("Error caught.", ex: e, stacktrace: stacktrace);
  }
}

This will log the value and grab a TAG from stacktrace - that is little costly and if more logs will be done per second.

Colorize logs - ColorizeStyle

useColors property set to true will use default colors of the logos, you can change the mapping with in colorizeMap for DebugTree and CustomFormatTree The useColors by default is disabled.

ColorizeStyle Aggregates list of AnsiStyle so you can combine styles together.

AnsiStyle is combination of AnsiColor and AnsiSelection values

Here is output of test output.

Colorize Test Output

Create tagged version of Fimber

And use its instance inside class, you can create logger for a dart file or for a class.

var logger = FimberLog("MY_TAG");

void main() {
  
  logger.d("Test message");
}

// or inside a class
class SomeBloc {
  var logger = FimberLog("SomeBloc");
  String fetchMessage() {
    logger.d("About to fetch some data.");
    //...
    var data = "load something";

    logger.d("Retrived data (len = ${data.length}");
    return data;
  }
}
Use block function and pass method that uses logger.

Use this function to log multiple messages with same tag, allows optional return value. Due to nature of auto-tag generation from stacktrace this block only does it once and create local FimberLog instance to pass into the anonymous method.

    var someMessage = "Test message from inside of block";
    var output = Fimber.block((log) {
      log.d("Started block");
      var i = 0;
      for (i = 0; i < 10; i++) {
        log.d("$someMessage, value: $i");
      }
      log.i("End of block");
      return i;
    });
Custon line formatters

Use custom line formatters to define your logging format.


    Fimber.plantTree(CustomFormatTree(
        logFormat: "${CustomFormatTree.TIME_ELAPSED_TOKEN} ${CustomFormatTree
            .MESSAGE_TOKEN} ${CustomFormatTree.TIME_STAMP_TOKEN}"
    ));

Deprecated moved to fimber_io package

import 'package:fimber_io/fimber_io.dart';

    Fimber.plantTree(FimberFileTree("my-Log-File.txt",
        logFormat: "${CustomFormatTree.TIME_ELAPSED_TOKEN} ${CustomFormatTree
            .MESSAGE_TOKEN} ${CustomFormatTree.TIME_STAMP_TOKEN}"
    ));

Use file log tree - the logs will go to a log file (Useful in DartVM apps). There are log rolling with size and time/date interval, so it is possible to setup log output per hour/day or any other time.

see: SizeRollingFileTree or TimedRollingFileTree or use abstract class RollingFileTree to create your own version of rolling log file.

TODO - road map

Licence


   Copyright 2018 Mateusz Perlak

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

所属分类

源码仓库

使用此插件的项目