Flutter/DartでのLoggerパッケージを使ってみよう！：初心者向けチュートリアル

flutter

はじめに

皆さんはFlutter/Dart開発中にどのようにデバッグを行っていますか？ 通常、開発中にはコンソールへのログ出力が頻繁に行われますが、その管理はどうしていますか？ 今回は、Loggerパッケージを使った効率的なログ管理方法を紹介します。これは、綺麗な色付きのコンソールログを提供し、開発効率を向上させてくれます。

logger | Dart package
Small, easy to use and extensible logger which prints beautiful logs.
pub.dev

flutterのチュートリアルについてはこちらも参考

初めてのFlutter/Dartマルチプラットフォームアプリ開発チュートリアル
はじめに FlutterはGoogleが開発した、マルチプラットフォームのモバイルアプリ開発のフレームワークです。Flutterを使うと、AndroidとiOSの両方のプラットフォームで同時にアプリを開発することができます。 また、ブラウザ...
nbaboston.net
2023.03.18

Loggerパッケージとは

Loggerパッケージは、Flutter/Dartの開発でログを扱うためのパッケージです。標準のprintステートメントに比べて、より柔軟で美しいログ出力が可能で、ログのレベル指定やカスタムフォーマットなど、多機能なオプションを提供しています。

インストール方法

まずは、Loggerパッケージをプロジェクトに追加しましょう。pubspec.yamlに以下の行を追加します。

dependencies:
  flutter:
    sdk: flutter
  logger: ^1.3.0

その後、ターミナルで flutter pub get コマンドを実行してパッケージを取得します。

Loggerの基本的な使い方

Loggerパッケージの基本的な使用方法は非常にシンプルです。まず、Loggerのインスタンスを作成します。

var logger = Logger();

このインスタンスを使ってログを出力することができます。例えば、以下のようにして情報のログを出力します。

logger.i('This is an informational message.');

‘i’は、このログが’informational’（情報）レベルのログであることを示しています。同様に、’v’（verbose）、’d’（debug）、’w’（warning）、’e’（error）、’wtf’（what a terrible failure）など、さまざまなログレベルを指定することができます。

Loggerのカスタマイズ

Loggerは高度にカスタマイズ可能で、自分だけのLoggerインスタンスを作成することができます。以下に例を示します。

var logger = Logger(
  filter: DevelopmentFilter(),
  printer: PrettyPrinter(),
  output: ConsoleOutput(),
);

上記のコードでは、DevelopmentFilterを使用して開発モードでのみログを出力し、PrettyPrinterを使用してログを整形し、ConsoleOutputを使用してログをコンソールに出力します。これらのクラスはすべてカスタマイズ可能で、自分のニーズに合わせて設定することができます。

サンプルコード

それでは実際にLoggerパッケージを使用したサンプルコードを見てみましょう。

import 'package:logger/logger.dart';

void main() {
  var logger = Logger();

  logger.v('Verbose log');
  logger.d('Debug log');
  logger.i('Info log');
  logger.w('Warning log');
  logger.e('Error log');
  logger.wtf('What a terrible failure log');
}

これを実行すると、各ログレベルに応じて異なる色とフォーマットのログがコンソールに表示されます。

まとめ

以上、Loggerパッケージの紹介とその基本的な使い方、カスタマイズ方法について説明しました。Loggerパッケージを使うことで、ログの出力がより管理しやすく、見やすくなります。開発中に役立つ情報をしっかりとログに残し、デバッグやモニタリングの効率を上げていきましょう。もちろん、Loggerパッケージはさまざまなカスタマイズが可能なので、自分のプロジェクトに最適な設定を見つけてみてください。

参考リンク