搜尋套件、儲存庫與 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.

所屬分類

原始碼儲存庫

使用此套件的專案