public class TLogger extends Object implements org.apache.commons.logging.Log
CommonsLoggingのロガーをラップしたロガーです。
ログメッセージをプロパティファイルで管理し、ログ出力メソッドの引数にログIDを渡すことで、プロパティファイル中のログIDに対するメッセージを出力できます。
ロガーの取得は他のロガーライブラリとほぼ同じです。
TLogger logger = TLogger.getLogger(XX.class); または TLogger logger = TLogger.getLogger("カテゴリ名");
次のようなログメッセージプロパティファイルがある場合
DEB001=debug message ERR001=error message
このメッセージを出力するには
logger.debug("DEB001"); logger.error("ERR001");
のようにログレベルに応じたメソッドにログIDを渡して実行します。 出力メッセージは
[DEB001] debug message [ERR001] error message
となります。メッセージの前に[ログID]が自動で付きます。
ログレベルは
log(String logId)
メソッドを使用すると、ログIDの一文字目を見てログレベルを判断します。
出力するログメッセージを作成する際に、MessageFormat
を使用しています。置換パラメータを可変長配列で渡すことができます。
DEB002={0} is {1}.
という定義がある場合、
logger.debug("DEB002", "hoge", "foo");
を実行すると出力メッセージは
[DEB002] hoge is foo.
となります。
内部でメッセージ文字列を作成する際にログレベルのチェックを行っているので、
if (logger.isDebugEnabled()) { logger.debug("DEB002", "hoge", "foo"); }
というif文を書く必要がありません。(ただし、 パラメータを作成する際にメソッドを呼び出している場合はif文を書いて明示的にログレベルチェックを行ってください。)
メッセージプロパティファイル中のログIDを渡す他に、直接メッセージを渡す方法があります。第1引数にfalse を設定し、第2引数にメッセージ本文を直接記述できます。第3引数以降は置換パラメータです。この場合は当然ログIDは出力されません。
logger.warn(false, "warn!!"); logger.info(false, "Hello {0}!", "World");
出力メッセージは
warn!! Hello World!
となります。
クラスパス直下のMETA-INF
ディレクトリにterasoluna-logger.properties
を作成してください。
terasoluna-logger.properties
のmessage.basename
キーにメッセージプロパティファイルのベースネームをクラスパス相対(FQCN)で設定してください。
ResourceBundle
で読み込むので、国際化に対応しています。
message.basename = hoge
と書くとクラスパス直下のhoge.propertiesが読み込まれます。
message.basename=hoge,foo,bar
のように半角カンマ区切りで設定すると全てを読み込みます。
META-INF/terasoluna-logger.properies
の
message.basename
はモジュール毎に設定できます。 ロガーは全てのモジュール(jar)が持つ、
message.basename
の値をマージしてメッセージを取得します。
これにより、モジュール毎にログメッセージを管理することができます。
ログ出力時に自動で付加されるログIDのフォーマットを設定できます。
message.id.format
キーに
String.format(String, Object...)
のフォーマット形式で設定してください。ログIDが文字列として渡されます。
設定しない場合は「[%s]」がデフォルト値として使用されます。
message.id.format=[%-8s]
のように設定すると、モジュール間で異なる長さのログIDを左寄せで揃えて出力できます。
この設定値はモジュール毎に管理することはできません。
クラスローダの読み込み優先度が一番高いterasoluna-logger.properties
の値が反映されます。
(通常、アプリ側の設定となります。)
修飾子 | コンストラクタと説明 |
---|---|
protected |
TLogger(Class<?> clazz)
コンストラクタ。
|
protected |
TLogger(String name)
コンストラクタ。
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected String |
createMessage(boolean resource,
String logIdOrPattern,
Object... args)
ログメッセージを作成します。
|
void |
debug(boolean resource,
String logIdOrPattern,
Object... args)
DEBUGログを出力します。
|
void |
debug(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
DEBUGログを出力します。
|
void |
debug(Object message)
非推奨です。
|
void |
debug(Object message,
Throwable t)
非推奨です。
|
void |
debug(String logId)
DEBUGログを出力します。
|
void |
debug(String logId,
Object... args)
DEBUGログを出力します。
|
void |
debug(String logId,
Throwable throwable)
DEBUGログを出力します。
|
void |
debug(String logId,
Throwable throwable,
Object... args)
DEBUGログを出力します。
|
void |
error(boolean resource,
String logIdOrPattern,
Object... args)
ERRORログを出力します。
|
void |
error(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
ERRORログを出力します。
|
void |
error(Object message)
非推奨です。
|
void |
error(Object message,
Throwable t)
非推奨です。
|
void |
error(String logId)
ERRORログを出力します。
|
void |
error(String logId,
Object... args)
ERRORログを出力します。
|
void |
error(String logId,
Throwable throwable)
ERRORログを出力します。
|
void |
error(String logId,
Throwable throwable,
Object... args)
ERRORログを出力します。
|
void |
fatal(boolean resource,
String logIdOrPattern,
Object... args)
FATALログを出力します。
|
void |
fatal(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
FATALログを出力します。
|
void |
fatal(Object message)
非推奨です。
|
void |
fatal(Object message,
Throwable t)
非推奨です。
|
void |
fatal(String logId)
FATALログを出力します。
|
void |
fatal(String logId,
Object... args)
FATALログを出力します。
|
void |
fatal(String logId,
Throwable throwable)
FATALログを出力します。
|
void |
fatal(String logId,
Throwable throwable,
Object... args)
FATALログを出力します。
|
static TLogger |
getLogger(Class<?> clazz)
ロガーを取得します。
|
static TLogger |
getLogger(String name)
ロガーを取得します。
|
String |
getLogMessage(String logId,
Object... args)
ログメッセージを取得します。
|
void |
info(boolean resource,
String logIdOrPattern,
Object... args)
INFOログを出力します。
|
void |
info(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
INFOログを出力します。
|
void |
info(Object message)
非推奨です。
|
void |
info(Object message,
Throwable t)
非推奨です。
|
void |
info(String logId)
INFOログを出力します。
|
void |
info(String logId,
Object... args)
INFOログを出力します。
|
void |
info(String logId,
Throwable throwable)
INFOログを出力します。
|
void |
info(String logId,
Throwable throwable,
Object... args)
INFOログを出力します。
|
boolean |
isDebugEnabled() |
boolean |
isErrorEnabled() |
boolean |
isFatalEnabled() |
boolean |
isInfoEnabled() |
boolean |
isTraceEnabled() |
boolean |
isWarnEnabled() |
void |
log(String logId,
Object... args)
ログIDの以下の規約に合ったレベルのログを出力します。
|
void |
log(String logId,
Throwable throwable,
Object... args)
ログIDの以下の規約に合ったレベルのログを出力します。
|
static void |
setLocale(Locale locale)
ロケールを設定します。
|
void |
trace(boolean resource,
String logIdOrPattern,
Object... args)
TRACEログを出力します。
|
void |
trace(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
TRACEログを出力します。
|
void |
trace(Object message)
非推奨です。
|
void |
trace(Object message,
Throwable t)
非推奨です。
|
void |
trace(String logId)
TRACEログを出力します。
|
void |
trace(String logId,
Object... args)
TRACEログを出力します。
|
void |
trace(String logId,
Throwable throwable)
TRACEログを出力します。
|
void |
trace(String logId,
Throwable throwable,
Object... args)
TRACEログを出力します。
|
void |
warn(boolean resource,
String logIdOrPattern,
Object... args)
WARNログを出力します。
|
void |
warn(boolean resource,
String logIdOrPattern,
Throwable throwable,
Object... args)
WARNログを出力します。
|
void |
warn(Object message)
非推奨です。
|
void |
warn(Object message,
Throwable t)
非推奨です。
|
void |
warn(String logId)
WARNログを出力します。
|
void |
warn(String logId,
Object... args)
WARNログを出力します。
|
void |
warn(String logId,
Throwable throwable)
TRACEログを出力します。
|
void |
warn(String logId,
Throwable throwable,
Object... args)
WARNログを出力します。
|
protected TLogger(Class<?> clazz)
clazz
- カテゴリ名となるクラスprotected TLogger(String name)
name
- カテゴリ名public static void setLocale(Locale locale)
locale
- ロケールprotected String createMessage(boolean resource, String logIdOrPattern, Object... args)
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータMessageManager#getMessage(boolean, String, Locale, Object...)}
public static TLogger getLogger(Class<?> clazz)
clazz
- カテゴリ名となるクラスpublic boolean isFatalEnabled()
isFatalEnabled
インタフェース内 org.apache.commons.logging.Log
public void fatal(boolean resource, String logIdOrPattern, Object... args)
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void fatal(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void fatal(String logId, Object... args)
logId
- ログIDargs
- 置換パラメータpublic void fatal(String logId, Throwable throwable, Object... args)
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic boolean isErrorEnabled()
isErrorEnabled
インタフェース内 org.apache.commons.logging.Log
public void error(boolean resource, String logIdOrPattern, Object... args)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void error(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void error(String logId, Object... args)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDargs
- 置換パラメータpublic void error(String logId, Throwable throwable, Object... args)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic boolean isWarnEnabled()
isWarnEnabled
インタフェース内 org.apache.commons.logging.Log
public void warn(boolean resource, String logIdOrPattern, Object... args)
ロガーのログレベルがWARNより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void warn(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
ロガーのログレベルがWARNより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void warn(String logId, Object... args)
ロガーのログレベルがWARNより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDargs
- 置換パラメータpublic void warn(String logId, Throwable throwable, Object... args)
ロガーのログレベルがWARNより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic boolean isInfoEnabled()
isInfoEnabled
インタフェース内 org.apache.commons.logging.Log
public void info(boolean resource, String logIdOrPattern, Object... args)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void info(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void info(String logId, Object... args)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDargs
- 置換パラメータpublic void info(String logId, Throwable throwable, Object... args)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic boolean isDebugEnabled()
isDebugEnabled
インタフェース内 org.apache.commons.logging.Log
public void debug(boolean resource, String logIdOrPattern, Object... args)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void debug(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void debug(String logId, Object... args)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDargs
- 置換パラメータpublic void debug(String logId, Throwable throwable, Object... args)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic boolean isTraceEnabled()
isTraceEnabled
インタフェース内 org.apache.commons.logging.Log
public void trace(boolean resource, String logIdOrPattern, Object... args)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)args
- 置換パラメータpublic void trace(boolean resource, String logIdOrPattern, Throwable throwable, Object... args)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
resource
- リソース有無logIdOrPattern
- ログID(リソース有の場合) / ログメッセージパターン(リソース無の場合)throwable
- 起因例外args
- 置換パラメータpublic void trace(String logId, Object... args)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDargs
- 置換パラメータpublic void trace(String logId, Throwable throwable, Object... args)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータpublic void log(String logId, Object... args)
ログIDの先頭文字が
logId
- ログIDargs
- 置換パラメータpublic void log(String logId, Throwable throwable, Object... args)
ログIDの先頭文字が
logId
- ログIDargs
- 置換パラメータ@Deprecated public void trace(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにtrace(String, Object...)
を使用してください。
trace
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void trace(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにtrace(String, Throwable, Object...)
を使用してください。
trace
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外@Deprecated public void debug(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにdebug(String, Object...)
を使用してください。
debug
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void debug(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにdebug(String, Throwable, Object...)
を使用してください。
debug
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外@Deprecated public void info(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにinfo(String, Object...)
を使用してください。
info
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void info(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにinfo(String, Throwable, Object...)
を使用してください。
info
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外@Deprecated public void warn(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにwarn(String, Object...)
を使用してください。
warn
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void warn(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにwarn(String, Throwable, Object...)
を使用してください。
warn
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外@Deprecated public void error(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにerror(String, Object...)
を使用してください。
error
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void error(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにerror(String, Throwable, Object...)
を使用してください。
error
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外@Deprecated public void fatal(Object message)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにfatal(String, Object...)
を使用してください。
fatal
インタフェース内 org.apache.commons.logging.Log
message
- メッセージ@Deprecated public void fatal(Object message, Throwable t)
CommonsLoggingのLogインタフェースを実装するためのAPIであり、使用しないでください。
代わりにfatal(String, Throwable, Object...)
を使用してください。
fatal
インタフェース内 org.apache.commons.logging.Log
message
- メッセージt
- 起因例外public String getLogMessage(String logId, Object... args)
logId
- ログIDargs
- 置換パラメータpublic void trace(String logId)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDpublic void trace(String logId, Throwable throwable)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外public void debug(String logId)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDpublic void debug(String logId, Throwable throwable)
ロガーのログレベルがDEBUGより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外public void warn(String logId)
ロガーのログレベルがWARNより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDpublic void warn(String logId, Throwable throwable)
ロガーのログレベルがTRACEより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外public void info(String logId)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDpublic void info(String logId, Throwable throwable)
ロガーのログレベルがINFOより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外public void error(String logId)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDpublic void error(String logId, Throwable throwable)
ロガーのログレベルがERRORより高い場合は出力されません。
詳細はTLogger
を参照してください。
logId
- ログIDthrowable
- 起因例外public void fatal(String logId)
logId
- ログIDthrowable
- 起因例外args
- 置換パラメータCopyright © 2014 NTT DATA Corporation.