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

Question

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

Answer 1

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

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

1. защищенное пустое добавление (событие LoggingEvent)
2. public void close ()
3. public boolean requiredLayout ()

Основной метод - доп. Помните, что вам не нужно реализовывать логику фильтрации в ней, потому что она уже реализована в 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 правильно реализует «управление уровнями» для нас. Так что определенно кажется, что это путь ... теперь вопрос: зачем вам специальный аппендер, в то время как есть много встроенных в этот журнал почти для любого места назначения? (кстати, хорошее место, чтобы начать с log4j: http://logging.apache.org/log4j/1.2/manual.html)

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

Answer 3

Я хотел бы потратить @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.файл свойств

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

Answer 4

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