Apache Commons Logging

Apache Commons LoggingはApache Commonsプロジェクトの一つで、Javaにおけるロギングの共通インタフェースを定めています。Apache Log4jなど、さまざまなロギング実装がこのインタフェースを採用しています。

使い方

JavaクラスからApache Commons Logginを使うには、以下のimport文を記述する。

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

各クラス定義において、以下のようにlog属性を宣言および初期化する。

public class Example
{
  private Log log = LogFactory.getLog(Example.class);
}

インタフェース

Apache Commons Loggingのインタフェース一覧
インタフェース 説明
Log ログ処理のAPIを抽象化したインタフェース

クラス

Apache Commons Loggingのクラス一覧
クラス 説明
LogFactory Logインスタンスを生成するファクトリ

org.apache.commons.logging.LogFactoryクラス

org.apache.commons.logging.LogFactoryクラスのメソッド
戻り値の型 メソッド 説明
static Log getLog(Object clazz ) 指定したオブジェクトのロガーを返す。
static Log getLog(String name ) 指定した名称のロガーを返す。

org.apache.commons.logging.Logインタフェース

org.apache.commons.logging.Logインタフェースのメソッド
メソッド 説明
debug 指定したメッセージをdebugログレベルでログに出力する。
error 指定したメッセージをerrorログレベルでログに出力する。
fatal 指定したメッセージをfatalログレベルでログに出力する。
info 指定したメッセージをinfoログレベルでログに出力する。
isDebugEnabled debugレベルのログ処理が現在有効か否かを返す
isErrornabled errorレベルのログ処理が現在有効か否かを返す
isFatalEnabled fatalレベルのログ処理が現在有効か否かを返す
isInfoEnabled infoレベルのログ処理が現在有効か否かを返す
isTraceEnabled traceレベルのログ処理が現在有効か否かを返す
isWarnEnabled warningレベルのログ処理が現在有効か否かを返す
trace 指定したメッセージをtraceログレベルでログに出力する。
warn 指定したメッセージをwarnログレベルでログに出力する。

debug

debugレベルのログを出力する。

void debug(Object message)

debugレベルのログを出力する例を示す。

Logger logger = Logger.getLogger(MyApp.class);
logger.debug("Hello world!");

isDebugEnabled

debugレベルのログを出力するかどうかを返す。

boolean isDebugEnabled()

debugレベルのログを出力する例を示す。

if (log.isDebugEnabled()) {
  log.debug("名前=" + name);
}

参考文献

The Apache Software Foundation (2021) Apache Commons Logging - Overview