Logback源码解析

最新推荐文章于 2024-04-30 13:36:58 发布
最新推荐文章于 2024-04-30 13:36:58 发布
阅读量2.2k 收藏 2
点赞数
分类专栏： Java EE
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yangzl2008/article/details/81542968
版权

本文分析源码，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<E>(queueSize);
 .....
 class Worker extends Thread {
        public void run() {
            AsyncAppenderBase<E> parent = AsyncAppenderBase.this;
            AppenderAttachableImpl<E> 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配置

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，
        默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。
        默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/Users/zeyu/logs"/>
    <!-- 定义日志文件名称 -->
    <property name="appName" value="MyTestProject"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">

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

        <Encoding>UTF-8</Encoding>
        <!--
        日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度
        %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息，%n是换行符
        -->
        <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-8</Encoding>
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>

        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，
                既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!--
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置
            SizeBasedTriggeringPolicy 是无法实现按文件大小进行滚动的，必须配置
            timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!--
        日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度
        %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息，%n是换行符
        -->
        <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">
        <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>2048</queueSize>
        <!-- 添加附加的appender,最多只能添加一个 -->
        <appender-ref ref="appLogAppender"/>
    </appender>

    <!--
    logger主要用于存放日志对象，也可以定义日志类型、级别
    name：表示匹配的logger类型前缀，也就是包的前半部分
    level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
    additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
        false：表示只用当前logger的appender-ref，
        true：表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="org.hibernate" level="error"/>
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="error" additivity="false"></logger>

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

    <!--
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
    -->
    <root level="info">
        <appender-ref ref="stdout"/>
        <appender-ref ref="appLogAppenderAsync"/>
    </root>
</configuration>
Snowball
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
logback源代码
04-03
rar包中包括：logback源代码，以及struts2的基础的页面跳转，logback虽然是开源的，但它依赖的jar包找全不也不容易，当然你也可以用Maven去下载是最好的喽。 你可以访问：http://localhost:8080/try2Logback/crud2/login.jsp去访问，在Action中，去根据用户生成用户相关的信息。每个用户都有自己的文件夹。在Tomcat的webapps/Mylog文件夹下。 注意：false如果设置为false，好像是可以提交日志的吞吐量。true默认为false，如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
springboot、logback源码解读
08-23
springboot、logback源码解读，对logback从初始化到，配置文件加载到日志打印，所有步骤的源码分析
logback源码浅析
Java_dragon95的博客
04-21 1207
logback源码浅析
Logback源码分析
yangzsirr的博客
05-08 1112
logback源码分析
【Java】全网最详细的logback日志配置说明（用于生产环境日志存储）
最新发布
weixin_43219644的博客
04-30 2396
全网最详细的logback配置
Logback入门到实用
04-10 187
Logback入门到实用 概述 LogBack是一个日志框架，它与Log4j可以说是同出一源，都出自Ceki Gülcü之手。（log4j的原型是早前由Ceki Gülcü贡献给Apache基金会的）下载地址：http://logback.qos.ch/download.html ...
logback源码分析
u012758488的博客
05-11 177
https://blog.csdn.net/yangzl2008/article/details/81542968 https://www.jianshu.com/p/ebd780b082cb https://www.jianshu.com/p/5616844a5f68 https://blog.csdn.net/yinlongfei_love/article/details/80807321
源码详解系列(七) ------ 全面讲解logback的使用和源码
终极冥帝
02-01 842
什么是logback热血小说 https://m.v1122.com logback 用于日志记录，可以将日志输出到控制台、文件、数据库和邮件等，相比其它所有的日志系统，logback 更快并且更小，包含了许多独特并且有用的特性。 logback 被分成三个不同的模块：logback-core，logback-classic，logback-access。 logback-core 是其...
springboot源码解析视频
02-19
本视频课程专注于SpringBoot的源码解析，旨在帮助开发者深入理解其内部工作原理，提升对SpringBoot的掌控力。 1. **SpringBoot核心概念** - 自动配置：SpringBoot通过`@EnableAutoConfiguration`注解自动配置应用...
logback-1.1.2源码包
05-28
通过深入研究 logback 的源码，开发者可以了解其内部工作机制，如何进行日志管理、配置解析、过滤和输出等。这对于自定义日志策略、优化性能或开发扩展模块都非常有价值。此外，理解 logback-classic 如何实现 SLF4J...
SpringBoot配置lombok与logback过程解析
08-19
SpringBoot配置lombok与logback过程解析 Lombok是一款Java库，主要用来消除Java中的getter和setter方法的编写。它可以在编译时自动生成getter和setter方法，从而简化Java开发者的工作。 在SpringBoot项目中，...
logback-fluentd-appender:Logback流利的Appender
05-16
Logback流利的追加器 是附加程序。 您可以使用logback附加程序登录到Fluentd。 追加者 依赖于 。 在运行记录器之前，请先安装fluentd。 正在安装 ###从Maven2存储库安装jar配置pom.xml： <dependencies> <dependency> <groupId>com.sndyuk</groupId> <artifactId>logback-fluentd-appender</artifactId> <version>1.1.0</version> </dependency> </dependencies> <repositories> <repository> <id>com.sndyuk</id> <name>Logback more appenders</name> <url>
扩展logback将日志输出到Kafka实例扩展源码
01-23
扩展logback将日志输出到Kafka实例扩展源码，详情参见博文：http://blog.csdn.net/l1028386804/article/details/79136841
Commons Logging 源码解析一
05-29
这篇博文“Commons Logging 源码解析一”可能涉及到对这个库的内部工作原理、设计模式以及如何使用的深入探讨。在源码解析的过程中，作者可能讲解了以下关键知识点： 1. **日志接口**：Commons Logging提供了一个...
[slf4j+log] 源码解析
weixin_34038652的博客
04-11 138
slf4j: The Simple Logging Facade for java即 java简单的日志门面。统一定义了一系列的日志接口，使用户可以使用统一的接口来记录日志。logback,log4j等框架都实现了这些接口，启动时动态地决定真正的日志框架。本文以slf4j+logback的源码来讲解整个绑定和打印日志的流程。 手动阅读目录如下： 绑定日志框架 解析配置文件获取Logge...
再看 Logback 源码
CoderLi
10-24 351
三大组件 Logback 构建在三个主要的类上：Logger，Appender 和 Layouts。这三个不同类型的组件一起作用能够让开发者根据消息的类型以及日志的级别来打印日志。 Logger 类作为 logback-classic 模块的一部分。Appender 与 Layouts 接口作为 logback-core 的一部分。作为一个通用的模块，logback-core 没有 logger 的概念。 Appender 与 Layout 有选择的启用或者禁用日志的输出只是 logger 的一部分功能。l
logback性能优化及源码分析
wildpal的专栏
08-26 8504
项目中日志使用最多的是logback输出日志文件。下图是logback在实际并发环境中的表现,200并发请求，大量blocked： 移除日志输出做对比: 查看thread dump 可以看到blocked是由logback导致。logback源码分析logback文件输出类是RollingFileAppender,打印日志的方法是subAppend，rollover是关闭文件切换日志文件。/**
logback 源码分析
07-24
对于Logback的源码分析，可以从以下几个方面进行深入研究： 1. LoggerContext：Logback的核心组件之一，负责管理Logger、Appender、Filter等实例。可以分析LoggerContext的初始化过程、配置文件加载、上下文维护等。 2. Logger：Logger是Logback的日志记录器，负责日志的打印和传递。可以研究Logger的创建、级别控制、日志传递机制等。 3. Appender：Appender用于将日志输出到不同的目标，比如控制台、文件、数据库等。可以研究各种Appender的实现方式和配置。 4. Layout：Layout用于格式化日志消息。可以分析Layout的实现方式、消息格式化规则等。 5. Filter：Filter用于对日志进行过滤，可以根据一定的条件决定是否记录某条日志。可以研究Filter的实现方式和使用场景。 6. Configuration：Logback的配置文件通常使用XML格式，可以研究配置文件的解析和加载过程，以及如何动态修改配置。 在分析Logback源码时，可以结合官方文档和源码注释进行阅读。同时，建议先了解Logback的基本原理和使用方式，这样能更好地理解源码中的设计和实现细节。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值