SpringBoot学习笔记(三)整合Logback日志框架

一、日志框架介绍

1、常见日志框架

SpringBoot学习笔记(三)整合Logback日志框架_第1张图片

目前我们常见的日志框架为Log4j、Log4j2、Logback这3种,并且现在很多的工具包里面都会自带日志框架,因此我们使用要格外小心日志框架的冲突。

2、三种日志框架之间的关系

最先有Log4j,然后因为Log4j有很大的性能问题因此该作者又重写了一个Logback,并且抽象出一个日志门面slf4j。由于之前Log4j的问世,Apache公司就借鉴了Log4j的部分原理,自己重新写了一个日志框架Log4j2,并且也实现了slf4j日志门面。

3、SpringBoot默认的日志框架 Logback

SpringBoot种采用Logback作为默认的日志框架,至于为何会选择Logback而不是Apache开发的Log4j2,理由如下:

在SpringBoot中,底层是Spring框架,Spring框架默认使用JCL,而SpringBoot默认集成的日志框架需要的是SLF4j+Logback组合。因为spring-boot-starter-logging是Logback的日志实现,而SpringBoot启动项spring-boot-starter又依赖了spring-boot-starter-logging,所以Spring Boot就默认集成了Logback。

默认情况下,SpringBoot内部使用logback作为系统日志实现的框架,将日志输出到控制台,不会写到日志文件。如果在application.properties或application.yml配置,这样只能配置简单的场景,保存路径、日志格式等。复杂的场景(区分 info 和 error 的日志、每天产生一个日志文件等)满足不了,只能自定义配置文件logback-spring.xml。

二、SpringBoot整合Logback日志框架

1、Logback日志

1)什么是日志

通过日志查看程序的运行过程,运行信息,异常信息等

2)日志级别

日志记录器(Logger)的行为是分等级的。如下所示:

分为:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF

默认情况下,SpringBoot从控制台打印出来的日志级别只有INFO及以上级别,可以配置日志级别

# 设置日志级别
logging:
  level:
    root: ERROR

这种方式能将ERROR级别以及以上级别的日志输出到控制台上,其他级别将不会输出。

SpringBoot学习笔记(三)整合Logback日志框架_第2张图片

根据上图查看包结构我们可以发现,SpringBoot默认集成的日志框架确实是Logback,因此我们使用Logback框架就变得很简单了。

2、创建日志文件

SpringBoot内部使用Logback作为日志实现的框架。

  • logback.xml:直接就被日志框架识别了;

  • logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能

resources 中创建 logback-spring.xml (默认日志文件的名字)

3、基本配置说明

3.1 configuration

日志配置的根节点

SpringBoot学习笔记(三)整合Logback日志框架_第3张图片

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

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

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

  
        

3.2 contextName

的子节点。

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同的应用程序。

atguiguSrb

3.3 property

的子节点,用来定义变量。

有两个属性,name和value:name的值是变量的名称,value是变量的值。

通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
















3.4 appender

的子节点,是负责写日志的组件

有两个必要属性name和class,name指定appender名称,class指定appender的全限定名

对日志进行格式化

定义日志的具体输出格式

编码方式

控制台日志配置



    
        ${CONSOLE_LOG_PATTERN}
        ${ENCODING}
    

文件日志配置

表示日志文件的位置,如果上级目录不存在会自动创建,没有默认值。

默认 true,日志被追加到文件结尾,如果是 false,服务重启后清空现存文件。



    ${log.path}/log.log
    true
    
        ${FILE_LOG_PATTERN}
        ${ENCODING}
    

3.5设置logger、root

设置logger

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定仅有一个name属性,一个可选的level和一个可选的addtivity属性。

  • name:用来指定受此logger约束的某一个包或者具体的某一个类。

  • level:用来设置打印级别(日志级别),大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。

  • addtivity:是否向上级logger传递打印信息。默认是true。

可以包含零个或多个元素,标识这个appender将会添加到这个logger。

设置root

也是元素,但是它是根logger。只有一个level属性,因为name已经被命名为"root".

  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。

举例说明

LogbackDemo.java类


package logback;  
  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class LogbackDemo {  
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
    }  
}

第1种:只配置root

    
   
     
       
       
      %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n   
       
     
   
               
       
       
     
 

当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

13:30:38.484 [main] INFO logback.LogbackDemo - ======info 13:30:38.500 [main] WARN logback.LogbackDemo - ======warn 13:30:38.500 [main] ERROR logback.LogbackDemo - ======error

第2种:带有logger的配置,不指定级别,不指定appender,

   
   
     
       
       
      %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n   
       
     
   
     
     
   
               
       
       
     
 

将控制logback包下的所有类的日志的打印,但是并没有设置打印级别,所以继承他的上级的日志级别“DEBUG”;

  • 没有设置addtivity,默认为true,将此logger的打印信息向上级传递;

  • 没有设置appender,此logger本身不打印任何信息。

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

当执行logback.LogbackDemo类的main方法时,因为LogbackDemo 在包logback中,所以首先执行,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;

root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug 13:19:15.406 [main] INFO logback.LogbackDemo - ======info 13:19:15.406 [main] WARN logback.LogbackDemo - ======warn 13:19:15.406 [main] ERROR logback.LogbackDemo - ======error

第3种:带有多个logger的配置,指定级别,指定appender

    
      
       
       
      %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n   
       
     
   
     
     
     
    
      
     
    
               
       
       

将控制logback包下的所有类的日志的打印,但是并没有设置打印级别,所以继承他的上级的日志级别“DEBUG”;

  • 没有设置addtivity,默认为true,将此logger的打印信息向上级传递;

  • 没有设置appender,此logger本身不打印任何信息。

控制logback.LogbackDemo类的日志打印,打印级别为“INFO”;

  • additivity属性为false,表示此logger的打印信息不再向上级传递

  • 指定了名字为“STDOUT”的appender。

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

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

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

14:05:35.937 [main] INFO logback.LogbackDemo - ======info 14:05:35.937 [main] WARN logback.LogbackDemo - ======warn 14:05:35.937 [main] ERROR logback.LogbackDemo - ======error

如果将修改为 那打印结果将是什么呢?

没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次

打印结果如下:

14:09:01.531 [main] INFO logback.LogbackDemo - ======info
14:09:01.531 [main] INFO logback.LogbackDemo - ======info
14:09:01.531 [main] WARN logback.LogbackDemo - ======warn
14:09:01.531 [main] WARN logback.LogbackDemo - ======warn
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error

4、多环境配置

springProfile

在一个基于Spring boot开发的项目里,常常需要有多套环境的配置:开发,测试以及产品。使用springProfile 可以分别配置开发(dev),测试(test)以及生产(prod)等不同的环境



    
        
    



    
        
        
    

5、滚动日志

问题:生产环境下,如果系统长时间运行,那么日志文件会变得越来越大,系统读取和写入日志的时间会越来越慢,严重的情况会耗尽系统内存,导致系统宕机。

解决方案:可以设置滚动日志。

1、设置时间滚动策略

RollingFileAppender是Appender的另一个实现,表示滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将旧日志备份到其他文件

的子节点,用来定义滚动策略。

TimeBasedRollingPolicy:最常用的滚动策略,根据时间来制定滚动策略。

:包含文件名及转换符, “%d”可以包含指定的时间格式,如:%d{yyyy-MM-dd}。如果直接使用 %d,默认格式是 yyyy-MM-dd。

:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件时,那些为了归档而创建的目录也会被删除。


    
    ${log.path}/log-rolling.log
    
        ${FILE_LOG_PATTERN}
        ${ENCODING}
    
    
    
        
        ${log.path}/info/log-rolling-%d{yyyy-MM-dd}.log
        
        15
    

2、设置触发滚动时机

放在的子节点的位置,基于实践策略的触发滚动策略

:活动文件的大小,默认值是10MB。

注意:修改日志文件名 此时 ${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.log


    1KB

SpringBoot学习笔记(三)整合Logback日志框架_第4张图片

6、完整的日志配置文件




    atguiguSrb

    
    

    
    

    
    

    
    


    
    
        
            ${CONSOLE_LOG_PATTERN}
            ${ENCODING}
        
    

    
    
        ${log.path}/log.log
        true
        
            ${FILE_LOG_PATTERN}
            ${ENCODING}
        
    

    

        
        ${log.path}/log-rolling.log
        
            ${FILE_LOG_PATTERN}
            ${ENCODING}
        


        
        
            
            ${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.log
            
            15

            
                1KB
            
        

    

    
    
    
    
    

    
    
        
            
            
        
    

    
    
        
            
            
        
    

测试发现,配置文件里设置为1kb,归档储存为2kb,当配置文件中设置为2kb,归档储存为3kb,具体原因不是很清楚。

由于设置每2KB就进行归档存储,所以在没满2KB的文档记录如下:

SpringBoot学习笔记(三)整合Logback日志框架_第5张图片

日志记录满2KB时,归档储存:

SpringBoot学习笔记(三)整合Logback日志框架_第6张图片
SpringBoot学习笔记(三)整合Logback日志框架_第7张图片

参考文章:

logback 配置详解(一)——logger、root_logback logger.error

springboot日志框架

你可能感兴趣的:(#,SpringBoot,spring,boot)