log4j2自定义Appender（输出到文件/RPC服务中）

最新推荐文章于 2025-06-19 10:12:35 发布

原创

最新推荐文章于 2025-06-19 10:12:35 发布 · 2.7k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#thrift #log4j

本文介绍了如何自定义log4j2的Appender，包括将日志输出到文件以及通过Thrift发送到远程RPC服务。首先，详细讲解了自定义文件Appender的步骤，包括定义、配置和测试。接着，展示了如何创建Thrift RPC服务，并定义ThriftAppender，完成日志的远程传输。最后，通过测试验证了自定义Appender的有效性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、背景

虽然log4j很强大，可以将日志输出到文件、DB、ES等。但是有时候确难免完全适合自己，此时我们就需要自定义Appender，使日志输出到指定的位置上。

本文，将通过两个例子说明自定义APPender，一个是将日志写入文件中，另一个是将日志发送到远程Thrift服务中。

本文代码详见：https://github.com/hawkingfoo/log-demo

2、自定义文件Appender

2.1 定义文件Appender

先上代码：

@Plugin(name = "FileAppender", category = "Core", elementType = "appender", printObject = true)
public class FileAppender extends AbstractAppender {
   
   
    private String fileName;

    /* 构造函数 */
    public FileAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, String fileName) {
        super(name, filter, layout, ignoreExceptions);
        this.fileName = fileName;
    }

    @Override
    public void append(LogEvent event) {
        final byte[] bytes = getLayout().toByteArray(event);
        writerFile(bytes);

    }

    /*  接收配置文件中的参数 */
    @PluginFactory
    public static FileAppender createAppender(@PluginAttribute("name") String name,
                                              @PluginAttribute("fileName") String fileName,
                                              @PluginElement("Filter") final Filter filter,
                                              @PluginElement("Layout") Layout<? extends Serializable> layout,
                                              @PluginAttribute("ignoreExceptions") boolean ignoreExceptions) {
        if (name == null) {
            LOGGER.error("no name defined in conf.");
            return null;
        }
        if (layout == null) {
            layout = PatternLayout.createDefaultLayout();
        }
        // 创建文件
        if (!createFile(fileName)) {
            return null;
        }
        return new FileAppender(name, filter, layout, ignoreExceptions, fileName);
    }

    private static boolean createFile(String fileName) {
        Path filePath = Paths.get(fileName);
        try {
            // 每次都重新写文件，不追加
            if (Files.exist