正文

最全的springboot+logback日志配置教程

码农小宋  码农小宋  2022-12-02  426

关键词：

项目中日志系统是必不可少的，目前比较流行的日志框架有log4j、logback等，可能大家还不知道，这两个框架的作者是同一个人，Logback旨在作为流行的log4j项目的后续版本，从而恢复log4j离开的位置。

另外 slf4j(Simple Logging Facade for Java) 则是一个日志门面框架，提供了日志系统中常用的接口，logback 和 log4j 则对slf4j 进行了实现。我们本文将讲述如何在spring boot 中应用 logback+slf4j实现日志的记录。

为什么使用logback

Logback 是log4j 框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J Logback的定制性更加灵活，同时也是spring boot的内置日志框架

开始使用

一、添加依赖

maven依赖中添加了spring-boot-starter-logging

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

但是呢，实际开发中我们不需要直接添加该依赖，你会发现spring-boot-starter其中包含了 spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 Logback+SLF4J。而 spring-boot-starter-web 包含了spring-boot-starte，所以我们只需要引入web组件即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

二、默认配置

默认情况下Spring Boot将日志输出到控制台，不会写到日志文件。如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性

注：二者不能同时使用，如若同时使用，则只有logging.file生效

logging.file=文件名
logging.path=日志文件路径
 
logging.level.包名=指定包下的日志级别
logging.pattern.console=日志打印规则

logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log

logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log

注：二者不能同时使用，如若同时使用，则只有logging.file生效，可以看到这种方式配置简单，但是能实现的功能也非常有限，如果想要更复杂的需求，就需要下面的定制化配置了。

三、logback-spring.xml详解

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，将xml放至 src/main/resource下面。

也可以使用自定义的名称，比如logback-config.xml，只需要在application.properties文件中使用logging.config=classpath:logback-config.xml指定即可。

在讲解 logback-spring.xml之前我们先来了解三个单词：Logger, Appenders and Layouts（记录器、附加器、布局）：Logback基于三个主要类：Logger，Appender和Layout。

这三种类型的组件协同工作，使开发人员能够根据消息类型和级别记录消息，并在运行时控制这些消息的格式以及报告的位置。首先给出一个基本的xml配置如下：

<configuration>
 
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <pattern>%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n</pattern>
    </encoder>
  </appender>
 
  <logger name="chapters.configuration" level="INFO"/>
 
  <!-- Strictly speaking, the level attribute is not necessary since -->
  <!-- the level of the root level is set to DEBUG by default.       -->
  <root level="DEBUG">          
    <appender-ref ref="STDOUT" />
  </root>  
  
</configuration>

3.1：<configuration>元素

logback.xml配置文件的基本结构可以描述为<configuration>元素，包含零个或多个<appender>元素，后跟零个或多个<logger>元素，后跟最多一个<root>元素(也可以没有)。下图说明了这种基本结构：

最全的

3.2：<logger>元素

<logger>元素只接受一个必需的name属性，一个可选的level属性和一个可选的additivity属性，允许值为true或false。 level属性的值允许一个不区分大小写的字符串值TRACE，DEBUG，INFO，WARN，ERROR，ALL或OFF。

特殊于大小写不敏感的值INHERITED或其同义词NULL将强制记录器的级别从层次结构中的较高级别继承，<logger>元素可以包含零个或多个<appender-ref>元素; 这样引用的每个appender都被添加到指定的logger中，(注：additivity属性下面详说)，logger元素级别具有继承性。

例1：示例中，仅为根记录器分配了级别。此级别值DEBUG由其他记录器X，X.Y和X.Y.Z继承

最全的例2：所有记录器都有一个指定的级别值。级别继承不起作用

最全的例3：记录器root，X和X.Y.Z分别被分配了DEBUG，INFO和ERROR级别。 Logger X.Y从其父X继承其级别值。

最全的例4：在示例4中，记录器root和X分别被分配了DEBUG和INFO级别。记录器X.Y和X.Y.Z从其最近的父X继承其级别值，该父级具有指定的级别。

最全的 3.3：<root>元素

<root>元素配置根记录器。它支持单个属性，即level属性。它不允许任何其他属性，因为additivity标志不适用于根记录器。此外，由于根记录器已被命名为“ROOT”，因此它也不允许使用name属性。

level属性的值可以是不区分大小写的字符串TRACE，DEBUG，INFO，WARN，ERROR，ALL或OFF之一<root>元素可以包含零个或多个<appender-ref>元素; 这样引用的每个appender都被添加到根记录器中(注：additivity属性下面详说)。

3.4：<appender>元素

appender使用<appender>元素配置，该元素采用两个必需属性name和class。 name属性指定appender的名称，而class属性指定要实例化的appender类的完全限定名称。 <appender>元素可以包含零个或一个<layout>元素，零个或多个<encoder>元素以及零个或多个<filter>元素，下图说明了常见的结构：

最全的重要：在logback中，输出目标称为appender，addAppender方法将appender添加到给定的记录器logger。给定记录器的每个启用的日志记录请求都将转发到该记录器中的所有appender以及层次结构中较高的appender。换句话说，appender是从记录器层次结构中附加地继承的。

例如，如果将控制台appender添加到根记录器，则所有启用的日志记录请求将至少在控制台上打印。如果另外将文件追加器添加到记录器（例如L），则对L和L的子项启用的记录请求将打印在文件和控制台上。通过将记录器的additivity标志设置为false，可以覆盖此默认行为，以便不再添加appender累积。

Appender是一个接口，它有许多子接口和实现类，具体如下图所示：

最全的其中最重要的两个Appender为：ConsoleAppender 、RollingFileAppender。

3.4.1：ConsoleAppender

ConsoleAppender，如名称所示，将日志输出到控制台上。

3.4.2：RollingFileAppender

RollingFileAppender，是FileAppender的一个子类，扩展了FileAppender，具有翻转日志文件的功能。例如，RollingFileAppender 可以记录到名为log.txt文件的文件，并且一旦满足某个条件，就将其日志记录目标更改为另一个文件。

有两个与RollingFileAppender交互的重要子组件。第一个RollingFileAppender子组件，即 RollingPolicy 负责执行翻转所需的操作。 RollingFileAppender的第二个子组件，即 TriggeringPolicy 将确定是否以及何时发生翻转。因此，RollingPolicy 负责什么和TriggeringPolicy 负责什么时候。

作为任何用途，RollingFileAppender 必须同时设置 RollingPolicy 和 TriggeringPolicy。但是，如果其 RollingPolicy 也实现了TriggeringPolicy 接口，则只需要显式指定前者。

3.4.3：滚动策略

TimeBasedRollingPolicy： 可能是最受欢迎的滚动策略。它根据时间定义翻转策略，例如按天或按月。 TimeBasedRollingPolicy承担滚动和触发所述翻转的责任。实际上，TimeBasedTriggeringPolicy实现了RollingPolicy和TriggeringPolicy接口。

SizeAndTimeBasedRollingPolicy： 有时您可能希望按日期归档文件，但同时限制每个日志文件的大小，特别是如果后处理工具对日志文件施加大小限制。为了满足此要求，logback 提供了 SizeAndTimeBasedRollingPolicy ，它是TimeBasedRollingPolicy的一个子类，实现了基于时间和日志文件大小的翻滚策略。

3.5：<encoder>元素

encoder中最重要就是pattern属性，它负责控制输出日志的格式，这里给出一个我自己写的示例：

<pattern>%dyyyy-MM-dd HH:mm:ss.SSS %highlight(%-5level) --- [%15.15(%thread)] %cyan(%-40.40(%logger40)) : %msg%n</pattern>

使用后的输出格式如下图所示

最全的其中：

%dyyyy-MM-dd HH:mm:ss.SSS：日期

%-5level：日志级别

%highlight()：颜色，info为蓝色，warn为浅红，error为加粗红，debug为黑色

%thread：打印日志的线程

%15.15():如果记录的线程字符长度小于15(第一个)则用空格在左侧补齐,如果字符长度大于15(第二个),则从开头开始截断多余的字符 

%logger：日志输出的类名

%-40.40()：如果记录的logger字符长度小于40(第一个)则用空格在右侧补齐,如果字符长度大于40(第二个),则从开头开始截断多余的字符

%cyan：颜色

%msg：日志输出内容

%n：换行符

3.6：<filter>元素

filter中最重要的两个过滤器为：LevelFilter、ThresholdFilter。

LevelFilter 根据精确的级别匹配过滤事件。如果事件的级别等于配置的级别，则筛选器接受或拒绝该事件，具体取决于onMatch和onMismatch属性的配置。例如下面配置将只打印INFO级别的日志，其余的全部禁止打印输出：

<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger30 - %msg%n
      </pattern>
    </encoder>
  </appender>
  <root level="DEBUG">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

ThresholdFilter 过滤低于指定阈值的事件。对于等于或高于阈值的事件，ThresholdFilter将在调用其decision()方法时响应NEUTRAL。

但是，将拒绝级别低于阈值的事件，例如下面的配置将拒绝所有低于INFO级别的日志，只输出INFO以及以上级别的日志：

<configuration>
  <appender name="CONSOLE"
    class="ch.qos.logback.core.ConsoleAppender">
    <!-- deny all events with a level below INFO, that is TRACE and DEBUG -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger30 - %msg%n
      </pattern>
    </encoder>
  </appender>
  <root level="DEBUG">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

四、详细的logback-spring.xml示例：

以上介绍了xml中重要的几个元素，下面将我配置的xml贴出来以供参考（实现了基于日期和大小翻滚的策略，以及经INFO和ERROR日志区分输出，还有规范日志输出格式等）：

<?xml versinotallow="1.0" encoding="UTF-8"?>
<configuration debug="true">



<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">


<encoder>







<pattern>%dyyyy-MM-dd HH:mm:ss.SSS %highlight(%-5level) --- [%15.15(%thread)] %cyan(%-40.40(%logger40)) : %msg%n</pattern>

<charset>UTF-8</charset>
</encoder>
</appender>





<appender name="info_log" class="ch.qos.logback.core.rolling.RollingFileAppender">

<File>logs/project_info.log</File>

<append>true</append>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">



<fileNamePattern>logs/project_info.%d.%i.log</fileNamePattern>

<maxHistory>30</maxHistory>

<totalSizeCap>20GB</totalSizeCap>

<maxFileSize>10MB</maxFileSize>
</rollingPolicy>

<encoder>

<pattern>%dyyyy-MM-dd HH:mm:ss.SSS %-5level --- [%15.15(%thread)] %-40.40(%logger40) : %msg%n</pattern>

<charset>UTF-8</charset>
</encoder>
</appender>





<appender name="error_log" class="ch.qos.logback.core.rolling.RollingFileAppender">

<File>logs/project_error.log</File>

<append>true</append>

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">



<fileNamePattern>logs/project_error.%d.%i.log</fileNamePattern>
<!-- 每产生一个日志文件，该日志文件的保存期限为30天, ps:maxHistory的单位是根据fileNamePattern中的翻转策略自动推算出来的,例如上面选用了yyyy-MM-dd,则单位为天

springboot配置logback日志

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core,logback-classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4JAPI使你可以... 查看详情

springboot系列一:默认日志logback配置解析

前言今天来介绍下SpringBoot如何配置日志logback,我刚学习的时候，是带着下面几个问题来查资料的，你呢如何引入日志？日志输出格式以及输出方式如何配置？代码中如何使用？正文SpringBoot在所有内部日志中使用CommonsLogging，但是... 查看详情

springboot实践：logback日志配置

...、logback是什么？工作中一直用的是log4j日志框架，接触了SpringBoot后，因为logback是默认框架，才开始进行了解。来看下官网的相关介绍。可以看到，logback是log4j的进化版，是为了替代log4j的。logback分三个模块：logback-core：核... 查看详情

springboot整合+logback日志配置

本次演示的代码结构如下，基于maven，整合SpringBoot、Spring、Mybaits的SSM框架。同时测试logback日志框架的使用及配置。 1.创建maven工程，修改pom.xml文件<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema 查看详情

springboot之logback日志最佳实践

一、SpringBoot日志介绍　　SpringBoot对所有内部日志记录使用了CommonsLogging，但是底层日志实现是开放的。为JavaUtil日志记录、Log4J2和Logback提供了缺省配置。在每种情况下，日志记录器都预先配置为使用控制台输出和可选的文件输... 查看详情

springboot：日志配置-logback

一、简介支持日志框架：JavaUtilLogging,Log4J2andLogback，默认是使用logbacklogback配置方式springboot默认会加载classpath:logback-spring.xml或者classpath:logback-spring.groovy 使用自定义配置文件，配置方式为：logging.config=classpath:logback-ro 查看详情

springboot整合+logback日志配置(代码片段)

本次演示的代码结构如下，基于maven，整合SpringBoot、Spring、Mybaits的SSM框架。同时测试logback日志框架的使用及配置。1.创建maven工程，修改pom.xml文件<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi=&# 查看详情

springboot配置保存日志文件

参考技术Aspringboot日志配置：名称只要是一logback开头就行，测试使用log.xml并不会生成日志。合法名称：logback.xml、logback-spring.xml备注：要配置logback-spring.xml，springboot会默认加载此文件，为什么不配置logback.xml,因为logback.xml会先app... 查看详情

springboot日志logback配置

1<?xmlversion="1.0"encoding="UTF-8"?>2<!--3scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。4scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒；当sca... 查看详情

springboot2.x整合slf4j+logback日志框架(代码片段)

目录1、Slf4j及Logback简介2、日志级别3、maven依赖3.1springboot2maven配置文件3.2普通maven项目的配置文件4、logback、springboot配置说明4.1 logback.xml 和logback-spring.xml的区别4.2logback.xml配置文件的加载机制4.3SpringBoot结合logback配置说明4.3.1logb... 查看详情

springboot日志logback配置

...考技术A在前一个项目simple-boot-demo项目中配置日志相关。SpringBoot日志依赖为：spring-boot-starter-logging，不过对于web项目，已经引入了spring-boot-starter-web,默认已经自带了日志的spring-boot-starter-logging，已经默认引入了logback实现，只需... 查看详情

springboot日志配置

SpringBoot日志的配置如果不配置日志,默认配置是base.xml配置日志在resource目录下新建logback.xml<?xmlversion="1.0"encoding="UTF-8"?><configurationdebug="false"><propertyname 查看详情

springboot项目使用logback把日志输出到控制台或输出到文件

...初始化，可从控制台输出信息中查看加载的配置文件。在Springboot项目中可以自定义logback配置文件名及文件位置要想让Springboot项目识别到该logback配置文件，只需要在Springboot配置文件中定义好配置文件的加载路径即可如下所示：... 查看详情

13.7springboot集成日志系统logback的几个问题

...properties配置文件中value后面有空格。让人感到疑惑的是，SpringBoot居然没有对application.properties配置文件value末端作空格trim处理。配置内容：报错日志：涉及报错的源码在org.springframework.util.ResourceUtils通过源码，我们可以看出spring... 查看详情

springboot日志管理配置logback-spring.xml

几种常见的日志Log4j：是最早的日志框架，是apach旗下的，可以单独使用，也可配合日志框架JCL使用；Log4j2：apach旗下的关于log4j的升级版；Logback：是基于slf4j接口实现的一套日志框架组件；（Logback是由log4j创始人设计的又一个开... 查看详情

springboot整合logback集成elk实现日志的汇总分析统计和检索功能(代码片段)

　　在SpringBoot当中，默认使用logback进行log操作。logback支持将日志数据通过提供IP地址、端口号，以Socket的方式远程发送。在SpringBoot中，通常使用logback-spring.xml来进行logback配置。首先、创建一个elk的springboot项目，然后先对logback... 查看详情

springboot使用默认的logback配置logback-spring.xml每天一个日志文件(代码片段)

...ring.xml内容部署启动(2)application.yml放在resources下使用logbackspringboot配置每天一个日志文件logback-spring.xmlspringboot工程配置文件可以放在多个地方，可以直接放在resources目录下，也可以放在根目录下的con 查看详情