【Logback】Logback 中的 Appenders

swadian2008

已于 2024-03-06 13:37:06 修改

阅读量2.4k

点赞数 13

分类专栏：日志框架文章标签： logback Appender RollingPolicy

于 2024-03-06 13:26:03 首次发布

本文链接：https://blog.youkuaiyun.com/swadian2008/article/details/123257818

版权

1、什么是 Appenders？

2、解说 AppenderBase.doAppend() 方法

3、logback-core 模块中的 Appenders

（1）OutputStreamAppender

（2）ConsoleAppender

（3）FileAppender

（4）RollingFileAppender

1、什么是 Appenders？

Appender 组件负责处理 Logback 日志写入的任务，该组件必须实现 ch.qos.logback.core.Appender 接口，该接口的主要方法总结如下：//主要是解决将日志写到哪里去的问题

package ch.qos.logback.core;

import ch.qos.logback.core.spi.ContextAware;
import ch.qos.logback.core.spi.FilterAttachable;
import ch.qos.logback.core.spi.LifeCycle;

public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachable<E> {
    String getName();

    //核心方法
    void doAppend(E var1) throws LogbackException;

    void setName(String var1);
}

Appender 接口中其实就一个最核心的方法，即 doAppend() 方法，且该方法只有一个参数，也就是类型为 E 的对象实例。泛型 E 的实例类型需要根据 logback 的具体模块进行决定，在 logback-classic 模块内，E 的类型为 ILoggingEvent(日志记录事件)，在 logback-access 模块内，E 的类型为 AccessEvent。doAppend() 方法可以说是 logback 框架中最重要的方法，它负责将日志记录事件以合适的格式输出到合适的输出设备。//该方法框架的灵魂和各组件之间的桥梁

2、解说 AppenderBase.doAppend() 方法

抽象类 ch.qos.logback.core.AppenderBase 实现了 Appender 接口，该类是所有 Appender 组件的父类，它提供了所有 Appender 组件共享的基本功能，比如获取和设置 Appender 组件的名称，激活状态，layout 组件，过滤器等。在该类中有一个非常重要的方法实现，就是我们上边提到的 doAppend() 方法，AppenderBase 类的具体实现逻辑源码如下：

public synchronized void doAppend(E eventObject) {
        if (!this.guard) {
            try {
                //1、防止递归调用
                this.guard = true;
                //2、判断Appender是否开启
                if (!this.started) {
                    //状态重复计数
                    if (this.statusRepeatCount++ < 5) {
                        //发出警告信息
                        this.addStatus(new WarnStatus("Attempted to append to non started appender [" + this.name + "].", this));
                    }

                    return;
                }
                //3、检查Appender过滤器决策结果
                if (this.getFilterChainDecision(eventObject) == FilterReply.DENY) {
                    return;
                }
                //4、调用子类的append()的实现
                this.append(eventObject);
            } catch (Exception var6) {
                if (this.exceptionCount++ < 5) {
                    this.addError("Appender [" + this.name + "] failed to append.", var6);
                }
            } finally {
                //5、释放guard
                this.guard = false;
            }

        }
    }

上边这段代码我在《Logback 日志框架的架构》这篇文章中也提到过，但也只是简要提及，这里将具体分析一下。

AppenderBase 类中的 doAppend() 方法是同步方法(synchronized修饰)，所以不同的线程把日志记录到同一个 Appender 时都是线程安全的(独占访问)。

这里需要注意，同步有时候并不总是合适的，所以 logback 还提供了 doAppend() 的一般实现，即 ch.qos.logback.core.UnsynchronizedAppenderBase.doAppend()，该类中的实现除了不使用synchronized修饰方法外，其他逻辑与 AppenderBase 类中的实现几乎一样。

第一步，判断 guard 属性是否被设置为 true。如果为 true，那么程序将立即跳出此方法，如果没有设置 guard ，则在下一条语句中将其设置为 true。该 guard 属性确保了 doAppend() 方法不会递归调用自己。比如，如果在 append() 方法之外的某个地方想要调用 Appender 组件去记录一些内容，那么它可能会定向到刚刚调用它的同一个 Appender 组件，从而导致无限循环和堆栈溢出。//guard 属性防止程序递归调用

第二步，判断 started(开启状态) 是否为 true，如果为 false，doAppend() 将发送警告消息并返回。也就是说，一旦 Appender 已经关闭，就无法对其进行写入。

Appender 对象实现了 LifeCycle 接口，这意味着它们也实现了 start()、stop() 和 isStarted() 方法。当设置完 Appender 的所有属性后，logback 的配置框架(Joran)将调用 start() 方法来通知 Appender 激活这些属性。如果某些属性缺失或者属性之间相互干扰，那么 Appender 可能无法启动。一般情况下，根据 Appender 的类型，具体的启动的逻辑也会有所不同。//start()方法用来检查Appender配置是否完整，并激活Appender

如果 Appender 无法启动或已停止，则会通过 logback 的内部状态管理系统发出警告消息。为了避免系统被相同的警告消息淹没，经过几次尝试后(5次)，doAppend() 将停止发出这些警告。

第三步，检查 Appender 过滤器决策结果。根据 Appender 过滤器链产生的决策结果，判断日志事件是否被拒绝或者被接受。在过滤器链没有做出决定的情况下，默认会接受日志事件。

然后，调用子类的 append() 的实现。 append() 方法负责将日志记录事件输出到指定的设备上。

最后，释放 guard ，以允许其他线程调用 doAppend() 方法。