Bootstrap

故事篇:终于给老婆讲明白什么是logback了!

故事会迟到,但他从不会缺席。今天的故事开始了,你准备好了吗?

前奏

简单介绍一下我的老婆:集智慧与美貌于一身的女子——阿狸,一句“我们心有灵犀,不是吗?”让我瞬间“沦陷”。

正题

LogBack简介

常见的日志框架呢有以下几种:

  • JUL(Java Util Logging)

  • Logback

  • Log4j

  • Log4j2

  • JCL(Jakarta Commons Logging)

  • Slf4j(Simple Logging Facade For Java)

我觉得这也是它在市面上比较流行,项目中使用比较多的原因吧。

门面与实现的关系了解一下

![](https://files.mdnice.com/user/12683/eb04178b-9e1d-434e-9e4b-e53a9bd2f1b7.png =400x300)

接着奉上,它分为以下三个模块:

  • logback-core:其它两个模块的基础模块;

  • logback-classic:它是的一个改良版本,同时它完整实现了,你可以很方便地更换成其它日志框架(如或者);

  • logback-access:访问模块与容器集成提供通过来访问日志的功能,可以轻松地在核心之上构建自己的模块。

组件之间的关系 可以大体了解下,实战篇更容易理解

  • 作为日志的记录器,把它关联到应用的对应的上后,主要用于存放日志对象,也可以定义日志类型、级别;

  • 主要用于指定日志输出的目的地,可以是控制台、文件、远程套接字服务器、、、 和其他数据库、 和远程守护进程等;

  • 负责把事件转换成字符串,格式化的日志信息的输出。在中对象被封装在中;

  • :各个都被关联到一个 ,它负责制造,也负责以树结构排列各。其他所有也通过 类的静态方法取得。

可以被分配的级别包括:、、、 和 ,定义于类。如果 没有被分配级别,那么它将从有被分配级别的最近的祖先那里继承级别。 默认级别是 。

级别排序为: < < < <

项目实战



  org.slf4j
  slf4j-api
  1.7.30




  ch.qos.logback
  logback-classic
  1.2.3

会从 下依次读取以下类型的配置文件:

  • logback.groovy

  • logback-test.xml

  • logback.xml

如果文件都不存在,用 自动对自己进行配置,这会导致记录输出到控制台。

基本信息配置

代码测试样例奉上:

public class TestLogBack {

    private static final Logger logger = LoggerFactory.getLogger(TestLogBack.class);

    public static void main(String[] args) {
        for (int i = 0; i < 10000; i++) {

            logger.error("error");
            logger.warn("warn");
            logger.info("info");
            logger.debug("debug");
            logger.trace("trace");

        }
    }
}

首先我们在下创建一个,然后进行配置



    

    
    

    
    
        
        System.err
        
        
            ${pattern}
        
    


    
    

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

    
    
        
        ${log_dir}/logback.html
        
        
            

                %-5level%d{yyyy-MM-dd HH:mm:ss.SSS}%c%M%L%thread%m
            
        
    
  
    
        
        
        
    
    

运行之后发现在控制台打印出红色字体的日志信息,在文件下有和两个日志文件,在项目中一般都只会使用结尾的日志的。



    
    ${log_dir}/roll_logback.log
    
    
        ${pattern}
    
    
    
        
        
        1MB
        
        ${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gz
    

此时我们对测试程序加上循环,循环次,发现每秒或者每超过都会产生新的文件。当然也可以在下增加过滤器,过滤需要的日志级别。




    
    ERROR
    
    ACCEPT
    
    DENY



    
    

除了上边用到的,还支持自定义的呢。



  

SpringBoot中使用

默认日志是级别

我们还可以直接使用的注解来代替上边的

private static final Logger logger = LoggerFactory.getLogger(TestLogBack.class);

引用是使用来实现。它的默认加载顺序是->

我们可以在中简单配置

#指定自定义 logger 对象的日志级别
logging.level.com.itzyq.sblogback=trace

#指定控制台输出消息格式
logging.pattern.console=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n

#指定存放日志文件的具体路径(已经弃用)
#logging.file=/logs/springboot.log
#指定日志文件存放的目录,默认的文件名为spring.log
logging.file.path=/logs/springboot/
#指定日志文件的消息格式
logging.pattern.file=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n

因为在中配置功能有限,我们还是使用上文中的来配置。

只有在应用程序运行的时候才生效,即带有注解的类启动的时候才会生效。这里我们完全可以使用它。

另外它还有个特殊的功能,可以用来解析日志的配置。




    

    
    

    
    
        
        ${log_dir}/logback.log
        
        
            
                ${pattern}
            
            
                 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %m%n
            
        
    

    
        
    


此时在中引入或者可以切换测试和正式环境了,是不是很方便呀。

Logback-access

模块与容器(如和)集成,已提供访问日志功能。我们可以使用模块来替换的访问日志;


这一行通常嵌套在一个 或 元素中。


  
    

  
    access.log
    
      access.%d{yyyy-MM-dd}.log.zip
    

    
      
      %h %l %u [%t] "%r" %s %b "%i{Referer}" “%i{User-Agent}”
      combined
    
  
 
  

配置信息补充

(1)根节点,包含下面三个属性:

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

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

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

 
 

(2):用来设置上下文名称,每个都关联到上下文,默认上下文名称为。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。

 
     myAppName 
      

(3)  :用来定义变量值,它有两个属性和,通过定义的值会被插入到上下文中,可以使“${}”来使用变量。

  • : 变量的名称

  • : 的值时变量定义的值

(4) :获取时间戳字符串,他有两个属性和

  • : 标识此的名字;

  • : 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循的格式。

 
     

(5):负责写日志的组件,它有两个必要属性和。指定名称,指定的全限定名

5.1、 把日志输出到控制台,有以下子节点:

  • :对日志进行格式化。

  • :字符串(默认)或者

5.2、:把日志添加到文件,有以下子节点:

  • :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。

  • :如果是 ,日志被追加到文件结尾,如果是 ,清空现存文件,默认是。

  • :对记录事件进行格式化。

  • :如果是 ,日志会被安全的写入文件,即使其他的也在向此文件做写入操作,效率低,默认是 。

5.3、:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:

  • :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。

  • :如果是 ,日志被追加到文件结尾,如果是 ,清空现存文件,默认是。

  • :当发生滚动时,决定的行为,涉及文件移动和重命名。属性定义具体的滚动策略类。

5.4、策略:class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责触发滚动。有以下子节点:

  • :必要节点,包含文件名及“%d”转换符,可以包含一个指定的时间格式,如:。如果直接使用 ,默认格式是 。

  • 的子节点可有可无,通过设置,可以为活动文件和归档文件指定不同位置,当前日志总是记录到指定的文件(活动文件),活动文件的名字不会改变;如果没设置,活动文件的名字会根据 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

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

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看当前活动文件的大小,如果超过指定大小会告知 触发当前活动文件滚动。只有一个节点:

  • :这是活动文件的大小,默认值是。

  • :当为时,不支持。支持,但是有两个限制,1不支持也不允许文件压缩,2不能设置属性,必须留空。

  • : 告知 合适激活滚动。

class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点:

  • :窗口索引最小值

  • :窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。

  • :必须包含例如,假设最小值和最大值分别为1和2,命名模式为 ,会产生归档文件和。还可以指定文件压缩选项,例如, 或者 没有

 
       
         
          logFile.%d{yyyy-MM-dd}.log 
          30 
         
         
          %-4relative [%thread] %-5level %logger{35} - %msg%n 
         
       

       
         
       
    
   //上述配置表示每天生成一个日志文件,保存30天的日志文件。

 
       
        test.log 

         
          tests.%i.log.zip 
          1 
          3 
         

         
          5MB 
         
         
          %-4relative [%thread] %-5level %logger{35} - %msg%n 
         
       

       
         
       
    
    //上述配置表示按照固定窗口模式生成日志文件,当文件大于5MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。

:对记录事件进行格式化。负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。

是唯一有用的且默认的 ,有一个节点,用来设置日志的输入格式。使用加“转换符”方式,如果要输出,则必须用对进行转义。

(6)子节点:用来设置某一个包或具体的某一个类的日志打印级别、以及指定。仅有一个属性,一个可选的和一个可选的(单词一定要注意写对,好多地方都写成了addtivity)属性。可以包含零个或多个元素,标识这个将会添加到这个

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

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

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

(7)子节点:它也是元素,但是它是根 ,是所有的上级。只有一个属性,因为已经被命名为,且已经是最上级了。同一样,可以包含零个或多个元素,标识这个将会添加到这个。

  • : 用来设置打印级别,大小写无关:, , , , , 和,不能设置为或者同义词。 默认是

常用配置

 











以上就是今天的所有内容了,如果你有不同的意见或者更好的,欢迎联系阿Q:,阿Q期待你的到来!

后台留言领取java干货资料:学习笔记与大厂面试题