SpringBoot之Logback日志文件配置

Logback是一个日志框架,Logback和Log4j都是开源的日志工具库,Logback是Log4j的改良版本,内置实现了slf4j,比Log4j拥有更多的特性,性能也带来很大提升。SpringBoot默认内置了Logback日志框架,Spring Boot 集成logback需要添加 `spring-boot-starter-logging` 依赖,而此依赖已经在 `spring-boot-starter` 中添加过了,所以不用再添加此依赖了。

Posted by Ruoli on August 12, 2022

概述

Logback是一个日志框架,Logback和Log4j都是开源的日志工具库,Logback是Log4j的改良版本,内置实现了slf4j,比Log4j拥有更多的特性,性能也带来很大提升。SpringBoot默认内置了Logback日志框架,Spring Boot 集成logback需要添加 spring-boot-starter-logging 依赖,而此依赖已经在 spring-boot-starter 中添加过了,所以不用再添加此依赖了。
Log4j建议只使用四个级别,优先级从高到低分别是 ERROR、WARN、INFO、DEBUG,优先级高的将被打印出来。(logback通用)通过定义级别,可以作为应用程序中相应级别的日志信息的开关。

  • 比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。(设置INFO级别,即:>=INFO 生效*

项目上生产环境的时候一定得把debug的日志级别重新调为warn或者更高,避免产生大量日志。

配置详解

默认情况下,SpringBoot会用Logback来记录日志,并用INFO级别输出到控制台。 配置Logback常用节点结构图:

configuration 根节点 下面包含三个属性:

  • scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
  • scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
  • debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。示例: ```xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
**appender**  
`<appender>`:负责谢日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。

**ConsoleAppender**  
`ConsoleAppender` 把日志输出到控制台,有以下子节点:  
`<encoder>` :对日志进行格式化  
`<target>`:字符串System.out(默认)或者System.err  

示例:把 >=DEBUG 级别的日志都输出到控制台
```xml
<configuration>
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
      <encoder>
         <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
      </encoder>
   </appender>

   <root level="DEBUG">
      <appender-ref ref="STDOUT" />
   </root>
</configuration>

FileAppender
<FileAppender>:把日志添加到文件,有以下子节点:

  • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • <append> :如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  • <encoder> :对记录事件进行格式化。(具体参数稍后讲解 )
  • <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。

示例:把 >= DEBUG 级别的日志都输出到 testFile.log 文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
<configuration>
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>testFile.log</file>
        <append>true</append>
        <encoder>
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
      </appender>

      <root level="DEBUG">
      <appender-ref ref="FILE" />
      </root>
</configuration>

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

  • <file> :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • <append> :如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  • <rollingPolicy> : 当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类

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

:必要节点,包含文件名及“%d”转换符,“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。
如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;
如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

https://www.cnblogs.com/hello-cnblogs/p/16398920.html