Logback日志

什么是日志？

  • 希望系统能记住某些数据是被谁操作的，比如被谁删除了
  • 想分析用户浏览系统的具体情况，以便挖掘用户的具体喜好
  • 当系统在开发或者上线后出现了bug，崩溃了，该通过什么去分析，定位bug

好比生活中的日记，可以记录你生活中的点点滴滴

程序中的日志，通常就是一个文件，里面记录的是程序运行过程中的各种信息

以前记录日志方案

image-20250319131719934.png

弊端

  • 日志会展示在控制台
  • 不能更方便的将日志记录到其他位置（文件、数据库）
  • 想取消日志，需要修改源代码才可以完成

日志技术

  • 可以将系统执行的信息，方便的记录到知道位置（控制台、文件中、数据库中）
  • 可以随时以开关的形式控制日志的启停，无需侵入到源代码中去进行修改

日志技术的体系结构

image-20250319132114106.png

  • 日志框架：牛人或者第三方公司已经做好的实现代码，后来者直接可以直接拿去使用
  • 日志接口：设计日志框架的一套标准，日志框架需要实现这些接口

Logback是基于slf4j的日志规范实现的框架

Logback官网：https://logback.qos.ch/

Logback日志框架有以下几个模块
image-20250319132519381.png

想要使用Logback日志框架，至少需要在项目中整合如下三个模块
image-20250319132547774.png

Logback快速入门

接下来说明如何通过独立的xml配置文件来配置日志打印

根据不同的日志系统，按照指定的规则组织配置文件名，并放在 resources 目录下，就能自动被 spring boot 加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j: log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2: log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)： logging.properties

想要自定义文件名的可配置：logging.config指定配置文件名:

logging.config=classpath:logging-config.xml

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置（如使用 logback-spring.xml ，而不是 logback.xml ），命名为 logback-spring.xml 的日志配置文件， spring boot 可以为它添加一些 spring boot 特有的配置项，比如引用spring的变量(logback使用application.yml中的属性，使用springProperty才可使用application.yml中的值)

另外文件的命名和加载顺序有关, logback.xml早于application.yml加载，logback-spring.xml晚于application.yml加载

如果logback配置需要使用application.yml中的属性，需要命名为logback-spring.xml

logback 配置文件的组成

根节点<configuration>有 6个常用子标签和一个扩展标签，下面来一一进行介绍

  • configuration：根节点

    • contentName：设置上下文名称，默认为default，可通过动态变量来打印上下文名称，一般不使用该属性
    • property：用于定义变量，方便使用。有两个属性：name、value。定义变量后，可以使用${}来使用变量
    • encoder：负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。encoder中最重要就是pattern节点，它负责控制输出日志的格式
    • appender：appender用来格式化日志输出的标签，这个最重要
    • logger：此节点用来设置一个包或具体的某一个类的日志打印级别、以及指定<appender>，以下有三个属性：name、level、addtivity
    • root：root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性，用于设置打印级别
    • springProfile：<springProfile>标签是logback的Spring profile扩展的一部分，它需要logback-classic和spring-core的特定版本才能工作。确保你的项目已经包含了这些依赖

其中最重要的三个标签是appender、logger、root

root标签

root 节点是必选标签，用来指定最基础的日志输出级别，只有一个 level 属性，用于设置打印级别，可选如下：TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF

root 节点可以包含 0 个或多个元素，将appender添加进来。如下：

<root level="debug">
 <appender-ref ref="console" />
 <appender-ref ref="file" />
</root>

appender 也是子标签之一，将会在后面说明

appender标签

appender 用来格式化日志输出的标签，这个最重要

有两个属性：

  • name：appender 命名
  • class：指定输出策略，通常有两种：控制台输出，文件输出

logger标签

此节点用来设置一个包或具体的某一个类的日志打印级别、以及指定<appender>，有以下三个属性

  • name: 必须。用来指定受此 loger 约束的某个包或者某个具体的类
  • level：可选。设置打印级别。默认为 root 的级别
  • addtivity: 可选。是否向上级 loger(也就是 root 节点)传递打印信息。默认为 true

<logger>节点 使用示例如下：

  • 不指定级别，不指定 appender
<!-- 控制com.example.service下类的打印，使用root的level和appender -->
<logger name="com.example.service"/>
  • 指定级别，不指定 appender
<!-- 控制com.example.service下类的打印，使用root的appender打印warn级别日志 -->
<logger name="com.example.service" level="WARN"/>
  • 指定级别，指定 appender
<!-- 控制com.example.service下类的打印，使用console打印warn级别日志 -->
<!-- 设置addtivity是因为这里已经指定了appender，如果再向上传递就会被root下的appender再次打印 -->
<logger name="com.example.service" level="WARN" addtivity="false">
  <appender-ref ref="console">
</logger>

通过指定 appender 就能将指定的包下的日志打印到指定的文件中

encoder标签

负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。encoder中最重要就是pattern节点，它负责控制输出日志的格式

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %-40.40logger{39} --- [%15.15(%thread)]  : %msg%n</pattern>

结果示例

2023-05-06 15:48:42.519 DEBUG com.example.logback.service.UserService --- [main]:--- debug ---

关键表达式解释

%d：表示日期，默认yyyy-MM-dd

％d 转换说明符可以包含java.text.SimpleDateFormat类指定的日期和时间模式。如果省略了日期和时间模式，则采用默认模式 yyyy-MM-dd

%-5level：日志级别

%thread：表示线程名

%logger：输出日志的类名

logger{length}：对输出日志的类名缩写展示

length为整数，比如实际输出日志的类名为 com.example.logback.service.UserService 那么logger{10}时，我们发现UserService为11字符，已经超过10，那么类名的最后一个单词将原样展示，之前的包路径首字母缩写展示，最终展示为 c.e.l.s.UserService 。官网示例及规则如下

image-20250319135229513.png

%msg：日志输出内容

%n：换行符

-：减号修饰符是左对齐标志，它可以配合十进制数字控制输出的最大最小宽度

默认输出日志时右对齐左填充的，可以使用左对齐标志修改它，通常指定一个十进制的数字来表示输出是的最小最大宽度
如果输出数据的字符长度小于指定的最小宽度，则在左侧或者右侧使用空格进行填充
如果输出数据的字符长度大于指定的最小宽度，此时设置的最小宽度值失效，将按照实际的长度进行输出
也可以设置最大宽度，通过 .(点号)+十进制数字指定
如果输出数据的字符长度大于指定的最大宽度，那么多余的字符将删除，默认截取数据项的前几个字符，可以通过在点号后加减号的方式，表示为从数据项的结尾截取

contextName标签

设置上下文名称，默认为default，可通过%contextName来打印上下文名称，一般不使用此属性

property标签

用于定义变量，方便使用。有两个属性：name,value。定义变量后，可以使用${}来使用变量。如下

<property name="path" value="./log"/>
<property name="appname" value="app"/>

扩展标签springProfile

<springProfile> 标签是 logback 的一个扩展，它允许你在不同的 Spring profiles 下使用不同的 logback 配置。这是通过在 XML 配置文件中嵌入 Spring 表达式来实现的

<configuration>
 
    <!-- 默认配置，适用于所有非开发环境 -->
    <springProfile name="!dev">
        <root level="ERROR">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
 
    <!-- 开发环境配置，仅适用于spring profile为'dev'的环境 -->
    <springProfile name="dev">
        <root level="DEBUG">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
 
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
 
</configuration>

在这个例子中，如果应用程序的 Spring profile 被设置为 dev，那么日志的根级别将为 DEBUG 并且会输出到控制台。如果 Spring profile 不是 dev，那么日志的根级别将为 ERROR 并且同样输出到控制台

要激活特定的 Spring profile，你可以在启动应用程序时设置 spring.profiles.active 属性，例如通过命令行参数

java -jar yourapp.jar --spring.profiles.active=dev

或者在应用的配置文件中设置。

注意：<springProfile> 标签是 logback 的 Spring profile 扩展的一部分，它需要 logback-classic 和 spring-core 的特定版本才能工作。确保你的项目已经包含了这些依赖

多环境日志输出

通过设置文件名为-spring 结尾，可分环境配置 logger，示例如下

<configuration>
  <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
  <springProfile name="test,dev">
    <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
      <appender-ref ref="console"/>
    </logger>
  </springProfile>
  <!-- 生产环境. -->
  <springProfile name="prod">
    <logger name="com.example.demo" level="INFO" additivity="false">
      <appender-ref ref="timeFileOutput"/>
    </logger>
  </springProfile>
</configuration>

通过配置spring.profiles.active也能做到切换上面的 logger 打印设置。name属性可以指定多个，如：name="test,dev",也可以这样：name="!prod"等

设置只输出单个级别

在 appender 中设置,filter 子节点，在默认级别上再此过滤，配置 onMatch，onMismatch 可实现只输出单个级别

<appender ...>
  <filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>INFO</level>
    <!--接受匹配-->
    <onMatch>ACCEPT</onMatch>
    <!--拒绝不匹配的-->
    <onMismatch>DENY</onMismatch>
  </filter>
</appender>

通过例子来说明

输出到控制台，按时间输出日志

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <springProperty scope="context" name="applicationName"
                    source="spring.application.name" defaultValue="spring-logback-demo"/>
    <!-- 单个日志文件的最大，尺寸 -->
    <springProperty scope="context" name="maxFileSize"
                    source="logging.file.max-size" defaultValue="10MB"/>
    <!-- 日志保留时长 (天) -->
    <springProperty scope="context" name="maxHistory"
                    source="logging.file.max-history" defaultValue="30"/>
    <!-- 日志文件路径 -->
    <springProperty scope="context" name="logDir"
                    source="logging.path" defaultValue="./logs"/>
 
    <contextName>${applicationName}</contextName>
 
    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
 
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }) %clr(---){faint} %clr([%10t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wex"/>
    <property name="FILE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%t] %-40.40logger{39} : %m%n%wex"/>
 
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
 
    <!-- info日志 appender  -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印info日志 -->
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- DEBUG日志 appender  -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/debug-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印DEBUG日志 -->
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- WARN日志 appender  -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/warn-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印WARN日志 -->
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- error 日志 appender  -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${logDir}/error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印错误日志 -->
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!--  开发环境和测试环境，日志输出到控制台  -->
    <springProfile name="dev|test">
        <!--控制台和日志文件输出级别-->
        <root level="INFO">
            <appender-ref ref="STDOUT"/>
        </root>
    </springProfile>
 
    <!--  生产环境，日志输出到文件  -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="INFO"/>
            <appender-ref ref="ERROR"/>
            <appender-ref ref="DEBUG"/>
            <appender-ref ref="WARN"/>
        </root>
    </springProfile>
 
</configuration>
最后修改：2025 年 03 月 19 日
© 允许规范转载
如果觉得我的文章对你有用，请随意赞赏