ログ出力とデバッグの違いを理解しよう｜Spring Bootで学ぶ動作確認の基本

ログ出力とデバッグの違いを理解しよう

新人と先輩の会話形式で理解しよう

新人

「Spring Bootのアプリを作っているんですが、コンソールにいろいろ出てくるメッセージって全部デバッグ用なんですか？」

先輩

「それは『ログ出力』と呼ばれるもので、デバッグとは少し違うんだ。ログはアプリの動きを記録するもので、デバッグは開発者が動作を調べるための作業なんだよ。」

新人

「なるほど……でも、実際どんな違いがあるんですか？ログ出力って具体的に何をしているんでしょうか？」

先輩

「それじゃあ、Spring Bootでのログ出力の仕組みと、デバッグとの違いを順番に説明していこうか。」

1. ログ出力とは何か

Spring Bootの開発では、アプリケーションの動作状況を記録する「ログ出力」がとても重要です。ログ出力とは、プログラムが実行されたときに、どんな処理が行われたか、どんなエラーが起きたかを確認できるようにする仕組みです。

Spring Bootでは、標準でSLF4JとLogbackという仕組みが組み込まれており、特別な設定をしなくてもコンソールに情報を出力してくれます。例えば、アプリケーションの起動時に「Started Application...」と表示されるのもログ出力の一種です。

このログには、「INFO」「DEBUG」「WARN」「ERROR」などのレベルがあります。これは、出力するメッセージの重要度を表しており、目的に応じて使い分けます。初心者のうちは、まずこの仕組みを理解することが第一歩です。

Spring Bootでのログ出力は、エラーの原因を調べたり、ユーザーの操作履歴を追跡したりするのに役立ちます。たとえば、データベースへの接続エラーや、外部APIの呼び出し失敗などが発生した場合、その詳細をログとして記録しておくことで、後から原因を特定しやすくなります。

pleiades環境でGradleプロジェクトを作成した場合も、このログ出力は自動的に利用可能です。特別な外部ライブラリを追加する必要はありません。もし出力内容を調整したい場合は、application.propertiesでログレベルを変更するだけで対応できます。

例えば、次のように設定すると、アプリ全体のログレベルを「DEBUG」に変更して詳細情報を出力することができます。


# 全体のログレベルをDEBUGに設定
logging.level.root=DEBUG

この設定により、Spring Bootが実行する細かい処理やSQLログなどがコンソールに表示されるようになります。これが、Spring Bootの「ログ出力」の基本的な仕組みです。

ログは「開発中の確認」だけでなく、「運用中の監視」にも役立ちます。特に本番環境では、アプリがどのようなリクエストを受けたか、どんなエラーが発生したかを把握することが非常に重要です。そのため、ログは「アプリの健康状態を記録する日記」のような役割を持っていると言えます。

2. デバッグとは何か

一方で、デバッグとは「プログラムの中で何が起きているかを一時的に確認する作業」です。ログ出力が「アプリの動きを記録する仕組み」であるのに対し、デバッグは「開発者がリアルタイムで動作を確認する方法」です。

Spring Bootのプロジェクトでは、pleiades上でアプリを実行するときに「デバッグ実行」を選ぶことができます。これを使うと、処理の途中でブレークポイントを設定して、変数の中身やメソッドの呼び出し順序を確認できます。これは、エラーの原因を直接追跡するのに便利な方法です。

例えば、次のようなControllerクラスを考えてみましょう。


@Controller
public class DebugExampleController {

    @GetMapping("/debug-test")
    public String debugTest() {
        String message = "Hello Debug!";
        System.out.println(message); // 一時的な出力（デバッグ用）
        return "debug-view";
    }
}

上記のコードでは、System.out.println()を使って一時的にコンソールへ出力しています。これは「ログ出力」ではなく「デバッグ出力」に分類されます。開発中の確認としては便利ですが、運用中に使うべき方法ではありません。

なぜなら、System.out.println()はログレベルの管理ができず、情報の分類もできないためです。これに対して、Spring Bootのログ出力では、必要に応じて「DEBUG」や「INFO」などのレベルを指定できます。

たとえば、次のようにLoggerを使うと、Spring Bootの推奨する方法でログを出力できます。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class LogExampleController {

    private static final Logger logger = LoggerFactory.getLogger(LogExampleController.class);

    @GetMapping("/log-test")
    public String logTest() {
        logger.info("INFOレベルのログです");
        logger.debug("DEBUGレベルのログです");
        logger.error("ERRORレベルのログです");
        return "log-view";
    }
}

このように、Spring BootではLoggerを使って明確にログレベルを指定できます。これにより、必要な情報だけを選んで確認でき、不要な出力を減らすことができます。

また、pleiadesのデバッグ機能を使うと、ブレークポイントを設置して変数の中身をリアルタイムで確認できます。これが「Spring デバッグ方法」の基本です。デバッグではログのように履歴を残すわけではありませんが、特定の不具合を見つけるための強力なツールになります。

つまり、「ログ出力」は後から確認するための記録、「デバッグ」は今起きている動作を調べるための観察、という違いがあります。どちらも開発には欠かせませんが、目的が異なるため、使い分けが大切です。

初心者のうちは、ログとデバッグの違いを意識して使うことで、Spring Bootの動作をより深く理解できるようになります。開発中に「この情報は一時的に確認したいのか」「後からも記録しておきたいのか」を考えることで、自然と正しい出力方法を選べるようになるでしょう。

3. Spring Bootでログを出力する基本設定（application.properties）

ここからは、Spring Boot ログ出力設定の実際の方法を見ていきましょう。pleiadesで作成したGradleプロジェクトでは、デフォルトでapplication.propertiesという設定ファイルが用意されています。このファイルに設定を追加することで、ログの出力内容やレベルを細かく制御できます。

Spring Bootのログ機能は、内部的にLogbackを使用しています。つまり、追加のライブラリを導入しなくても、設定ファイルだけでログレベルを変更したり、特定のパッケージだけ出力を変えたりすることが可能です。

まず、アプリ全体のログレベルを指定するには、次のように設定します。


# アプリ全体のログレベルをINFOに設定
logging.level.root=INFO

この設定により、Spring Bootの起動メッセージや重要な処理のみが出力されるようになります。もし、もっと細かい情報を知りたい場合は、DEBUGレベルに変更するとよいでしょう。


# 全体のログレベルをDEBUGに変更
logging.level.root=DEBUG

これにより、Spring内部の動作やSQLの発行内容など、詳細な情報が出力されます。特にデータベース接続の挙動を確認したいときに役立ちます。

さらに、特定のクラスやパッケージだけログレベルを変更することもできます。例えば、自分で作成したコントローラのログだけを詳細にしたい場合は、次のように設定します。


# 自分のパッケージのみDEBUGで出力
logging.level.com.example.demo=DEBUG

これにより、Spring全体のログはINFOレベルのまま、自分の作成したクラスだけ詳細なログが出るようになります。これが「Spring Boot ログ出力設定」の最も基本的で効果的な使い方です。

また、ログの出力先を変更することも可能です。標準ではコンソール出力ですが、ファイルにも同時に保存したい場合は次のように設定します。


# ログをファイルにも出力する設定
logging.file.name=application.log

この設定を追加すると、プロジェクトの実行ディレクトリに「application.log」というファイルが生成されます。アプリを再起動してもログが残るため、過去のエラーや動作履歴を確認するのに便利です。

pleiades上でSpring Bootアプリを実行すると、Gradleが自動で依存関係を解決してくれるため、特別な手順は必要ありません。開発中はコンソールで確認し、テストや本番ではファイル出力を併用する、という使い分けが現実的です。

4. デバッグ出力との併用方法（System.out.printlnとの違い）

次に、Spring Boot デバッグログの使い方を、よく使われるSystem.out.printlnとの違いから整理してみましょう。初心者が最初に使うのはSystem.out.printlnによる出力ですが、これはあくまで一時的な確認手段にすぎません。

たとえば、次のようなコードを考えてみます。


@Controller
public class OutputCompareController {

    @GetMapping("/compare")
    public String compare() {
        System.out.println("デバッグ用の出力です");
        return "compare-view";
    }
}

この出力はコンソールに表示されますが、ログレベルや出力の分類ができません。また、アプリを再起動すると消えてしまい、後から参照することもできません。そのため、開発中の一時的な確認には向いていますが、エラー調査や運用監視には不向きです。

これに対して、Spring Bootのログ出力を使うと、ログレベルごとに分類し、必要な情報だけを残すことができます。以下のようにLoggerを使って書き換えます。


@Controller
public class OutputCompareController {

    private static final Logger logger = LoggerFactory.getLogger(OutputCompareController.class);

    @GetMapping("/compare")
    public String compare() {
        logger.debug("デバッグログです");
        logger.info("通常の情報ログです");
        return "compare-view";
    }
}

このようにすると、アプリのログ設定に従って出力が制御されます。もしapplication.propertiesでlogging.level.root=INFOに設定していれば、DEBUGログは出力されず、INFO以上のログのみが表示されます。これがSpring Boot デバッグログの便利な点です。

また、Loggerを使えば、メッセージの整形や例外の内容を安全に出力することも可能です。例えば、例外発生時にスタックトレースをログへ出力する場合、次のように書きます。


try {
    int result = 10 / 0;
} catch (Exception e) {
    logger.error("計算中にエラーが発生しました", e);
}

このようにすることで、詳細なエラー内容がログに記録され、問題の特定がしやすくなります。単なるSystem.out.printlnでは、例外情報を適切に扱うことができません。

pleiadesでのデバッグ実行とログ出力は併用できます。デバッグ実行で変数を確認しつつ、ログで全体の流れを追うのが最も効率的です。ログは履歴、デバッグは観察、と目的を分けることが重要です。

5. ログレベル（INFO、DEBUG、ERRORなど）の使い分け方

Spring Bootでは、ログレベルを正しく使い分けることで、開発中と運用中の両方で効率的な情報確認ができます。ここでは主なレベルの違いと使いどころを整理しておきましょう。

・TRACE：最も詳細な情報を出力します。ライブラリ内部の処理を追跡したいときなど、特別な場合にのみ使用します。

・DEBUG：デバッグ時に必要な情報を出力します。開発中にメソッドの実行状況や変数の値を確認したいときに使います。

・INFO：アプリケーションの主要な処理の進行状況を出力します。通常の運用環境ではこのレベルが基本です。

・WARN：異常ではないが注意すべき状態を示します。例えば設定値が推奨範囲外の場合などに使われます。

・ERROR：アプリが正常に動作できない重大な問題を示します。例外や通信エラーが発生したときに使用します。

例えば、ユーザーの登録処理を行うコントローラであれば、次のように使い分けます。


@Controller
public class RegisterController {

    private static final Logger logger = LoggerFactory.getLogger(RegisterController.class);

    @PostMapping("/register")
    public String register(UserForm form) {
        logger.info("ユーザー登録処理を開始しました");
        try {
            // 登録処理
            logger.debug("入力データ: {}", form);
        } catch (Exception e) {
            logger.error("登録中にエラーが発生しました", e);
        }
        return "register-view";
    }
}

このようにINFOで処理の流れを記録し、DEBUGで詳細なデータを出し、ERRORで異常を報告するのが基本です。運用時はINFO以上、開発時はDEBUG以上を出力する設定にするのが一般的です。

この使い分けを意識することで、Spring Bootのログ出力は非常に強力なツールになります。エラー発生時も、どの段階で何が起きたのかをすぐに把握でき、修正がスムーズになります。

また、Spring Bootのログ設定は、pleiadesの実行構成でも簡単に切り替えられます。開発用プロファイルではDEBUG、本番ではINFOといったように、環境に応じて設定を切り替えるのがベストプラクティスです。

このように、ログレベルを理解して使い分けることは、Spring Boot ログ出力設定の基本中の基本です。初心者のうちは、まず「INFO」と「DEBUG」と「ERROR」の3種類を意識的に使い分けていくとよいでしょう。

6. ログを使って問題を特定する実践例（try-catchとの組み合わせ）

ここでは、Spring Boot ログ出力を活用して、実際にエラーの原因を特定する方法を見ていきましょう。開発中にありがちな例として、ユーザー入力によって処理が失敗するケースを考えます。例外処理（try-catch）と組み合わせることで、ログから問題の箇所を素早く突き止めることができます。

例えば、次のようなコントローラを想定してみましょう。


@Controller
public class CalcController {

    private static final Logger logger = LoggerFactory.getLogger(CalcController.class);

    @GetMapping("/calc")
    public String calc(@RequestParam("num") int num) {
        try {
            int result = 100 / num;
            logger.info("計算結果: {}", result);
        } catch (Exception e) {
            logger.error("計算中にエラーが発生しました。入力値: {}", num, e);
        }
        return "calc-view";
    }
}

このコードでは、ゼロ除算のようなエラーが発生した場合に、例外をキャッチしてログに詳細を出力しています。logger.error()に例外オブジェクトを渡すことで、スタックトレースも一緒に記録されます。これにより、どの行でエラーが発生したのかが明確になり、デバッグよりも迅速に原因を追えることがあります。

さらに、ログメッセージに入力値を含めることで、「どのリクエストで失敗したのか」も追跡できます。こうした工夫により、Spring Bootのログは単なる記録ではなく、問題解決のための強力なツールとなります。

このように、try-catchとログ出力を組み合わせることで、デバッグでは見逃しやすい不具合を明確に特定できます。pleiadesのデバッグ機能では一度に一つのリクエストしか確認できませんが、ログを残しておけば複数のユーザー操作を時系列で分析できるのが大きな利点です。

7. デバッグとログの使い分け（開発・テスト・本番での注意点）

Spring Boot デバッグ方法とログ出力は、どちらも開発に欠かせない機能ですが、用途を混同するとトラブルの原因になります。ここでは、環境ごとの使い分け方を整理してみましょう。

開発環境： pleiadesでブレークポイントを設定して、変数の中身や処理の流れをリアルタイムに確認します。必要に応じてlogger.debug()を追加して、実行のたびに重要なデータを記録します。ログはコードの一部として残るため、次回以降の動作確認にも役立ちます。

テスト環境： 自動テストや結合テストでは、デバッグ実行は使わず、ログに出力された内容で処理の正確性を確認します。テスト失敗時にはlogger.error()で原因を記録し、再現性のある形で残すことが重要です。ここではログレベルをDEBUGまたはINFOに設定しておくのが一般的です。

本番環境： 本番ではデバッグ実行を使うことはありません。代わりにINFOレベルやWARNレベルで、システムの動作状況を記録します。ERRORが出力された場合は即座に原因を特定できるように、メッセージを明確に設計しておくことが大切です。

環境ごとの設定はapplication.propertiesで簡単に切り替えられます。次のように設定しておくと便利です。


# 開発環境用（詳細なログを表示）
spring.profiles.active=dev
logging.level.root=DEBUG

# テスト環境用（重要な処理のみ）
spring.profiles.active=test
logging.level.root=INFO

# 本番環境用（必要最低限）
spring.profiles.active=prod
logging.level.root=WARN

Spring Bootではプロファイル機能により、環境に応じて設定を自動で切り替えることができます。pleiades上で実行する際には、「実行構成」から--spring.profiles.active=devなどを指定しておくと便利です。

このように、「デバッグ」はリアルタイムで動作を観察する手段、「ログ」はあとから履歴を追跡する手段と考え、開発・テスト・本番の目的に応じて適切に使い分けることが重要です。

8. 本番環境でのログ設定のコツとセキュリティ上の注意点

最後に、Spring Boot ログ設定注意点として、本番環境で気をつけるべきポイントを整理します。本番では、ログの内容がそのまま外部に漏れると、システムの脆弱性につながる恐れがあります。そのため、出力内容を慎重に設計する必要があります。

まず、個人情報や認証情報をログに出力しないことが鉄則です。たとえば、ユーザーのパスワードやトークンなどをlogger.debug()で出力してしまうと、意図せず漏洩する可能性があります。次のようなコードは避けるべきです。


logger.debug("ログイン試行: ユーザー={}, パスワード={}", username, password);

このような情報は、実際にはログ出力せず、認証結果だけをINFOレベルで記録するようにしましょう。


logger.info("ログイン試行: ユーザー={}", username);

また、ファイル出力する場合は、保存場所にも注意が必要です。アクセス制限のないディレクトリにログを保存すると、外部から閲覧されるリスクがあります。LinuxやWindowsのアクセス権限を正しく設定し、開発者や運用担当者のみがアクセスできるようにしましょう。

さらに、ログのサイズにも注意が必要です。Spring Bootではapplication.propertiesでファイルのローテーションを設定できます。


# ログのファイル出力とローテーション設定
logging.file.name=application.log
logging.logback.rollingpolicy.max-file-size=10MB
logging.logback.rollingpolicy.max-history=7

この設定により、ログが10MBを超えると自動的に新しいファイルに切り替わり、7世代分まで保持されます。本番環境ではログが大量に蓄積するため、こうした管理が必須です。

また、ログレベルを誤ってDEBUGのまま本番運用してしまうと、内部情報やSQL文がすべて出力され、セキュリティ上のリスクが高まります。本番では必ずINFOまたはWARNに設定しておくのが安全です。

最後に、エラー内容を外部に返さず、ログにのみ記録することも重要です。Spring Bootの@Controllerで例外が発生した場合、@ExceptionHandlerを使って画面には一般的なエラーメッセージを表示し、詳細はログに残すように設計します。


@Controller
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(Exception.class)
    public String handleError(Exception e) {
        logger.error("予期せぬエラーが発生しました", e);
        return "error-view";
    }
}

このようにしておけば、ユーザーには安全なエラーページを表示しつつ、開発者はログを通じて問題の詳細を確認できます。これはSpring Boot ログ出力のベストプラクティスのひとつです。

本番環境のログは「記録」と「保護」の両立が大切です。出力内容を絞り込み、アクセス制御を行い、不要な情報を残さないようにすることで、アプリケーションを安全かつ効率的に運用できます。