Logback源码解析

本文分析源码，Logback版本为1.2.3，SLF4J的版本为1.7.25

1. Logback与SLF4J的关联

1.1 关联类

使用SLF4J作为Log Facade，使用Logback作为具体Log Implementation，配置好logback.xml之后，执行以下代码，就可以使用Logback打印日志。

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MainTest01 {
    @Test
    public void test01() {
        Logger logger = LoggerFactory.getLogger(MainTest01.class);
        logger.error("i am in logback...");
    }
}

Logback是如何与SLF4J关联起来的呢，通过SLF4J与Logback、Log4j1、Log4j2、JCL、J.U.L是如何关联使用的，可以简单的知道，

• SLF4J在1.8.0-alpha0以前版本采用实现org.slf4j.impl.StaticLoggerBinder的方式实现
• SLF4J在1.8.0-alpha0之后的版本采用提供org.slf4j.spi.SLF4JServiceProvider的SPI实现的方式实现

本文简单分析以下org.slf4j.impl.StaticLoggerBinder的实现方式，首先在SLF4J源码当中存在未完整实现org.slf4j.impl.StaticLoggerBinder的类（主要是为了开发使用），而在打包的时候，并没有将org.slf4j.impl.StaticLoggerBinder打入Jar包当中，这里主要通过resources/META-INF/MANIFEST.MF的配置实现，其中有如下：

Export-Package: org.slf4j;version=${parsedVersion.osgiVersion},
  org.slf4j.spi;version=${parsedVersion.osgiVersion},
  org.slf4j.helpers;version=${parsedVersion.osgiVersion},
  org.slf4j.event;version=${parsedVersion.osgiVersion}
Import-Package: org.slf4j.impl;version=${slf4j.api.minimum.compatible.version}

其中Import-Package这是一个表示要引入的配置，Export-Package表示要打包输出的配置。这样，SLF4J的api包就没有包含org.slf4j.impl.StaticLoggerBinder，而主使用了具体实现Log的org.slf4j.impl.StaticLoggerBinder。

1.2 关联代码

点击进入 LoggerFactory.getLogger的实现，我们会看到，org.slf4j.LoggerFactory#getILoggerFactory获取日志工厂的实现，其中有performInitialization()调用的 org.slf4j.LoggerFactory#bind方法，在bind方法当中有

 // the next line does the binding
StaticLoggerBinder.getSingleton();

的一行代码，上面分析，StaticLoggerBinder是日志实现的StaticLoggerBinder而非SLF4J的StaticLoggerBinder，也就是说这里的StaticLoggerBinder是在Logback中实现的StaticLoggerBinder。点击进入StaticLoggerBinder可以看到StaticLoggerBinder的初始化等代码。

org.slf4j.LoggerFactory#getILoggerFactory 代码当中包含

case SUCCESSFUL_INITIALIZATION:
            return StaticLoggerBinder.getSingleton().getLoggerFactory();

这样，我们调用SLF4J的LoggerFactory.getLogger方法，就返回了Logback的LoggerFactory返回的Logger。

同时需要注意一点，StaticLoggerBinder在这里使用了单例的形式，

• ====>应用启动之后，只会保留一个StaticLoggerBinder
• ====>在StaticLoggerBinder当中的属性都只会初始化一次
• ====>LoggerContext只会初始化一次
• ====>所有的日志公用一个LoggerContext对象

2. 初始化化

logback使用配置详解

Logback的初始化工作由org.slf4j.impl.StaticLoggerBinder#init完成，主要初始化代码如下

try {
    new ContextInitializer(defaultLoggerContext).autoConfig();
} catch (JoranException je) {
    Util.report("Failed to auto configure default logger context", je);
}

2.1 关键路径说明

1. ch.qos.logback.core.joran.GenericConfigurator#doConfigure(java.net.URL)进行配置。
2. ch.qos.logback.core.joran.GenericConfigurator#doConfigure(org.xml.sax.InputSource)当中调用javax.xml.parsers.SAXParser进行原始解析logback.xml
3. ch.qos.logback.core.joran.GenericConfigurator#doConfigure(java.util.List

2.2 关键类说明

1. Appender、Policy、PatternLayout、DynamicConverter和Filter等都实现了LifeCycle接口，在解析XML初始化的时候，都会调用对应的方法，尤其是start方法。
2. ch.qos.logback.core.joran.spi.Interpreter 这个是在初始化时候的关键处理类。
   
   • ruleStore用于存储XML配置与对应处理类。比如遇到configuration/logger的时候，用LoggerAction进行处理。
   • implicitActions 用于处理ruleStore没有存储的路径。比如configuration/appender/layout这个在ruleStore里面是没有存储的，所以使用implicitActions当中的处理器进行处理（这里主要会用到ch.qos.logback.core.joran.action.NestedComplexPropertyIA），反射执行，比如ch.qos.logback.core.ConsoleAppender里面有setLayout的方法，则遇到layout的时候，直接将对应的值赋值给ch.qos.logback.core.ConsoleAppender对象（invokeMethodWithSingleParameterOnThisObject反射执行方法的形式注入对象）。
   • 主要，在这里进行赋值的同时，还进行了start调用操作。这里需要说明的是，start的时候，如果配置的是TimeBasedRollingPolicy，则会判断异步删除之前的旧文件ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover#cleanAsynchronously。

3. LoggerContext

1. loggerCache以ch.qos.logback.classic.MainTest01当中每一级作为key存放对应的logger，上面的路径会产生，五个Key对应的Logger，LoggerAction处理的时候会把对应的loger放到LoggerContext当中的loggerCache当中。

   ch
   ch.qos
   ch.qos.logback
   ch.qos.logback.classic
   ch.qos.logback.classic.MainTest01

2. root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
3. 关键方法ch.qos.logback.classic.LoggerContext#getLogger(java.lang.String)返回Logger对象。

4. Logger

4.1 属性说明

1. name表示匹配的logger类型前缀，也就是包的前半部分
2. parent和childrenList为本Logger的父亲和孩子。
3. level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
4. additive/additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
   
   • false：表示只用当前logger的appender-ref，
   • true：表示当前logger的appender-ref和rootLogger的appender-ref都有效
5. aai保存了最为关键的打印日志相关的Appender信息，放在ch.qos.logback.core.spi.AppenderAttachableImpl#appenderList当中

4.2 打日志关键路径

如果调用了logger.error(“asdf”);方法，关键路径如下：

1. 调用ch.qos.logback.classic.Logger#buildLoggingEventAndAppend方法
   
   • 创建LoggingEvent对象
2. ch.qos.logback.classic.Logger#callAppenders
   
   • 一步步找自己的父appender进行appendLoopOnAppenders操作，比如ch.qos.logback.classic.MainTest01，会找到root进行appendLoopOnAppenders操作（因为其他父appender的aai都为空）。
3. ch.qos.logback.core.spi.AppenderAttachableImpl#appendLoopOnAppenders
   
   • 循环appenderList当中的Appender进行ch.qos.logback.core.Appender#doAppend操作。因为Appender实现了AppenderAttachable类，也就是说，appender当中可以有级联的appender。这也是AsyncAppender与RollingFileAppender能够级联配置的原因。

5. AsyncAppender

ch.qos.logback.core.AsyncAppenderBase当中维护了一个blockingQueue，用于存放要打印的LoggingEvent日志。

 blockingQueue = new ArrayBlockingQueue(queueSize);
 .....
 class Worker extends Thread {
        public void run() {
            AsyncAppenderBase parent = AsyncAppenderBase.this;
            AppenderAttachableImpl aai = parent.aai;
            // loop while the parent is started
            while (parent.isStarted()) {
                try {
                    E e = parent.blockingQueue.take();
                    aai.appendLoopOnAppenders(e);
                } catch (InterruptedException ie) {
                    break;
                }
            }
            addInfo("Worker thread will flush remaining events before exiting. ");
            for (E e : parent.blockingQueue) {
                aai.appendLoopOnAppenders(e);
                parent.blockingQueue.remove(e);
            }
            aai.detachAndStopAllAppenders();
        }
    }

1. 调用ch.qos.logback.core.AsyncAppenderBase#append
   
   • 会调用ch.qos.logback.core.AsyncAppenderBase#put方法，根据neverBlock判断在将是不是要阻塞在这里，这里主要是使用阻塞队列的offer（立即返回）；put（阻塞等待直到成功）
2. 在start()的时候，AsyncAppenderBase已经开启了一个Worker线程，用于从阻塞队列当中取数据take(阻塞等待直到成功)
3. 取出数据来之后，调用appender的appendLoopOnAppenders方法。

6. RollingFileAppender

logback logback.xml常用配置详解（二）
滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件，实际做日志打印的还是落到了RollingFileAppender这里。RollingFileAppender当中包含一下属性

6.1 关键属性说明

• append 如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• file 被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• currentlyActiveFile 标识当前正在使用的日志
• rollingPolicy 当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。
• triggeringPolicy 告知 RollingFileAppender 合适激活滚动。
• TimeBasedRollingPolicy 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。同在rollingPolicy为TimeBasedRollingPolicy时timeBasedFileNamingAndTriggeringPolicy的作用与此选项类似。
• ch.qos.logback.core.OutputStreamAppender#setLayout 用于设置日志的样式信息。

6.2 关键路径

1. append 会调用ch.qos.logback.core.rolling.RollingFileAppender#subAppend
   
   • ch.qos.logback.core.rolling.RollingFileAppender#attemptRollover 尝试滚动，会调用ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover#cleanAsynchronously异步删除文件。
   • ch.qos.logback.core.rolling.RollingFileAppender#attemptOpenFile 尝试打开文件
2. 调用 super.subAppend(event);
   
   • 调用 byte[] byteArray = this.encoder.encode(event);这里的encoder便是在ch.qos.logback.core.OutputStreamAppender#setLayout设置的Layout信息，在这里是class ch.qos.logback.core.encoder.LayoutWrappingEncoder的对象。
   • 调用ch.qos.logback.classic.PatternLayout#doLayout然后调用ch.qos.logback.core.pattern.PatternLayoutBase#writeLoopOnConverters，执行，这里是一个Converter的链表。这里所有的转换器都在PatternLayout.defaultConverterMap的Map当中存放，遇到什么类型的前缀，就从map当中取出来（已经提前取出来，做成链），做对应的转换。

7. logback.xml配置

<configuration scan="false" scanPeriod="60 seconds" debug="false">
    
    <property name="LOG_HOME" value="/Users/zeyu/logs"/>
    
    <property name="appName" value="MyTestProject">property>
    
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">

        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFOlevel>
        filter>

        <Encoding>UTF-8Encoding>
        
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            pattern>
        layout>
    appender>

    
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Encoding>UTF-8Encoding>
        
        <file>${LOG_HOME}/${appName}.logfile>

        
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
            
            <MaxHistory>365MaxHistory>
            
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ]
                - %msg%n
            pattern>
        layout>
    appender>

    
    <appender name="appLogAppenderAsync" class="ch.qos.logback.classic.AsyncAppender">
        
        <discardingThreshold>0discardingThreshold>
        
        <queueSize>2048queueSize>
        
        <appender-ref ref="appLogAppender"/>
    appender>

    
    
    <logger name="org.hibernate" level="error"/>
    
    <logger name="org.springframework" level="error" additivity="false">logger>

    <logger name="com.creditease" level="info" additivity="true">
        <appender-ref ref="appLogAppenderAsync"/>
    logger>

    
    <root level="info">
        <appender-ref ref="stdout"/>
        <appender-ref ref="appLogAppenderAsync"/>
    root>
configuration>