ロギングの基本: java.util.logging, Log4j, SLF4J

1. なぜロギングが必要か

ロギング ≠ コンソール出力

プログラミングを始めたばかりの頃は、問題の原因を探すにはあちこちに System.out.println("ここにいた！") を差し込めば十分だと感じるかもしれません。これはプログラムが小さく、自分のコンピューターで動かしている間は機能します。しかし、巨大なプロジェクトや24/7で稼働するサーバー、何千人もの人が使うアプリを想像してみてください——各ユーザーの背後でコンソールを見張るわけにはいきません。

ロギングは単なるメッセージ出力ではありません。アプリケーションの動作について、エラー、警告、ビジネスイベント、技術的な詳細を体系的に記録することです。ログはファイルやデータベースに保存でき、ネットワーク経由で送信することもできます——これにより、実行後や実行中にプログラムの挙動を分析できます。

ログの用途

• 問題の診断: 何かがうまくいかなかった場合、ログは最重要の手がかりです。どこでなぜエラーが起きたのかを把握できます。
• 監査とセキュリティ: ログはユーザーの重要な操作を記録し、インシデントの調査に役立ちます。
• デバッグ: 特定条件でしか現れないバグもあり、ログなしでは捕まえられないことがあります。
• モニタリング: ログからアプリの状態、パフォーマンス、「健全性」を追跡できます。

実社会からの例

もし航空機に「ブラックボックス」（フライトログ）がなければ、事故原因の究明はほぼ不可能でしょう。プログラミングにおけるログは、あなたのブラックボックスです。

2. ロギングの基本レベル

ロギングではメッセージのレベルを使うのが一般的です。信号機にたとえると、赤は危険、黄は注意、緑は問題なし、といった具合です。

主なレベル（「大きい」ものから「静かな」ものへ）:

ERROR

WARN

INFO

DEBUG

TRACE

例:

• ユーザーが誤ったパスワードでログインできなかった——これは WARN。
• データベースが壊れた——これは ERROR。
• アプリが起動した——これは INFO。
• ループ内での変数値の出力——これは DEBUG または TRACE。

レベルの選び方

何でもかんでも ERROR にするべきではありません——そうすると本当のエラーが埋もれてしまいます。レベルは意図をもって使い分け、致命的な障害だけをエラーにしましょう。

3. Javaの標準ロギング（java.util.logging）

Java には組み込みのロギングシステム——パッケージ java.util.logging（略して JUL）——が付属しています。これは追加のライブラリを入れなくても常に利用できる「ネイティブ」なツールです。

主なクラス:

• Logger —— ログを書き込むための主要クラス。
• Level —— ロギングレベルの列挙（SEVERE、WARNING、INFO、CONFIG、FINE、FINER、FINEST）。
• Handler —— ログの出力先（ファイル、コンソールなど）を指示するハンドラー。
• Formatter —— メッセージのフォーマットを担う。

JUL の使用例

import java.util.logging.Logger;
import java.util.logging.Level;

public class LoggingExample {
    // クラス名でロガーを取得
    private static final Logger logger = Logger.getLogger(LoggingExample.class.getName());

    public static void main(String[] args) {
        logger.info("アプリケーションが起動しました");
        logger.warning("これは警告です!");
        logger.severe("こちらはエラーです!");

        int x = 42;
        logger.fine("デバッグ用変数 x=" + x); // 既定では出力されない
    }
}

重要: 既定では JUL は INFO 以上のみを出力します。fine などの詳細メッセージを表示するには、ログレベルを設定する必要があります。

ファイルによる設定

JUL は logging.properties（通常は JRE フォルダー内）で設定できます。そこでは次の指定が行えます:

• ロガーの最小レベル
• ログの出力先（ファイル、コンソール）
• メッセージのフォーマット

例（ logging.properties の1行）:

.level=INFO

4. 外部ロギングライブラリ

Log4j (Apache)

Log4j は Java で最も有名なロギングライブラリのひとつです。柔軟で高機能、さまざまなフォーマット、非同期書き込み、ファイルのローテーションなどをサポートします。

Log4j 2 の最小構成（XML）の例:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

コードでの Log4j 2 使用例:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class Log4jExample {
    private static final Logger logger = LogManager.getLogger(Log4jExample.class);

    public static void main(String[] args) {
        logger.info("Hello from Log4j!");
        logger.error("これは Log4j 経由のエラーです");
    }
}

これを動かすには、Maven や Gradle などで Log4j の依存関係をプロジェクトに追加してください。

SLF4J: ロギングのファサード

SLF4J（Simple Logging Facade for Java）は独立したロギングシステムではなく、あなたのコードと具体的な実装（Log4j、Logback、JUL など）の間に入る「薄い層」です。

ファサードを使うことで、一度コードを書けば、たとえ異なるロギングライブラリがそれぞれ別のロガーを使っていても、コードを書き換えることなく実体のロギング実装を差し替えられます。

SLF4J の使用例:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Slf4jExample {
    private static final Logger logger = LoggerFactory.getLogger(Slf4jExample.class);

    public static void main(String[] args) {
        logger.info("こんにちは、SLF4J 経由のロギングです!");
        logger.warn("注意: 何かがうまくいかない可能性があります");
        logger.error("SLF4J 経由のエラー");
    }
}

どう動くのか？

• SLF4J を通してコードを書く。
• 必要な実装（例: Logback や Log4j）を classpath に追加する。
• SLF4J が選択した実装へ呼び出しを橋渡しする。

SLF4J と他ロガーの連携: SLF4J は JUL、Log4j、Logback などの上で動作でき、コードを書き換えずに移行を容易にします。

5. System.out.println とロギングの比較

例1: System.out.println

public class PrintlnExample {
    public static void main(String[] args) {
        System.out.println("アプリケーションが起動しました");
        System.out.println("エラーが発生しました: 何かがうまくいきませんでした");
    }
}

何が問題か:

• メッセージのレベルがない（エラー、情報、警告——すべて同じ）。
• 時間、クラス名、スレッド名がない。
• すべてのメッセージが一箇所に混在する。
• 柔軟に出力を制御できない（例: エラーだけに絞る）。

例2: SLF4J + Logback によるロギング

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingVsPrintln {
    private static final Logger logger = LoggerFactory.getLogger(LoggingVsPrintln.class);

    public static void main(String[] args) {
        logger.info("アプリケーションが起動しました");
        logger.error("エラーが発生しました: 何かがうまくいきませんでした");
    }
}

利点:

• 各メッセージには時間、レベル、クラス名、スレッドが付く。
• レベルでメッセージをフィルタリングできる。
• ファイル出力、ネットワーク送信、整形、アーカイブなどが可能。
• ロギングはスレッドセーフ（マルチスレッドアプリで重要）。

違いのデモ

System.out.println

6. 自分のプロジェクトにロギングを組み込むには

標準ロガー（JUL）の場合

JDK に含まれているので、すぐに使えます:

import java.util.logging.Logger;

public class MyApp {
    private static final Logger logger = Logger.getLogger(MyApp.class.getName());

    public static void main(String[] args) {
        logger.info("これは情報メッセージです");
    }
}

Log4j または SLF4J の場合

1. 依存関係を追加（例: Maven）。

   Log4j 2 の場合:

   <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-core</artifactId>
       <version>2.20.0</version>
   </dependency>
   

   SLF4J + Logback の場合:

   <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
       <version>2.0.7</version>
   </dependency>
   <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>1.4.7</version>
   </dependency>
   

2. 設定ファイルを作成（例: Logback なら logback.xml、Log4j なら log4j2.xml）。
3. コードでロガーを使用（上の例を参照）。

7. ミニアプリ: ロギングを追加する

たとえば、シンプルなコマンドライン電卓があるとします。これにロギングを追加します。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Scanner;

public class CalculatorApp {
    private static final Logger logger = LoggerFactory.getLogger(CalculatorApp.class);

    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        logger.info("電卓を起動しました");

        try {
            System.out.print("最初の数値を入力してください: ");
            int a = Integer.parseInt(scanner.nextLine());
            logger.debug("最初の数値が入力されました: {}", a);

            System.out.print("2つ目の数値を入力してください: ");
            int b = Integer.parseInt(scanner.nextLine());
            logger.debug("2つ目の数値が入力されました: {}", b);

            int sum = a + b;
            logger.info("合計: {}", sum);
            System.out.println("結果: " + sum);
        } catch (NumberFormatException ex) {
            logger.error("数値の入力エラー", ex);
            System.out.println("エラー: 正しい数値を入力してください!");
        } catch (Exception ex) {
            logger.error("不明なエラー", ex);
            System.out.println("エラーが発生しました!");
        }
        logger.info("電卓を終了しました");
    }
}

ここで何が起きているか:

• すべての重要な出来事がログに記録される。
• エラーは ERROR レベルとフルスタックトレース付きでロギングされる。
• プログラム終了後でも、すべての情報を分析できる。

8. ロギングでよくあるミス

よくあるミス1: System.out.println だけでデバッグや診断を行う。
導入段階では便利ですが、実運用のアプリには全く向きません。メッセージのレベルを制御できず、時間も見えず、サーバーで動いているときにログを分析することもできません。

よくあるミス2: ERROR レベルで過剰な情報を記録する。
何でもかんでもエラーとして記録すると、本当に重要なものと単なるデバッグ情報の区別がつかなくなります。

よくあるミス3: 機微情報（パスワード、トークン、カード番号）の記録。
ログは安全であるべきです！他人に見せるべきでない情報は書き込まないでください。

よくあるミス4: ロギングの設定不足。
レベル、フォーマット、保存場所を設定しないと、不要な情報のギガバイトに「溺れる」か、エラーを全く見逃すかもしれません。

よくあるミス5: ロギング用ファサード (SLF4J) を大規模プロジェクトで使わない。
プロジェクトが成長し、ライブラリを切り替える必要が出てきたとき、ファサードがないとつらいものになります。SLF4J を使えば、ログの「エンジン」をコードを書き換えずに容易に切り替えられます。

1

タスク

JAVA 25 SELF, レベル 63, レッスン 0

ロック未解除

工場のエンジニア

工場のエンジニア

オープン

1

タスク

JAVA 25 SELF, レベル 63, レッスン 0

ロック未解除

新しい開発者

新しい開発者

オープン