Logback配置文件详解——项目架构

原创

已于 2022-04-16 11:22:51 修改 · 7.8k 阅读

标签

#java #spring

于 2022-04-16 10:59:39 首次发布

Logback是一款高效且灵活的日志组件，由log4j创始人设计。在SpringBoot项目中，它作为默认的日志管理工具，无需额外添加依赖。配置文件主要关注`logback-spring.xml`或`logback.xml`，其中包含`<configuration>`、`<contextName>`、`<property>`、`<appender>`、`<logger>`和`<root>`等节点。日志输出策略如`ConsoleAppender`、`FileAppender`、`RollingFileAppender`等，可以配合过滤器如`ThresholdFilter`、`LevelFilter`进行精细控制。此外，`<logger>`节点可以指定特定包或类的日志级别和输出。通过对配置的深入理解，可以实现定制化的日志管理需求。

简介

Logback是由log4j创始人设计的一个开源日志组件，并通过了严格充分的测试。它主要是占用空间小，执行效率高，还提供了在其他日志框架中没有的独特而有用的特性。

使用

StringBoot项目默认使用logback组件作为日志管理。在SpringBoot项目中我们不需要额外的添加logback的依赖，因为在spring-boot-starter或者spring-boot-starter-web中已经包含了logback的依赖

Logback读取配置文件的步骤：

在classpath下查找logback-spring.xml
如果文件不存在，则查找logback.xml

配置文件位置

配置文件标签讲解

根节点：<configuration>

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

<configuration scan="true" scanPeriod="60 seconds" debug="false">
  		<!-- 其他配置-->
  </configuration>

子节点：<contextName>

<contextName>logback</contextName>

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置好，就不能修改。可以通过%contextName来打印日志上下文名称，一般来说我们不用这个属性，可有可无。

子节点：<property>

<property name="dir" value="./logs"/>

用来定义变量值的标签，它有两个属性 name 和 value：

name的值是变量的名称
value的值是变量的定义的值，通过该标签定义的值会被插入到logger上下文中，定义变量后可以通过 “ ${变量名} ” 来使用变量

子节点：<appender>

<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{requestId}] %-5level %-50logger{50}: %msg%n</Pattern>
        </encoder>
    </appender>

appender用来格式化日志输出节点，有连个属性name和class，class用来指定那种输出策略

ConsoleAppender：日志输出到控制台，类名ch.qos.logback.core.ConsoleAppender。
FileAppender：日志输入到文件，类名ch.qos.logback.core.FileAppender。作用是将日志输出到文件。目标文件可以指定，如果该文件已经存在，它将根据附加属性的值被追加或截断。
RollingFileAppender：滚动记录文件，FileAppender的子类，当符合条件（大小、时间），日志进行切分处理，类名：ch.qos.logback.