springboot中logback配置conversionRule、ConsoleAppender|RollingFileAppender、PatternLayoutEncoder、Layout等

1 概述

在Java生态中,日志框架有很多,常见的有:jul(JDK提供)、log4j、logback等,随着各种日志框架的出现,在实际项目中使用方式、暴露的日志api、依赖等问题都需要程序员考虑和选择。面对中场景SLF4J出现了即简单日志门面,自身不记录日志,只作为各个日志框架的门面存在。SLF4J常用的日志实现:log4j、logback,一般有slf4j+log4j(log4j2)、slf4j+logback两种日志组合。

在springboot中,默认使用logback作为日志实现,并对logback进行了默认的配置,我们在项目开发和系统运行中难免会遇到,对logback进行定制和高并发场景日志性能优化。本文主要在springboot环境下对logback的使用、配置、优化进行讲解。

1.1 logback介绍

logback 由log4j创始人Ceki Gülcü设计的,相比于其他日志框架,性能更好、占用空间更小。主要包含三个模块:

logback-core:logback的核心基础模块,为其他模块提供支撑

logback-classic:实现了slf4j API,看作log4j的增强,提供了常用的encoder、filter、pattern、AsyncAppender等

Logback-access:可以与 Servlet 容器(如 Jetty 或 Tomcat)集成,以提供丰富而强大的 HTTP 访问日志功能。

甩出官网:Documentation (qos.ch)

1.2 演示测试项目

springboot版本:

<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.7</version>

logback版本:1.2.11

jdk版本:17.0.2

2 抛砖引玉

开始之前先给出,个人开发项目过程中使用的配置方式和细节,暂时没做dev、test、pre、pro环境区分。

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
 scan:         logback配置文件一旦发生变化,logback支持重新加载文件
 scanPeriod:   60s加载一次
 debug:        应用启动时在控制台上打印出 context上下文的加载情况
 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- spring上下文的属性配置 -->
    <springProperty scope="context" name="APP_NAME" source="spring.application.name"/>
    <springProperty scope="context" name="APP_PORT" source="server.port"/>

    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr"
                    converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <!-- 异常日志渲染类 -->
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>

    <!-- 彩色日志格式
        时间:            %d{yyyy-MM-dd HH:mm:ss.SSS}
        应用名称:         ${APP_NAME:-APP}
        日志级别:         %5p
        进程ID:          ${PID:- }
        线程名称:         %15.15t
        触发日志类方法:    %-40.40logger{39}
        代码行号:         %-4line
        日志内容:         %m
        换行符:           %n
        异常:            %wEx
    -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} [${APP_NAME:-APP} %clr(${APP_PORT:-}){blue}] %clr(${PID:- }){magenta} %clr(%5p) %clr([%15.15t]){faint} %clr(%-40.40logger{39} %-4line){cyan} %clr(:){faint} %m%n%wEx"/>

    <!-- 文件日志格式 -->
    <property name="FILE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} [${APP_NAME:-APP}] %5p ${PID:- } [%15.15t] %-40.40logger{39} %-4line : %m%n%wEx"/>


    <!-- 定义日志文件存储位置和文件名 -->
    <property name="LOG_FILE" value="logs/log"/>

    <!-- 定义日志文件归档格式:
         log.2023-06-07.0.gz
         log.2023-06-07.1.gz
         log.2023-06-07.2.gz
     -->
    <property name="ROLLINGPOLICY_FILE_NAME_PATTERN" value="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"/>

    <!-- 单个日志文件大小 -->
    <property name="ROLLINGPOLICY_MAX_FILE_SIZE" value="20MB"/>

    <!-- 归档文件占用磁盘总大小,超过后会根据cleanHistoryOnStart实行,决定是否删除 -->
    <property name="ROLLINGPOLICY_TOTAL_SIZE_CAP" value="1GB"/>

    <!-- 超过最大磁盘限制后是否删除归档文件 -->
    <property name="ROLLINGPOLICY_CLEAN_HISTORY_ON_START" value="true"/>

    <!-- 保留的历史归档日志文件个数 -->
    <property name="ROLLINGPOLICY_MAX_HISTORY" value="10"/>
    

    <!-- 控制台输出 -->
    <appender name="CONSOLE_OUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 文件输出: RollingFileAppender 滚动日志输出-->
    <appender name="FILE_OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <file>${LOG_FILE}</file>
        <!-- 滚动日志策略: SizeAndTimeBasedRollingPolicy 根据文件大小和时间进行分割归档-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${ROLLINGPOLICY_FILE_NAME_PATTERN}</fileNamePattern>
            <cleanHistoryOnStart>${ROLLINGPOLICY_CLEAN_HISTORY_ON_START}</cleanHistoryOnStart>
            <maxFileSize>${ROLLINGPOLICY_MAX_FILE_SIZE}</maxFileSize>
            <totalSizeCap>${ROLLINGPOLICY_TOTAL_SIZE_CAP}</totalSizeCap>
            <maxHistory>${ROLLINGPOLICY_MAX_HISTORY}</maxHistory>
        </rollingPolicy>
    </appender>


    <!-- AsyncAppender 在于高并发下,加如日志队列缓存,减少写磁盘日志的IO次数。可以根据实际情况决定是否使用 -->

    <appender name="ASYNC_CONSOLE_APPENDER" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 如果设置20,表示队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志,设置0则不会丢弃 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>1024</queueSize>
        <!-- 队列满了不阻塞调用者-->
        <neverBlock>false</neverBlock>
        <!-- 是否记录调用者额外的信息(比如记录后,可以打印行号)会造成性能损耗,默认false只记录线程名字和mdc信息 -->
        <includeCallerData>true</includeCallerData>
        <!-- 实际输出日志appender,最多只能添加一个 -->
        <appender-ref ref ="CONSOLE_OUT"/>
    </appender>

    <appender name="ASYNC_FILE_APPENDER" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 如果设置20,表示队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志,设置0则不会丢弃 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>1024</queueSize>
        <!-- 队列满了不阻塞调用者-->
        <neverBlock>false</neverBlock>
        <!-- 实际输出日志appender,最多只能添加一个 -->
        <appender-ref ref ="FILE_OUT"/>
    </appender>

    <!-- 默认的日志输出级别 -->
    <root level="INFO">
        <!--选择合适的日志记录器,可以是多个,会同时写入。一般是一个console,一个file,可以选择异步和同步-->
        <appender-ref ref="ASYNC_CONSOLE_APPENDER"/>
        <appender-ref ref="ASYNC_FILE_APPENDER"/>
    </root>
</configuration>

在这里插入图片描述

3 功能介绍

3.1 配置文件加载

springboot默认加载classpath下 logback-spring.xml,可以通过properties配置指定路径:

logging.config=classpath:log/logback-spring.xml

如果想区分环境可以通过不同的环境的application-xx.properties指定不同的日志文件路径。

3.2 logback配置

3.2.1 configuration

根节点:configuration,作为顶级标签, 可以用来配置一些lockback的全局属性,常见的属性如下:

  • scan=“true” :scan是否开启自动扫描,监控配置文件更新,生效。
  • scanPeriod=“60 seconds” :扫描的频率
  • debug=“false”:是否开启logback的debug模式,注意这里和日志的debug无关,开启后启动之前会打印一些logback自身的信息。

3.2.2 property

property 标签可以定义一些属性变量,供其他配置地方通过${xxx}使用。

springProperty 标签可以获取spring上下文里的属性。

3.2.3 conversionRule

定义转换器,可以用来对日志进行特殊的转换,比如,SpringBoot后启动项目控制台会带有彩色日志样式,是因为使用了org.springframework.boot.logging.logback.ColorConverter颜色转换器,会把日志用AnsiOutput进行输出。

3.2.4 appender

Appender是logback中的最核心组件之一,承担日志时间的写入任务,包括:控制台、日志文件、网络输出等。借用一张官方的继承体系图:

在这里插入图片描述

途中可以看出常用的appender有三个:

  • ConsoleAppender:日志写入到控制台,底层会调用jdk的 System.outSystem.err
<appender name="CONSOLE_OUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>
  • FileAppender:日志写入到指定文件,有几个常用属性。
    • file:指定写入的日志文件名,可以是相对或者绝对目录
    • append:追加模式默认开启,不会清空原文件
    • prudent:当设置为true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
    • immediateFlush:默认情况下true,每个日志事件都会立即刷新到文件输出流中。这种方法更安全,因为如果应用程序退出时没有正确关闭appender,则不会丢失日志记录事件。但是,想显著提高日志的吞吐量,可以将 limateFlush 属性设置为 false。
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>testFile.log</file>
    <append>true</append>
    <immediateFlush>true</immediateFlush>
    <encoder>
        <pattern>${FILE_LOG_PATTERN}</pattern>
    </encoder>
</appender>
  • RollingFileAppender:实际生产环境写文件日志的首选appender,可以实现滚动式写日志,在写日志的过程中如果符合某些条件策略时,会重新写入到新的文件,还可以将历史日志进行归档、定期删除等。解决了FileAppender方式会导致日志都在一个文件中,文件会越来越大,难以打开。常用属性配置:
    • file:文件存储位置
    • rollingPolicy:滚动策略配置
<appender name="FILE_OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <pattern>${FILE_LOG_PATTERN}</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <file>${LOG_FILE}</file>
    <!-- 滚动日志策略: SizeAndTimeBasedRollingPolicy 根据文件大小和时间进行分割归档-->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!-- 指定滚动文件名称的生成规则 -->
        <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
        <!-- 超过最大磁盘限制后是否删除归档文件 -->
        <cleanHistoryOnStart>true</cleanHistoryOnStart>
        <!-- 单个日志文件大小 -->
        <maxFileSize>20MB</maxFileSize>
        <!-- 归档文件占用磁盘总大小,超过后会根据cleanHistoryOnStart实行,决定是否删除 -->
        <totalSizeCap>1GB</totalSizeCap>
        <!-- 保留的历史归档日志文件个数 -->
        <maxHistory>10</maxHistory>
    </rollingPolicy>
</appender>
  • AsyncAppender:异步写日志,本身不做真是的日志写入,需要配置包裹其它appender,在于高并发下,加如日志队列缓存,减少写磁盘日志的IO次数。可以根据实际情况决定是否使用 。
<appender name="ASYNC_FILE_APPENDER" class="ch.qos.logback.classic.AsyncAppender">
    <!-- 如果设置20,表示队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志,设置0则不会丢弃 -->
    <discardingThreshold>0</discardingThreshold>
    <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
    <queueSize>1024</queueSize>
    <!-- 队列满了不阻塞调用者-->
    <neverBlock>false</neverBlock>
    <!-- 实际输出日志appender,最多只能添加一个 -->
    <appender-ref ref ="FILE_OUT"/>
</appender>
  • 不常用的appender:SocketAppender 写入socket、SMTPAppender 写入邮件、DBAppender 写入数据库

3.2.5 encoder

Encoder在0.9.19中引入,作用负责将日志事件转换为字节数组,并将字节数组输出到输出流中(具体的appender输出流)。在此之前的版本主要使用Layout,Layout只能将日志事件转换为String。Layout还无法控制何时写出日志,因此Layout无法对日志事件进行批量控制,相比之下,Encoder不仅可以完全控制写出的字节的格式,而且还可以控制何时(以及是否)写出这些字节内容。

  • PatternLayoutEncoder:最常用的编码器,通常指定:编码和日志打印规则

在这里插入图片描述

<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } [%15.15t] %-40.40logger{39} %-4line : %m%n%wEx</pattern>
    <charset>UTF-8</charset>
</encoder>

3.2.6 Layout

layout根据pattern规则,将日志事件转换为具体的日志字符串,我们配置的各种日志打印格式,都是由layout解析翻译成字符串。由于官方规则太多,我们以一个具体的例介绍一些常用的规则符号:

在这里插入图片描述

时间:            %d{yyyy-MM-dd HH:mm:ss.SSS}
应用名称:         ${APP_NAME:-APP}
日志级别:         %5p
进程ID:          ${PID:- }
线程名称:         %15.15t
触发日志类方法:    %-40.40logger{39}
代码行号:         %-4line
日志内容:         %m
换行符:           %n
异常:            %wEx

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} [${APP_NAME:-APP} %clr(${APP_PORT:-}){blue}] %clr(${PID:- }){magenta} %clr(%5p) %clr([%15.15t]){faint} %clr(%-40.40logger{39} %-4line){cyan} %clr(:){faint} %m%n%wEx

详细规则:Chapter 6: Layouts (qos.ch)

3.2.7 Filters

filter 日志过滤器,本人实际用的不是太多,logback 的内置 filter 有一下几种:

  • 级别过滤器 ch.qos.logback.classic.filter.LevelFilter。对指定级别的日志进行具体的操作

  • 阀值过滤器 ch.qos.logback.classic.filter.ThresholdFilter。

  • 表达式过滤器 ch.qos.logback.core.filter.EvaluatorFilter。

    • Groovy的表达式 ch.qos.logback.classic.boolex.GEventEvaluator。

    • Java的表达式ch.qos.logback.classic.boolex.JaninoEventEvaluator。使用 Janino 解析java script。

  • 包含标记 ch.qos.logback.classic.boolex.OnMarkerEvaluator

<filter class="ch.qos.logback.classic.filter.LevelFilter">
    <!-- 过滤的级别 -->
    <level>INFO</level>
    <!-- 匹配时的操作:接收(记录) -->
    <onMatch>ACCEPT</onMatch>
    <!-- 不匹配时的操作:拒绝(不记录) -->
    <onMismatch>DENY</onMismatch>
</filter>

4 结束

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
你好!对于Spring Boot 3.0的日志配置,你可以使用Logback作为日志框架。下面是一个简单的示例配置: 1. 首先,在你的项目的`pom.xml`文件,添加Logback的依赖: ```xml <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> ``` 2. 在`src/main/resources`目录下创建一个名为`logback.xml`的文件,并添加以下内容: ```xml <configuration> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <root level="info"> <appender-ref ref="CONSOLE"/> </root> </configuration> ``` 上述配置,我们创建了一个名为`CONSOLE`的控制台输出的appender,并定义了日志的格式。`%d{yyyy-MM-dd HH:mm:ss.SSS}`表示日期时间,`[%thread]`表示线程名,`%-5level`表示日志级别,`%logger{36}`表示日志记录器名称(最多显示36个字符),`%msg%n`表示日志消息和换行符。 3. 在Spring Boot配置文件(比如application.properties或application.yml),添加以下配置来禁用Spring Boot默认的日志框架(Logback会自动替代它): 对于`application.properties`: ``` logging.level.root=info ``` 对于`application.yml`: ```yaml logging: level: root: info ``` 这样,你的Spring Boot 3.0应用程序就会使用Logback作为日志框架,并按照上述配置输出日志到控制台。 希望这能帮到你!如果还有其他问题,请随时提问。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值