logback-spring.xml配置文件标签(超详解)

文章目录

  • 1、SpringBoot日志框架
  • 2、logback-spring.xml配置详解
    • 2.1、 一个父标签
    • 2.2、两种属性 contextName和property
      • 2.2.1、contextName
      • 2.2.2、property
    • 2.3、三个节点 appender、root、logger
      • 2.3.1 append节点
      • 2.3.2、 root
      • 2.3.3、 logger
    • 2.4 logger和root的关系
    • 2.5 环境配置
  • 3、完整的logback-spring.xml配置文件

1、SpringBoot日志框架

市面上的日志框架;
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

日志门面 (日志的抽象层)

日志实现

JCL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java) jboss-logging

Log4j JUL(java.util.logging) Log4j2 Logback

SpringBoot选用 SLF4j(日志抽象层)和logback(日志实现)
官方图:
logback-spring.xml配置文件标签(超详解)_第1张图片
简化的日志调用关系图:
logback-spring.xml配置文件标签(超详解)_第2张图片

2、logback-spring.xml配置详解

  1. SpringBoot 配置文件的加载顺序

     logback.xml—>application.properties—>logback-spring.xml
    
  2. 日志级别

     日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出
    
  3. logback-spring.xml的配置项

    共有一个父标签、两种属性、三个节点:

      一个父标签:configuration
      两种属性:contextName和property
      三个节点:appender、root、logger
    

2.1、 一个父标签

  • scan
    当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true

  • scanPeriod
    设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。

  • debug
    当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

2.2、两种属性 contextName和property

2.2.1、contextName

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
如果同时存在logback.xml和logback-spring.xml,或者同时存在logback.xml和自定义的配置文件,则会先加载logback.xml,再根据application配置加载指定配置文件,或加载logback-spring,xml。如果这两个配置文件的contextName不同,就会报错:

# logback.xml


    logback



# logback-spring,xml


    logback_demo



# application.properties
logging.config=classpath:logback-spring.xml


ERROR in ch.qos.logback.classic.joran.action.ContextNameAction - Failed to rename context [logback] as [logback_demo] java.lang.IllegalStateException: Context has been already given a name

2.2.2、property

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
例如使用定义上下文名称,然后在设置logger上下文时使用。

  
         
      ${APP_Name}  

2.3、三个节点 appender、root、logger

2.3.1 append节点

appender的意思是追加器,在这里可以理解为一个日志的渲染器(或者说格式化日志输出)。比如渲染console日志为某种格式,渲染文件日志为另一种格式。
appender中有name和class两个属性,有rollingPolicy和encoder两个子节点。
name表示该渲染器的名字,class表示使用的输出策略,常见的有控制台输出策略和文件输出策略。

  1. 控制台输出appender

    debug ${CONSOLE_LOG_PATTERN} UTF-8

encoder表示输出格式,具体说明如下:

%d表示时间
%thread表示线程名
%-5level 表示日志级别,允许以五个字符长度输出
%logger{50}表示具体的日志输出者,比如类名,括号内表示长度
%msg表示具体的日志消息,就是logger.info("xxx")中的xxx
%n表示换行

也可以设置日志的颜色和高亮,如下所示:





   
        ${pattern-color}
   

未设置颜色和高亮前:
logback-spring.xml配置文件标签(超详解)_第3张图片
设置颜色和高亮后:
image.png

  1. 文件输入appender

文件输出主要包括配置:以指定格式将日志输出到指定文件夹下的文件中,可以配置该文件的名称、最大大小、保存时间等。

   
    
    
        
        
        ${log.path}/log_debug.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        
 
        
            
            
            
            ${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log
            
            
            100MB
            
            30
            
            20GB
        
        
        
            debug
            ACCEPT
            DENY
        
    

2.3.2、 root

root节点实际上是配置启用哪种appender,可以添加多个appender。







  
  
  
  
  

2.3.3、 logger

对单个包或类添加配置:




  




  

2.4 logger和root的关系

  • root和logger是父子的关系。

logger的appender根据参数additivity决定是否要叠加root的appender,logger的级别是其自身定义的级别,和root的级别没什么关系。

  • logger对单个包或类添加配置,相当于局部配置,root相当于全局配置

如果logger里面配置了additivity=“false”,就会覆盖root的,只打印一遍;但是additivity=“true”,就会向上层再次传递,不会覆盖,而是打印两遍!

举例说明:
测试方法:

package com.pikaiqu.logbackdemo;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class LogbackdemoApplicationTests {
	private static Logger log = LoggerFactory.getLogger(LogbackdemoApplicationTests.class);
	@Test
	void logTest() {
		log.trace("======trace");
		log.debug("======debug");
		log.info("======info");
		log.warn("======warn");
		log.error("======error");
	}
}
  1. 只配置root

    logback_demo
    
        
        
            ${pattern-color}}
        
    
    
    
        
    
    

    =输出结果============
    2022-04-26 15:37:48.441 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
    2022-04-26 15:37:48.441 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
    2022-04-26 15:37:48.441 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

logback-spring.xml配置文件标签(超详解)_第4张图片)
当执行测试方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

  1. 配置root和logger,但logger不指定级别,不指定appender

    logback_demo
    
        
        
            ${pattern-color}}
        
    
    
    
    
    
        
    
    

    =输出结果============
    2022-04-26 15:39:09.351 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
    2022-04-26 15:39:09.351 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
    2022-04-26 15:39:09.351 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

logback-spring.xml配置文件标签(超详解)_第5张图片
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级(root)传递;
没有设置appender,此loger本身不打印任何信息。
将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。

当执行测试方法时,因为LogbackDemo 在包com.pikaiqu.logbackdemo中,所以首先执行,将级别为“INFO”及大于“INFO”的日志信息传递给root,本身并不打印;
root接到下级(即)传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

  1. 配置root和多个logger,指定级别,指定appender

    logback_demo ${pattern-color}}
    
    
    
        
    
    
    
        
    
    

    =输出结果============
    2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
    2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
    2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

logback-spring.xml配置文件标签(超详解)_第6张图片
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。

控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印,打印级别为“INFO”;
additivity属性为false,表示此loger的打印信息不再向上级(即)传递,
使用指定了名字为“STDOUT”的appender。

将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。

当执行测试方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向该loger的上级 传递打印信息;

未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;

如果设置,则结果如下:



    logback_demo
    
    
        
        
            ${pattern-color}}
        
    

    

    
        
    

    
        
    



=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:41:08.022 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:41:08.023 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:41:08.023 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error 
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error 

logback-spring.xml配置文件标签(超详解)_第7张图片
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。

控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印,打印级别为“INFO”;
additivity属性为false,表示此loger的打印信息会向上级(即)传递,
使用指定了名字为“STDOUT”的appender。

将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。

当执行测试方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志。
然后向该loger的上级 传递打印信息;由于没有设置appender,此loger本身不打印任何信息,而且没有设置addtivity,则默认为true,因此将此loger的打印信息向上级(root)传递。
root接到下级(即)传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台。

2.5 环境配置



    
    
    
    
    
 

3、完整的logback-spring.xml配置文件








    logback
    
    

    


    
    
        
        
            debug
        
        
            ${CONSOLE_LOG_PATTERN}
            
            UTF-8
        
    


    
    
    
        
        
        ${log.path}/log_debug.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        

        
            
            
            
            ${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log
            
            
            100MB
            
            30
            
            20GB
        
        
        
            debug
            ACCEPT
            DENY
        
    

    
    
        
        ${log.path}/log_info.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8
        
        
        
            
            
            
            ${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log
            
            
            100MB
            
            30
            
            20GB
        
        
        
        
        
            info
            ACCEPT
            DENY
        
    

    
    
        
        ${log.path}/log_warn.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        
        
            
            
            
            ${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log
            
            
            100MB
            
            30
            
            20GB
        
        
        
            warn
            ACCEPT
            DENY
        
    


    
    
        
        ${log.path}/log_error.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        
        
            
            
            
            ${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log
            
            
            100MB
            
            30
            
            20GB
        
        
        
            ERROR
            ACCEPT
            DENY
        
    

    
    
    
    
    
    
        
        
        
        
        
    


    
    
    
        
        
    

    
    
    
    
    


参考:

  1. https://blog.csdn.net/belongtocode/article/details/108451092
  2. https://blog.csdn.net/u012129558/article/details/79947477
  3. https://blog.csdn.net/IT_zhang81/article/details/99293472?spm=1001.2101.3001.6650.17&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7Edefault-17.pc_relevant_default&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7Edefault-17.pc_relevant_default&utm_relevant_index=20

最后

深知大多数初中级Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《Java开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

小编已加密:aHR0cHM6Ly9kb2NzLnFxLmNvbS9kb2MvRFVrVm9aSGxQZUVsTlkwUnc==出于安全原因,我们把网站通过base64编码了,大家可以通过base64解码把网址获取下来。

你可能感兴趣的:(面试,学习路线,阿里巴巴,spring,logback,xml,zookeeper,java)