Java例外情報からログを生成する方法

2年 ago
光, 明
1 minute

Javaでは、ロギングフレームワークを使って例外ログを生成できます。一般的なロギングフレームワークとしては、Log4j、Logback、Javaに標準搭載されたjava.util.loggingなどがあります。

ログフレームワークを利用する前に、関連する依存関係を取り込む必要があります。Log4jの場合、以下の依存関係をプロジェクトのpom.xmlに追加できます。

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

次に、Loggerオブジェクトをコード内で使用して、例外のログを記録します。まず、Log4j関連のクラスとメソッドをインポートする必要があります。

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

例外ログを出力したい場所では、ロケータ（Logger）オブジェクトを作成し、ログレベルに応じたログ出力メソッドを呼び出してログを出力します。例えば、エラーレベルのログはerror()メソッドを使用します。

Logger logger = LogManager.getLogger(YourClass.class);
try {
    // 可能抛出异常的代码
} catch (Exception e) {
    logger.error("发生异常", e);
}

ログ出力では、例外オブジェクトがスタックトレースを含んだ全文で出力されます。スタックトレースには、例外の種類、例外メッセージ、例外の発生箇所などの情報が含まれています。

Log4jの設定ファイルを作成・設定することで、ログの出力フォーマット、出力レベル、出力先などを指定できる。例えば、ログをコンソールやファイルに出力する場合、プロジェクトのリソースディレクトリにlog4j2.xmlファイルを作成し、Log4jの設定ルールに従って設定を行う。

上記は、JavaでLog4jを利用して例外ログを出力する基本的なフローです。他のログフレームワークも同様に、各フレームワークのドキュメントに従って設定や呼び出しを行えば利用できます。

bannerAds