Как создать собственный Appender в log4j?

Я новичок в log4j. Может ли кто-нибудь объяснить, как создать свой собственный Appender? например, как реализовать классы и интерфейсы и как их переопределить?

ОТВЕТЫ

Ответ 1

Вы должны расширить класс AppenderSkeleton, который (quoting javadoc) "предоставляет код для общей функциональности, такой как поддержка фильтрации порогов и поддержка общих фильтров."

Если вы прочитали код AppenderSkeleton, вы увидите, что он обрабатывает почти все, оставив вам только:

  • protected void append (событие LoggingEvent)
  • public void close()
  • public boolean requireLayout()

Основной метод добавляется. Помните, что вам не нужно реализовывать в нем логику фильтрации, поскольку она уже реализована в doAppend, которая в свою очередь вызывает append. Здесь я сделал (совершенно бесполезный) класс, который хранит записи журнала в 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());
    }
}

У вас должен быть напечатан "первый", "второй", "третий"; четвертое сообщение не должно печататься, так как уровень журнала корневого регистратора отлаживается, а уровень события - это трассировка. Это доказывает, что AbstractSkeleton правильно реализует "управление уровнем". Так что определенно кажется, что нужно идти... теперь возникает вопрос: зачем вам пользовательский appender, хотя в этом журнале есть много встроенных журналов практически в любом месте? (btw хорошее место для начала с log4j: http://logging.apache.org/log4j/1.2/manual.html)

Ответ 2

Если вы хотите сделать некоторые манипуляции или решения, вы можете сделать это следующим образом:

@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;
        }
}

Ответ 3

Чтобы создать собственный Appender, вы просто реализуете интерфейс Appender и просто переопределяете его. А также изучите эту ссылку, запустите log

Ответ 4

Я хотел бы потратить @AgostinoX ответ на поддержку конфигурации файла pro и возможность запуска и остановки записи журнала:

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();