java定义log4j2_java – 如何在log4j2中创建自定义Appender？

在log4j2中，与log4j-1.2中的工作方式完全不同。

扩展org.apache.logging.log4j.core.appender.AbstractAppender可能很方便，但这不是必需的。

当您使用@Plugin(name =“MyCustomAppender”，….)注释您的自定义Appender类时，插件名称将成为配置元素名称，因此，使用自定义appender的配置将如下所示：

...

请注意，配置上的packages属性是具有自定义log4j2插件的所有包的逗号分隔列表。 Log4j2将在类路径中搜索用@Plugin注释的类的这些包。

以下是打印到控制台的示例自定义appender：

package com.yourcompany.yourcustomappenderpackage;

import java.io.Serializable;

import java.util.concurrent.locks.*;

import org.apache.logging.log4j.core.*;

import org.apache.logging.log4j.core.config.plugins.*;

import org.apache.logging.log4j.core.layout.PatternLayout;

// note: class name need not match the @Plugin name.

@Plugin(name="MyCustomAppender", category="Core", elementType="appender", printObject=true)

public final class MyCustomAppenderImpl extends AbstractAppender {

private final ReadWriteLock rwLock = new ReentrantReadWriteLock();

private final Lock readLock = rwLock.readLock();

protected MyCustomAppenderImpl(String name, Filter filter,

Layout extends Serializable> layout, final boolean ignoreExceptions) {

super(name, filter, layout, ignoreExceptions);

}

// The append method is where the appender does the work.

// Given a log event, you are free to do with it what you want.

// This example demonstrates:

// 1. Concurrency: this method may be called by multiple threads concurrently

// 2. How to use layouts

// 3. Error handling

@Override

public void append(LogEvent event) {

readLock.lock();

try {

final byte[] bytes = getLayout().toByteArray(event);

System.out.write(bytes);

} catch (Exception ex) {

if (!ignoreExceptions()) {

throw new AppenderLoggingException(ex);

}

} finally {

readLock.unlock();

}

}

// Your custom appender needs to declare a factory method

// annotated with `@PluginFactory`. Log4j will parse the configuration

// and call this factory method to construct an appender instance with

// the configured attributes.

@PluginFactory

public static MyCustomAppenderImpl createAppender(

@PluginAttribute("name") String name,

@PluginElement("Layout") Layout extends Serializable> layout,

@PluginElement("Filter") final Filter filter,

@PluginAttribute("otherAttribute") String otherAttribute) {

if (name == null) {

LOGGER.error("No name provided for MyCustomAppenderImpl");

return null;

}

if (layout == null) {

layout = PatternLayout.createDefaultLayout();

}

return new MyCustomAppenderImpl(name, filter, layout, true);

}

}

如果手册不够，可以在log4j-core中查看内置的追加器的源代码。