[Java] ログライブラリ(log4j)を使う方法

こんにちは。明月です。

この投稿はJavaで使うログライブラリ(log4j)を使う方法に関する説明です。

ログということはプログラム開発する時にデータ追跡や呼出されたクラスや関数、エラー確認などを調べるため使うライブラリです。

普通に開発する時にはIDEツールを利用してデバックすればデータ追跡ができますが、開発が終わってプログラムをコンパイルやビルドした後、Productionにリリースになったらデータ追跡することはしやすくないです。

でも、完璧なプログラムなら問題ないですが、人間が作ったプログラムなのでバグが必ずあるし、そのバグによって間違い演算してエラーが発生します。エラーが発生する時にデータを追跡ができなければならないですが、それがログ機能によってデータを探せるのができます。

Javaではログライブラリが様々がありますが、その中でlog4jが一番簡単だし、楽なライブラリだと思います。

ログはただエラー追跡だけではなく、ユーザアクションパターンやシステムメモリパターンなどを追跡して様々に統計データを活用することができます。

Javaでlog4jを使うためにmavenレポジトリを通ってlog4jライブラリを連携しなければならないです。

repository - https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core/2.13.1

<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.13.1</version>
</dependency>

実際にプログラムの中で作成しましょう。

import java.io.FileNotFoundException;
import java.io.IOException;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.xml.XmlConfigurationFactory; 	
public class Main {
  // 実行関数
  public static void main(String[] args) throws FileNotFoundException, IOException {	
    // log4j.xmlファイル設定する。
    System.setProperty(XmlConfigurationFactory.CONFIGURATION_FILE_PROPERTY,"d:\\log4j.xml");
	// ログマネージャーを取得する。
    Logger logger = (Logger) LogManager.getLogger(Main.class);
    // ログレベルで作成
	// 致命的なエラーを作成
    logger.fatal("fatal log");
	// 一般エラーを作成
    logger.error("error log");
	// 警告を作成
    logger.warn("warn log");
	// 一般ログを作成
    logger.info("info log");
	// デバックログを作成
    logger.debug("debug log");	
  }	
}

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <appenders>
    <!-- コンソールログ設定 -->
    <Console name="console" target="SYSTEM_OUT">
	  <!-- ログ作成パターン設定 -->
	  <!-- %dは時間、%tは関数名、%pはログレベル、%cはクラス、%mはメッセージ内容%nは改行 -->
      <PatternLayout pattern="%d [%t] %-5p %c - %m%n" />
    </Console>
    <!-- ファイルログ設定 -->
	<!-- ファイルログパス設定 - filename、ファイル名パターン - filePattern -->
    <RollingFile name="file" fileName="d:\logs\all.log" filePattern="./logs/all.%i.%d{yyyy-MM-dd}.log">
	  <!-- ログ作成パターン設定 -->
	  <!-- %dは時間、%tは関数名、%pはログレベル、%cはクラス、%mはメッセージ内容%nは改行 -->
      <PatternLayout pattern="%d [%t] %-5p %c - %m%n" />
	  <!-- ログ限界ファイルサイズ設定、限界サイズに届くとファイルを切り替え -->
      <Policies>
        <SizeBasedTriggeringPolicy size="10MB" />
      </Policies>
	  <!-- 切り替えファイル個数、超えたら削除 -->
      <DefaultRolloverStrategy max="1000" fileIndex="min" />
    </RollingFile>
  </appenders>
  <!-- ログレベル設定 -->
  <loggers>
    <!-- 全体ログ設定 -->
    <root level="ALL">
	  <!-- consoleログ設定 -->
      <appender-ref ref="console" />
	  <!-- ファイルログ設定 -->
      <appender-ref ref="file" />
    </root>
  </loggers>
</configuration>

link - https://logging.apache.org/log4j/2.0/manual/api.html

log4jはConsoleやファイルログ以外にメール送信、データベース設定などがあります。設定によって追加することができます。

link - https://logging.apache.org/log4net/release/manual/configuration.html

ここまでJavaで使うログライブラリ(log4j)を使う方法に関する説明でした。

ご不明なところや間違いところがあればコメントしてください。