如何在log4j中创建我自己的追加器?

2022-08-31 15:55:15

我是log4j中的新手。任何人都可以解释如何创建我自己的追加器吗?即如何实现类和接口以及如何重写它?


答案 1

更新:提供的解决方案对 Log4J 1.x 有效。如果您正在寻找 2.x 版本,请查看此文章:如何在 log4j2 中创建自定义追加器

你应该扩展 AppenderSkeleton 类,该类(引用 javadoc)“为常见功能提供代码,例如支持阈值过滤和支持通用过滤器。

如果你阅读 AppenderSkeleton 的代码,你会发现它几乎可以处理所有代码,只留给你:

  1. 受保护的 void append(LoggingEvent 事件)
  2. 公共 void close()
  3. 公共布尔值 requireLayout()

核心方法是追加。请记住,您不需要在其中实现筛选逻辑,因为它已经在 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());
    }
} 

你应该打印“第一”,“第二”,“第三”;不应打印第四条消息,因为根记录器的日志级别是调试的,而事件级别是跟踪。这证明了 AbstractSkeleton 为我们正确地实现了“关卡管理”。所以这绝对是要走的路...现在的问题是:为什么你需要一个自定义的附加器,而该日志中几乎任何目的地都内置了许多附加器?(顺便说一句,从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;
        }
}

推荐