基于logback 实现springboot的日志配置

令狐前生

已于 2023-05-06 15:55:28 修改

阅读量1.5k

点赞数 1

分类专栏： SpringBoot 文章标签： spring boot logback java

于 2023-05-06 11:49:45 首次发布

本文链接：https://blog.csdn.net/u010132847/article/details/130522841

版权

SpringBoot 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

2.4.2、<contextName>标签

一、前言

java web 下有好几种日志框架，比如：logback，log4j，log4j2（slf4j 并不是一种日志框架，它相当于定义了规范，实现了这个规范的日志框架就能够用 slj4f 调用）它们都实现了slf4j的接口。其中性能最高的应该使 logback 了，而且 springboot 默认使用的也是 logback 日志，所以本篇将会详细的讲解 logback 的日志配置方案。

二、使用详解

如果无需复杂的日志配置，执行简单设置日志打印级别，打印方式可直接再 application.yml 中配置。

默认情况下 Spring Boot 将 info 级别的日志输出到控制台中，不会写到日志文件，且不能进行复杂配置。

2.1、打印到文件中

想要将日志输出到文件中，可通过如下两个配置：

logging:
 # 配置输出额日志文件名,可以带路径
 # file: out.log
 # 配置日志存放路径,日志文件名为：spring.log
 path: ./log
 file:
  # 设置日志文件大小
  max-size: 10MB

注意:file 和 path 是不能同时配置的，如果同时配置path不会生效。

2.2、打印级别控制

可通过配置控制日志打印级别，格式如下：

logging.level.*=TRACE/DEBUG/INFO/...

*可以为包名或 Logger 名，如下：
logging:
 level:
  # root日志以WARN级别输出
  root: info
  # 此包下所有class以DEBUG级别输出
  com.example.log_demo.log1: warn

2.3、logback 详细配置

接下来说明如何通过独立的 xml 配置文件来配置日志打印。虽然 springboot 是要消灭 xml 的，但是有些复杂功能还是得编写 xml。使用 xml 后要将 application.yml 中的配置去掉，避免冲突.

根据不同的日志系统，按照指定的规则组织配置文件名，并放在 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。

2.4、logback 配置文件的组成

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

2.4.1、<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 也是子标签之一，将会在后面说明。

2.4.2、<contextName>标签

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

2.4.3、<property>标签

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

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

2.4.4、<appender>标签

appender 用来格式化日志输出的标签，这个最重要。有两个属性：

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

2.4.5、<logger>标签

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

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

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

1.不指定级别，不指定 appender:

<!-- 控制com.example.service下类的打印，使用root的level和appender -->
<logger name="com.example.service"/>

2.指定级别，不指定 appender

<!-- 控制com.example.service下类的打印，使用root的appender打印warn级别日志 -->
<logger name="com.example.service" level="WARN"/>

3.指定级别，指定 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 就能将指定的包下的日志打印到指定的文件中。

2.4.6、<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 。官网示例及规则如下：

%msg：日志输出内容。

%n：换行符。

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

默认输出日志时右对齐左填充的，可以使用左对齐标志修改它，通常指定一个十进制的数字来表示输出是的最小最大宽度。

如果输出数据的字符长度小于指定的最小宽度，则在左侧或者右侧使用空格进行填充。

如果输出数据的字符长度大于指定的最小宽度，此时设置的最小宽度值失效，将按照实际的长度进行输出。

也可以设置最大宽度，通过 .(点号)+十进制数字指定。

如果输出数据的字符长度大于指定的最大宽度，那么多余的字符将删除，默认截取数据项的前几个字符，可以通过在点号后加减号的方式，表示为从数据项的结尾截取。

以下为官网关于对齐方式和截取的示例：

您可能只想打印 T，D，W，I 和 E，而不是为该级别打印 TRACE，DEBUG，WARN，INFO 或 ERROR。此时可以使用格式修饰符实现，如：%.-1level。

2.5、多环境日志输出

通过设置文件名为-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"等。

2.6、设置只输出单个级别

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

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

2.7、通过例子来说明

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

<?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>

三、扩展

日志打印可以很复杂，这里只是说明了常用的 logback 配置，代码详见：github

参考文章链接：

1、logback教程logback快速入门超实用详细教程收藏这一篇就够了(万字长文)_「已注销」的博客-CSDN博客

2、基于logback 实现springboot超级详细的日志配置_java_脚本之家

3、logback多环境配置_阳宗德的博客-CSDN博客

令狐前生

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
基于logback 实现springboot的日志配置

java web 下有好几种日志框架，比如：logback，log4j，log4j2（slf4j 并不是一种日志框架，它相当于定义了规范，实现了这个规范的日志框架就能够用 slj4f 调用）它们都实现了slf4j的接口。其中性能最高的应该使 logback 了，而且 springboot 默认使用的也是 logback 日志，所以本篇将会详细的讲解 logback 的日志配置方案。
复制链接

扫一扫

专栏目录