web-dev-qa-db-ja.com

log4jで独自のアペンダーを作成する方法は?

私はlog4jの初心者です。誰でも自分のアペンダーを作成する方法を説明できますか?つまり、クラスとインターフェースを実装する方法と、それをオーバーライドする方法は?

52
unknown

AppenderSkeletonクラスを拡張する必要があります(javadocを引用)「しきい値フィルタリングのサポートや一般的なフィルターのサポートなど、一般的な機能のコードを提供します」。

AppenderSkeletonのコードを読むと、ほとんどすべてを処理していることがわかります。

  1. protected void append(LoggingEventイベント)
  2. public void close()
  3. public boolean requiresLayout()

コアメソッドはappendです。 doAppendで既に実装されているフィルターロジックを実装する必要がないことに注意してください。ここでは、デモとして、ArrayListにログエントリを保存する(まったく役に立たない)クラスを作成しました。

public /*static*/ class MyAppender extends AppenderSkeleton {
    ArrayList<LoggingEvent> eventsList = new ArrayList();

    @Override
    protected void append(LoggingEvent event) {
        eventsList.add(event);
    }

    public void close() {
    }

    public boolean requiresLayout() {
        return false;
    }

}

それでは、テストしてみましょう。

public static void main (String [] args) {

    Logger l = Logger.getLogger("test");

    MyAppender app = new MyAppender();

    l.addAppender(app);

    l.warn("first");
    l.warn("second");
    l.warn("third");

    l.trace("fourth shouldn't be printed");

    for (LoggingEvent le: app.eventsList) {
        System.out.println("***" + le.getMessage());
    }
} 

「最初」、「2番目」、「3番目」を印刷する必要があります。ルートロガーのログレベルはデバッグであり、イベントレベルはトレースであるため、4番目のメッセージは出力されません。これは、AbstractSkeletonが「レベル管理」を正しく実装していることを証明しています。だから、それは間違いなく行く方法のようです...今の質問:ほとんどすべての宛先にそのログに多くが組み込まれているのに、なぜカスタムアペンダーが必要なのですか? (log4jから始めるのに適した場所: http://logging.Apache.org/log4j/1.2/manual.html

72
AgostinoX

何らかの操作や決定を行いたい場合は、次のようにします。

@Override
protected void append(LoggingEvent event) {
        String message = null;
        if(event.locationInformationExists()){
            StringBuilder formatedMessage = new StringBuilder();
            formatedMessage.append(event.getLocationInformation().getClassName());
            formatedMessage.append(".");
            formatedMessage.append(event.getLocationInformation().getMethodName());
            formatedMessage.append(":");
            formatedMessage.append(event.getLocationInformation().getLineNumber());
            formatedMessage.append(" - ");
            formatedMessage.append(event.getMessage().toString());
            message = formatedMessage.toString();
        }else{
            message = event.getMessage().toString();
        }

        switch(event.getLevel().toInt()){
        case Level.INFO_INT:
            //your decision
            break;
        case Level.DEBUG_INT: 
            //your decision
            break;
        case Level.ERROR_INT:
            //your decision
            break;
        case Level.WARN_INT:
            //your decision
            break;
        case Level.TRACE_INT:
            //your decision
            break;
        default:
            //your decision
            break;
        }
}
6
Lior

プロファイルの設定とロギングキャプチャの開始と停止をサポートするために、@ AgostinoXの回答を使いたいと思います。

public class StringBufferAppender extends org.Apache.log4j.AppenderSkeleton {

    StringBuffer logs = new StringBuffer();
    AtomicBoolean captureMode = new AtomicBoolean(false);

    public void close() {
        // TODO Auto-generated method stub

    }

    public boolean requiresLayout() {
        // TODO Auto-generated method stub
        return false;
    }


    @Override
    protected void append(LoggingEvent event) {
        if(captureMode.get())
            logs.append(event.getMessage());
    }

    public void start()
    {
        //System.out.println("[StringBufferAppender|start] - Start capturing logs");
        StringBuffer logs = new StringBuffer();
        captureMode.set(true);
    }

    public StringBuffer stop()
    {
        //System.out.println("[StringBufferAppender|start] - Stop capturing logs");
        captureMode.set(false);
        StringBuffer data = new StringBuffer(logs);
        logs = null;
        return data;
    }


}

あとは、log4j.propertyファイルで定義するだけです

log4j.rootLogger=...., myAppender  # here you adding your appendr name
log4j.appender.myAppender=com.roi.log.StringBufferAppender # pointing it to the implementation

runtume中に有効にしたいときよりも:

Logger logger = Logger.getRootLogger();
        StringBufferAppender appender = (StringBufferAppender)logger.getAppender("myAppender");
        appender.start();

そして、それを止めたい:

StringBuffer sb = appender.stop();
2
USer22999299

独自のアペンダーを作成するには、アペンダーインターフェイスを実装してオーバーライドするだけです。また、このリンクを調べてください log

2
Aabi