61

我是 log4j 的新手。谁能解释如何创建我自己的 Appender？即如何实现类和接口以及如何覆盖它？

4

4 回答 4

80

更新：提供的解决方案对 Log4J 1.x 有效。如果您正在寻找 2.x 版本，请查看这篇文章：How to create a custom appender in log4j2

您应该扩展 AppenderSkeleton 类，该类（引用 javadoc）“提供通用功能的代码，例如支持阈值过滤和支持通用过滤器。”

如果您阅读 AppenderSkeleton 的代码，您会发现它几乎可以处理所有问题，只剩下：

  1. 受保护的无效追加（LoggingEvent 事件）
  2. 公共无效关闭（）
  3. 公共布尔要求布局（）

核心方法是追加。请记住，您不需要在其中实现过滤逻辑，因为它已经在 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）

于 2011-05-23T21:11:51.027 回答
9

如果你想做一些操作或决定，你可以这样做：

@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;
        }
}
于 2013-04-24T14:15:23.307 回答
4

我想扩展@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

比你想在运行期间启用它：

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

虽然想阻止它：

StringBuffer sb = appender.stop();
于 2015-08-01T08:09:33.033 回答
2

要创建自己的 Appender，您只需实现 Appender 接口并覆盖它。并且还要研究这个链接启动日志

于 2011-06-10T05:46:13.370 回答