[Flutter] debugPrint()はReleaseビルドでも出力されてしまう
結論
debugPrint()はprint()と同様、公式ドキュメントに書いてあるとおり、Debugモードのみで使うようにする
if (kDebugMode) {
debugPrint('A useful message');
}
debugPrint()の罠
皆さん、printデバッグしてますか？ その手軽さから使う方は多いと思います。しかし標準出力はアプリ利用者からも簡単に確認できてしまうため、配布版では出力しないよう注意を払う必要があります。
Flutterには標準で3種類の出力方法が存在しています。
- print() [dart:core]
- debugPrint() [flutter/foundation.dart]
- log() [dart:developer]
print()はdart:coreに用意された標準出力用の関数で、これはアプリのビルドモードに関係なく出力されます。リリースモードでの出力を避けるため、そのままの使用は避けkDebugModeの条件で囲うことがデフォルトのLinter Ruleで規定されています(avoid_print)。
avoid_printルールでは、「プロダクションコードではロギングフレームワークを使うこと」「FlutterではdebugPrintを使うor printをkDebugModeで囲うこと」と書かれています。
For production code, consider using a logging framework. If you are using Flutter, you can use debugPrint or surround print calls with a check for kDebugMode
しかし紛らわしいことに、debugPrint()はただのprint()のラッパーであり、特にデバッグモードのみ出力するといった機能は搭載されていません。 リリースモードでも容赦なく出力が垂れ流されます。
そのため結論でも書きましたが、リリースモードでの表示を避けるためには、debugPrint()もkDebugModeで囲うことが要求されます。
この辺りの説明については、最近(2024年1月)になってやっとdebugPrint()のドキュメントに追加されました。
なぜdebugPrint()という名前なのにデバッグオンリーではないのか、という疑問については追加時のPRで議論されていました。
In general, that is the convention in the framework: methods starting with debug* should only be invoked from a debug context. debugPrint is no exception there.
debug接頭辞のついた関数は、デバッグ時のみにおいて使うべきという命名規則らしいです。ややこしいね。
debugPrint()の用途について、実装を追ってみる
モードによる挙動の変化でなければ、print()とdebugPrint()を利用する際の差分は何になるのでしょうか。
各出力方法については、このIssueにまとまっています。
print()では大量のメッセージを一気に出力しようとしたとき、OS側の事情で一部のメッセージが省略されてしまう可能性があります。
debugPrint()では内部にスロットリングの仕組みを持っており、メッセージの流量を調整することでメッセージの省略を防ぐ役割を持っています。
つまりはdebugPrint()のほうが正確にメッセージを出力できるようになっているというわけです。
動きを確かめるため、debugPrint()の実装を追ってみましょう。デフォルトの実装はdebugPrintThrottled()関数です。
debugPrintThrottled()内では、メッセージが行ごとに分割されて_debugPrintBufferに格納されます。そして_debugPrintTask()が呼ばれます。
_debugPrintTask()の中核はwhile文です。ここで_debugPrintBufferが1つづつ、1024*12バイトを超えるまでprint()で出力されます。
ここに至るまで特にデバッグモードなどの分岐はなかったので、リリースモードでも関係なく出力されることがわかると思います。
関数の他の部分では出力の間隔調整のためのStopwatchを動かしています。_kDebugPrintPauseTimeは1秒に指定されており、最後に実行されてから1秒間は_debugPrintTask()の実行がブロックされるようになっています。
これによって1秒間に1024*12バイトのみが出力されるように制御しているというわけです。
ということで実装からもdebugPrint()がリリースモードで出力してしまうことを確認できました。うっかり機密データを流してしまうことのないよう、気をつけましょう。
Discussion