SQL の実行ログを出力しよう

2023/09/18

Webアプリケーション開発では、デバッグや調査のスキルが求められます。特にデータベース操作に関する処理は、多くのWebアプリケーションで中心的な役割を果たすため、これらの動きを理解し適切にトラッキングできることが不可欠です。

Spring Boot を使用する開発者は、設定やデバッグ機能を効果的に活用することで、アプリケーションの動作をより深く理解することができます。今回は SQL のログ出力機能を中心に、その設定方法と活用のポイントを学んでいきます。

SQL のログが必要な理由

SQLのログは、アプリケーションがデータベースとどのように対話しているかを具体的に把握するための重要な手段です。これにより、予期しないデータベースの動作やパフォーマンスの問題を早期に発見し、修正することが可能となります。また、SQLの実行結果やパラメータを確認することで、バグの原因を特定しやすくなります。

Spring Boot での SQL ログの出力方法

Spring Boot で SQL のログを出力するための設定は非常にシンプルです。application.properties ファイルに以下の設定を追加するだけで、該当するリポジトリの SQL がログとして出力されます。

logging.level.com.example.todo.repository=DEBUG

この設定により、com.example.todo.repository パッケージの中で行われるデータベースの操作が DEBUG レベルでログに記録されるようになります。

出力される SQL ログの例

上記の設定を行った後、実際に SQL が実行されると、次のようなログが出力されます。

: ==>  Preparing: SELECT id, summary, description, status FROM tasks WHERE id = ?
: ==> Parameters: 1(Long)
: <==      Total: 1

このログから、実際に実行された SQL、使用されたパラメータ、取得されたレコードの数などの情報を確認できます。実行されたのは SELECT 文で、パラメータとして 1 が渡され、結果として 1 件のレコードが取得されたことがわかります。

実際のデバッグでは、このようなログを確認しながら、アプリケーションの動作を追っていくことになります。

まとめ：効果的なデバッグスキルを身に付けよう

デバッグは開発の大切なステップの一部です。SQLのログ出力機能を利用することで、データベースとの対話を明確にし、問題解決の手助けとなります。効果的なデバッグスキルを身に着け、より品質の高いアプリケーション開発を目指しましょう。