【Spring专题】「开发指南」夯实实战基础功底之解读logback-spring.xml文件的详解实现

logback的maven配置


    org.slf4j
    slf4j-api
    2.0.3


    ch.qos.logback
    logback-core
    1.4.4


    ch.qos.logback
    logback-access
    1.4.4


    ch.qos.logback
    logback-classic
    1.4.4

日志框架层级

根节点: configuration


  • scan : 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true
  • scanPeriod : 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟
  • debug : 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态,默认值为false。

日志输出组件

子节点:appender

appender用来格式化日志输出节点,有两个属性nameclass,class用来指定哪种输出策略。

总体的层级结构

  • appender:定义appender填充器的名称和类定义
    • encoder:日志格式配置定义声明编码格式实现类
      • pattern:主要定义日志输出的字符串格式

常用就是控制台输出策略和文件输出策略,如下。

ConsoleAppender-控制台输出器

ConsoleAppender主要的作用是将日志信息打印到控制台上,更加准确的说:使用System.out或者System.err方式输出,主要子标签有:encodertarget这两个元素标签,具体案例样式如下所示。


     
         %date{"yyyy-MM-dd,HH:mm:ss,SSS"} [%X{TID}] [%thread] %-5level %logger{36} - %msg%n
         UTF-8 
     

最外面xml标签(append)里面定义了对应的append的名称name,以及(class)对应的实际填充对象类,如下所示。


encoder标签

  • :主要用于定义对应的编码模式和编码格式组件的声明。
  • :主要用于定义对应的该encoder下的编码模式字符串,例如:%date{"yyyy-MM-dd,HH:mm:ss,SSS"} [%X{TID}] [%thread] %-5level %logger{36} - %msg%n

内部的格式字符,例如:%date等的相关的格式讲解后面的章节会统一详细的去进行介绍,大家可以根据后面的章节进行学习即可。

FileAppender-文件输出器

用于将日志信息输出到文件中,主要子标签有:appender,encoder,file,对应的层级关系为:

  • appender:日志文件输出appender对象
    • encoder:日志格式配置定义声明编码格式实现类
      • file:日志输出路径,代表着文件目录加文件名称

appender

同上,依然保持不变的配置模式

  
      
           ${pattern}
     
      ${log_dir}/logback.log
 

encoder标签

  • :主要用于定义对应的编码模式和编码格式组件的声明。
  • :主要用于定义对应的该encoder下的编码模式字符串,例如:%date{"yyyy-MM-dd,HH:mm:ss,SSS"} [%X{TID}] [%thread] %-5level %logger{36} - %msg%n

file标签

  • :日志输出路径,代表着文件目录加文件名称
${log_dir}/logback.log

RollingFileAppender-滚动文件输出器

RollingFileAppender是FileAppender的子类,继承关系。

扩展能力

如果满足一定的条件,能够动态的创建一个文件。然后将日志写入到新的文件中。

主要子标签

file(文件全路径),filter(过滤器),encoder(输出格式化),rollingPolicy(滚动策略),总体的相关案例如下所示。


        ${LOG_BASE_DIR}/log-error.log
        
            Error
            ACCEPT
            DENY
        
        
            ${LOG_BASE_DIR}/log-error.%d{yyyy-MM-dd}.%i.log
            ${LOG_FILE_MAX_SIZE}
            ${LOG_FILE_MAX_HISTORY}
            ${LOG_FILE_TOTAL_SIZE_CAP}
        
        
            %date{"HH:mm:ss,SSS"} [%X{TID}] [%thread] %-5level %logger{36} - %msg%n
            UTF-8
        

其中,我们重点需要了解的是filter(过滤器)rollingPolicy(滚动策略)这两个标签对应的功能。

filter(过滤器)

过滤器主要分为两个常用的种类:ThresholdFilter和LevelFilter的过滤器。

系统定义的拦截器(ThresholdFilter)

过滤掉ERROR级别以下的日志不输出到文件中。


    ERROR

策略拦截器(LevelFilter)

使用匹配规则匹配level,按照规则进行打印,可以避免输出 Error级别 之外的日志



            Error

            ACCEPT

            DENY
 
rollingPolicy(滚动策略)

盘点我们常用的策略方式主要就是一下这两种:

TimeBasedRollingPolicy

它根据时间来制定滚动策略.时间滚动策略可以基于时间滚动按时间生成日志,无法控制文件大小。

SizeAndTimeBasedRollingPolicy
        
            ${LOG_BASE_DIR}/log-error.%d{yyyy-MM-dd}.%i.log
            ${LOG_FILE_MAX_SIZE}
            ${LOG_FILE_MAX_HISTORY}
            ${LOG_FILE_TOTAL_SIZE_CAP}
        

基于大小和时间的滚动策略。这个策略出现的原因就是对时间滚动策略的一个补充,使其不仅按时间进行生成而且考虑到文件大小的原因,因为在基于时间的滚动策略生成的日志文件,只是对一段时间总的日志大小做了限定,但是没有对每个日志文件的大小做限定,这就会造成个别日志文件过大,后期传递,所以就有了这个策略。

注意:totalSizeCap属性生效需要logback-classic依赖与logback-core依赖版本大于1.2.0,原因:ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover类存在计算溢出问题。

子节点:logger

案例配置如下。

 
        
 
  • name:用来指定受此logger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值-INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。
  • addtivity:是否向上级logger传递打印信息。默认是true。logger最上级为root节点

子节点: root


  
  

  • root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。level默认是DEBUG。
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL

属性节点

定义上下文变量,name变量名称,value为值。

logback的容器上下文


... ...

        
 

应用springboot的环境变量

从springboot配置变量中获取key为source的值,name变量名称.



            ${LOG_FILE_MAX_SIZE}

划分出不同的profile环境下的环境变量









完整案例



    
    
    
    
    
    

    

        ${LOG_BASE_DIR}/logfile-error.log

        

            Error

            ACCEPT

            DENY
        

        
            ${LOG_BASE_DIR}/logfile-error.%d{yyyy-MM-dd}.%i.log

            ${LOG_FILE_MAX_SIZE}

            ${LOG_FILE_MAX_HISTORY}

            ${LOG_FILE_TOTAL_SIZE_CAP}
        
        

            ${FILE_LOG_PATTERN}

            UTF-8
        
    

    

        ${LOG_BASE_DIR}/logfile-all.log

        
            ${LOG_BASE_DIR}/logfile-all.%d{yyyy-MM-dd}.%i.log

            ${LOG_FILE_MAX_SIZE}

            ${LOG_FILE_MAX_HISTORY}

            ${LOG_FILE_TOTAL_SIZE_CAP}
        
        

            ${FILE_LOG_PATTERN}

            UTF-8
        
    
    
        
        
    

文章来源于互联网:【Spring专题】「开发指南」夯实实战基础功底之解读logback-spring.xml文件的详解实现

THE END
分享
二维码