LogbackでJavaアプリのログをもっと見やすく！

docs

みんな、Javaアプリ開発お疲れ様！前回の記事では、System.out.println()を使ってコンソールにメッセージを出力する方法を学んだけど、実際の開発現場ではもっと高機能なログの仕組みが必須なんだ。今回は、Java界隈でよく使われるLogbackっていうログライブラリについて、一緒に見ていこう！

なぜLogbackを使うの？

System.out.println()でもメッセージは出せるけど、本格的なアプリ開発では色々な不便さが出てくるんだ。

  • ログレベルの制御ができない: 「ここから先はエラーログだけ見たい」「開発中は詳細なログも欲しいけど、本番では最低限のログでいい」みたいな細かい調整ができないよね。
  • 出力先を簡単に変えられない: コンソールだけじゃなくて、ファイルに出力したり、データベースに保存したり、ネットワーク経由で別のサーバーに送ったりしたい場面も多いはず。
  • ログの書式を自由に設定できない: 「いつ、どのクラスから、どんなメッセージが出たか」みたいな情報を綺麗に整形して出力したいよね。

Logbackを使えば、これらの問題を一気に解決できるんだ！

LogbackとLog4j、どっちを使えばいいの？

Javaでログを扱うライブラリとして、Logbackと並んでよく聞くのが「Log4j」だよね。実は、LogbackはLog4jの後継プロジェクトとして開発されたんだ。Log4jの生みの親であるCeki Gülcüさんが、Log4jの経験を活かして、より良いログシステムを目指して作ったのがLogbackなんだよ。

Log4jは長い間Javaの標準的なログライブラリとして広く使われてきたけど、現在は公式にはメンテナンスが終了しているんだ。つまり、新しい機能の追加や、セキュリティ上の問題が見つかっても修正されない可能性が高いってこと。

Logback (Log4j 1.xの後継)

Logbackは、Log4j 1.xの弱点を克服し、より高性能で柔軟なログシステムを目指して作られたよ。Java界隈では広く使われているライブラリだね。

  • 特徴:
    • Log4j 1.xよりも高速: 特に、ファイルへの同期的なログ出力のパフォーマンスが改善されている。
    • メモリ使用量の削減: より効率的にメモリを使うように設計されている。
    • 自動設定リロード: logback.xmlの設定ファイルを変更すると、アプリケーションを再起動しなくても自動で設定が反映される機能がある。これは開発中にすごく便利！
    • より柔軟なフィルタリング: ログレベルだけでなく、メッセージ内容やロガー名などで細かくログをフィルタリングできる。
    • SLF4Jをネイティブサポート: SLF4J (Simple Logging Facade for Java) という共通のログインターフェースを直接実装しているので、Logbackを使っていることを意識せずにログコードを書けるよ。将来的に他のログライブラリに切り替える場合も、コードの変更が少なくて済むんだ。

 

Logbackを使い始める準備

Logbackを使うには、プロジェクトにLogbackのライブラリを追加する必要があるよ。Mavenを使っているなら、pom.xmlに以下の依存関係を追加してね。

XML

<dependencies>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.5.6</version> </dependency>
</dependencies>

💡 補足: Logbackはlogback-coreとlogback-classicの2つのモジュールに分かれているんだけど、通常はlogback-classicを追加すればOK！これにはSLF4J（Simple Logging Facade for Java）っていう、Logbackを直接使うための共通インターフェースも含まれているんだ。

Logbackの基本！ログレベルとロガー

Logbackにはログレベルっていう概念があるんだ。メッセージの重要度に応じて、いくつかのレベルが用意されているよ。

  • TRACE: プログラムの実行を追跡するための、最も細かい情報。
  • DEBUG: デバッグ時に役立つ、詳細な情報。
  • INFO: アプリケーションの進行状況を示す情報。
  • WARN: 潜在的な問題や、注意すべき点。
  • ERROR: エラーが発生したことを示す情報。
  • FATAL: アプリケーションがクラッシュするような、致命的なエラー。

これらのレベルを使って、どの重要度のログを出力するか制御できるんだ。

そして、ログを出力するのがロガー (Logger)。各クラスでロガーのインスタンスを取得して、ログを出力していくよ。

例を見てみよう！

Java

// src/main/java/com/example/MyApplication.java
package com.example;

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

public class MyApplication {

    // ロガーのインスタンスを取得
    private static final Logger logger = LoggerFactory.getLogger(MyApplication.class);

    public static void main(String[] args) {
        logger.trace("これはTRACEレベルのログだよ！");
        logger.debug("これはDEBUGレベルのログだよ！");
        logger.info("これはINFOレベルのログだよ！");
        logger.warn("これはWARNレベルのログだよ！");
        logger.error("これはERRORレベルのログだよ！");

        try {
            int result = 10 / 0; // ゼロ除算で例外を発生させる
        } catch (ArithmeticException e) {
            logger.error("計算中にエラーが発生しました！", e); // 例外情報も一緒にログに出せるよ
        }
    }
}

このコードを実行してみよう！

// 実行結果 (デフォルト設定の場合)
2025-06-21 23:02:56.xxx [main] INFO com.example.MyApplication - これはINFOレベルのログだよ！
2025-06-21 23:02:56.xxx [main] WARN com.example.MyApplication - これはWARNレベルのログだよ！
2025-06-21 23:02:56.xxx [main] ERROR com.example.MyApplication - これはERRORレベルのログだよ！
2025-06-21 23:02:56.xxx [main] ERROR com.example.MyApplication - 計算中にエラーが発生しました！
java.lang.ArithmeticException: / by zero
	at com.example.MyApplication.main(MyApplication.java:20)

あれ？TRACEとDEBUGレベルのログが出てないね？これがログレベルの制御なんだ！

Logbackの設定ファイル logback.xml

Logbackは、logback.xmlっていうXMLファイルを使って色々な設定ができるんだ。このファイルは、通常src/main/resourcesディレクトリに置くよ。

さっきTRACEとDEBUGレベルのログが出なかったのは、デフォルト設定ではINFOレベル以上のログしか出力されないからなんだ。logback.xmlを編集して、出力レベルや出力先を変えてみよう！

基本的なlogback.xmlの例

XML

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>logs/myapp.log</file> <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" />   </root>

</configuration>

このlogback.xmlを配置してから、もう一度MyApplicationを実行してみよう！

// 実行結果 (コンソール)
2025-06-21 23:02:56.xxx [main] TRACE com.example.MyApplication - これはTRACEレベルのログだよ！
2025-06-21 23:02:56.xxx [main] DEBUG com.example.MyApplication - これはDEBUGレベルのログだよ！
2025-06-21 23:02:56.xxx [main] INFO  com.example.MyApplication - これはINFOレベルのログだよ！
2025-06-21 23:02:56.xxx [main] WARN  com.example.MyApplication - これはWARNレベルのログだよ！
2025-06-21 23:02:56.xxx [main] ERROR com.example.MyApplication - これはERRORレベルのログだよ！
2025-06-21 23:02:56.xxx [main] ERROR com.example.MyApplication - 計算中にエラーが発生しました！
java.lang.ArithmeticException: / by zero
	at com.example.MyApplication.main(MyApplication.java:20)

TRACEとDEBUGレベルのログも出力されるようになったね！ さらに、プロジェクトのルートディレクトリにlogsフォルダができて、その中にmyapp.logというファイルが作成されているはずだよ。このファイルを開くと、コンソールと同じ内容のログが出力されているのが確認できるはず！

よく使う設定をもう少し見てみよう！

logback.xmlには色々な設定項目があるんだけど、今回はよく使うものをいくつか紹介するね。

  • アペンダー (Appender): ログの出力先を設定する部分だよ。さっきの例ではConsoleAppender（コンソール出力）とFileAppender（ファイル出力）を使ったけど、他にも色々あるんだ。
    • RollingFileAppender: ファイルがいっぱいになったら新しいファイルに切り替える（ローリングする）ためのアペンダー。日付やファイルサイズでローリングできるから、ログファイルが肥大化するのを防げるよ。
  • エンコーダー (Encoder): ログの書式（フォーマット）を設定する部分。patternタグの中で、色々なキーワードを使って好きなように書式を設定できるんだ。
    • %d: 日付
    • %thread: スレッド名
    • %-5level: ログレベル (5文字で左寄せ)
    • %logger{36}: ロガー名 (最大36文字)
    • %msg: ログメッセージ
    • %n: 改行
  • ロガー (Logger): 特定のパッケージやクラスに対するログレベルを設定できるよ。
    • 例えば、com.exampleパッケージ以下のログだけDEBUGレベルにしたい場合は、以下のように書けるんだ。
    <!– end list –> XML<logger name="com.example" level="DEBUG" /> rootロガーは、明示的に設定されていないすべてのロガーに適用されるデフォルトのロガーだよ。

RollingFileAppenderの例

毎日新しいログファイルを作成するように設定してみよう！

XML

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="DAILY_ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/myapp.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/myapp.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO"> <appender-ref ref="STDOUT" />
        <appender-ref ref="DAILY_ROLLING_FILE" />
    </root>

</configuration>

この設定で実行すると、logsフォルダにmyapp.logの他に、日付付きのログファイル（例: myapp.2025-06-21.log）が作成されるはずだよ。日が替わると新しい日付のファイルが作られていくんだ。

まとめ

今回はLogbackを使って、Javaアプリのログをもっと賢く出力する方法を見てきたよ。

  • Logbackは、ログレベルの制御や出力先の変更、書式設定など、System.out.println()にはない多くの機能を提供してくれる強力なログライブラリ！
  • ログレベルでメッセージの重要度を分類し、必要なログだけを出力できる。
  • src/main/resourcesに置く**logback.xml**ファイルで、Logbackの挙動を細かく設定できる。
  • アペンダーでログの出力先（コンソール、ファイルなど）を、エンコーダーでログの書式を設定する。

これで、君のJavaアプリのログがぐっと見やすくなったはず！デバッグや運用が楽になるから、ぜひ活用してみてね。

もし、もっとログについて深く知りたいなら、以下の記事も見てみるといいかも！

それでは、また次の記事で会おう！

コメント

タイトルとURLをコピーしました