如何在log4j中创建自己的Appender？

Question

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

Answer 1

更新：提供的解决方案适用于 Log4J 1.x 。如果您正在寻找 2.x 版本，请查看这篇文章：如何在 log4j2 中创建自定义附加程序

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

如果你读过AppenderSkeleton的代码，你会发现它几乎处理了所有的事情，只剩下：

1. protected void append(LoggingEvent event)
2. public void close()
3. public boolean requireLayout()

核心方法是append。请记住，您不需要在其中实现过滤逻辑，因为它已经在 doAppend 中实现，而 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());
    }
} 

你应该打印“first”、“second”、“third”；不应打印第四条消息，因为根记录器的日志级别是调试，而事件级别是跟踪。这证明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.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();

Answer 4

要创建自己的 Appender，您只需实现 Appender 接口并覆盖它即可。
还要研究这个链接开始 log