Logback 自定义附加器开发指南

1. 概述

本文将带你深入探索如何创建自定义 Logback 附加器（Appender）。如果你需要 Java 日志框架的基础知识，建议先参考这篇入门文章。

Logback 内置了多种附加器，支持输出到控制台、文件系统或数据库。该框架最精妙的设计在于其模块化架构，这意味着我们可以轻松地对其进行定制。

本文将聚焦于 logback-classic 模块，需要以下 Maven 依赖：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.3.5</version>
</dependency>

最新版本可在 Maven 中央仓库获取。

2. Logback 基础附加器

Logback 提供了多个基类供我们扩展创建自定义附加器：

Appender 是所有附加器必须实现的通用接口，其泛型类型为 ILoggingEvent（logback-classic）或 AccessEvent（logback-access）
✅ 自定义附加器应继承 AppenderBase 或 UnsynchronizedAppenderBase，它们都实现了 Appender 并处理过滤器和状态消息等功能
AppenderBase 是线程安全的，而 UnsynchronizedAppenderBase 的子类需自行管理线程安全
⚠️ 如果附加器需要写入 OutputStream，应继承 OutputStreamAppender（类似 ConsoleAppender 和 FileAppender 的实现方式）

3. 自定义附加器实现

我们创建一个名为 MapAppender 的示例附加器，它将所有日志事件存入 ConcurrentHashMap，以时间戳作为键。首先继承 AppenderBase 并指定泛型类型为 ILoggingEvent：

public class MapAppender extends AppenderBase<ILoggingEvent> {

    private ConcurrentMap<String, ILoggingEvent> eventMap 
      = new ConcurrentHashMap<>();

    @Override
    protected void append(ILoggingEvent event) {
        eventMap.put(String.valueOf(System.currentTimeMillis()), event);
    }
    
    public Map<String, ILoggingEvent> getEventMap() {
        return eventMap;
    }
}

接着在 logback.xml 配置文件中启用该附加器：

<configuration>
    <appender name="map" class="com.baeldung.logback.MapAppender"/>
    <root level="info">
        <appender-ref ref="map"/>
    </root>
</configuration>

4. 属性配置

Logback 使用 JavaBeans 内省机制处理附加器属性。自定义附加器需提供 getter/setter 方法以支持属性注入。

为 MapAppender 添加键前缀属性：

public class MapAppender extends AppenderBase<ILoggingEvent> {

    //...

    private String prefix;

    @Override
    protected void append(ILoggingEvent event) {
        eventMap.put(prefix + System.currentTimeMillis(), event);
    }

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    //...

}

在配置文件中设置该属性：

<configuration debug="true">

    <appender name="map" class="com.baeldung.logback.MapAppender">
        <prefix>test</prefix>
    </appender>

    //...

</configuration>

5. 错误处理机制

利用 AppenderBase 继承的方法处理附加器创建和配置阶段的错误。例如当 prefix 属性为空时：

public class MapAppender extends AppenderBase<ILoggingEvent> {

    //...

    @Override
    protected void append(final ILoggingEvent event) {
        if (prefix == null || "".equals(prefix)) {
            addError("Prefix is not set for MapAppender.");
            return;
        }

        eventMap.put(prefix + System.currentTimeMillis(), event);
    }

    //...

}

开启配置中的 debug 标志后，控制台将显示错误提示：

<configuration debug="true">

    //...

</configuration>

6. 总结

本文快速演示了如何为 Logback 实现自定义附加器。完整示例代码可在 GitHub 获取。

关键要点：

✅ 继承 AppenderBase 或 UnsynchronizedAppenderBase 作为基类
✅ 通过 JavaBeans 规范配置属性
✅ 使用 addError() 处理配置错误
⚠️ 注意线程安全（AppenderBase 已处理，UnsynchronizedAppenderBase 需自行处理）

Persistence

REST

Security