ロギングAPIの共通点を整理する

ロギングAPIの共通点を整理する

　今回はlog4j、JDK Logging API、そしてAvalon logkitの3つのロギングフレームワークについてAPIの共通点を整理します。最初にそれぞれの利用例をご覧ください。

【log4jの場合】
import org.apache.log4j.Logger;
　:
Logger logger = Logger.getInstance (Person.class);
logger.info(“Adapter Pattern”);
　:

【JDK Logging APIの場合】
import java.util.logging.Level;
import java.util.logging.Logger;
　:
Logger logger = Logger.getInstance (Person.class);
logger.log(Level.INFO, “Adapter Pattern”);
　:

【Avalon logkitの場合】
import org.apache.log.Hierarchy;
import org.apache.log.Logger;
　:
Logger logger = Hierarchy.getDefaultHierarchy().getLoggerFor(Person.class);
logger.info(“Adapter Pattern”);
　:

　ご覧の通り、細かな点を除くと利用方法には次の共通点があります。
　1.ロガーのインスタンスを取得する
　2.ロガーにエラーレベルとメッセージを指定してログを出力する

　説明は割愛しますが、このほかにそれぞれのログレベルの有効／無効を確認するためのメソッドも実装してあります。

　一方、異なる点は図2-1のようにログレベルの種類と数になります。ログレベルの種類と数を図2-1のcommons loggingの6種類のログレベルに合わせることで共通のインターフェースが見えてきます。

ロギングフレームワークをラップする

　図2-1より、ロギングフレームワークに共通するLogインターフェースを定義します（図2-2）。さらにAdapterパターンを適用して利用者からそれぞれのフレームワークを切り離します。

　log4jを例に説明するとLog4JLoggerクラスがadapter役になり、log4jのクラスがAdaptee役になります。Adaptee役を複数のオブジェクトで構成する必要がある場合は委譲の実現方法を選択します。Log4JLoggerクラスは、log4jのAPIをLogインターフェースに合うように変換して利用できるように実装します。

　利用者はLogインターフェースを利用することで、ロギングフレームワークの種類を意識することなくログ出力の実装を行うことができるようになりました。

【利用例】
Log logger;
logger.info(“Adapter Pattern”);

　今回はlog4jを例に説明しましたが、そのほかのロギングフレームワークもLogインターフェースに合わせることができれば、同様の考え方でログ出力の機能をラップして利用することができます。