我们在项目中，经常使用到日志配置。每次配置都需要去各种找资料。正好最近又在给项目配置日志。这里就整理一下这块资料。各位小伙伴们也直接收藏即可。超详细，看这一篇就够了
一、添加依赖
这里使用的是springboot3.0.2，其他版本一样
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.32</version>
</dependency>
application.yml文件
spring:
application:
name: chapter002
profiles:
active: dev
二、logback详细配置
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，将xml放至 src/main/resource下面。
# 也可以使用自定义的名称，比如logback-config.xml，只需要在application.yml文件中指定即可：
logging:
config: classpath:logback-config.xml
这里先奉上logback-spring.xml详细配置，后面会详细介绍每项的含义及表现形式
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->
<!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。
当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="10 seconds">
<!-- 日志名称，默认从取 spring.application.name -->
<springProperty name="contextName" source="spring.application.name"/>
<!-- 运行环境 -->
<springProperty name="envName" source="spring.profiles.active"/>
<!-- property：指定变量，name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量 -->
<!-- 日志存放目录，使用项目名，这样在多服务中，可以根据服务名分目录存储日志 -->
<property name="log.path" value="/data/server/${contextName}/logs"/>
<!--0. 日志格式和颜色渲染 -->
<!-- 彩色日志依赖的渲染类 -->
<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"/>
<!--
控制台彩色日志格式
日志解读：
%clr([${contextName},${envName:-dev}]){yellow}：输出项目名称和项目使用环境（黄色）
%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint}：输出日期，格式：yyyy-MM-dd HH:mm:ss.SSS
%clr(%5p)：输出日志格式。并对齐5位。如果是INFO、WARN这种四个字符的，默认在最左边加入一个空格（info为蓝色，warn为浅红，error为加粗红，debug为黑色）
%clr(${PID:- }){magenta}：输出PID（品红色）。ps：${PID:- } 这个 ${} 使用方式表示，有PID则显示PID，没有则显示-
[%15.15t]：输出线程名称。如果记录的线程字符长度小于15(第一个)则用空格在左侧补齐,如果字符长度大于15(第二个),则从开头开始截断多余的字符
%clr(%-50.50(%logger{50})){cyan}：
%-50.50()：如果记录的logger字符长度小于50(第一个)则用空格在右侧补齐,如果字符长度大于50(第二个),则从开头开始截断多余的字符
%logger{50}：输出日志名字 一般采用日志所在类名或者包名做日志名
{cyan}：输出颜色（青色）
%msg%n"：日志输出内容+换行（%n）
-->
<property name="console.log.pattern"
value="%clr([${contextName},${envName:-dev}]){yellow} %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }){magenta} %clr(---){faint} [%15.15t] %clr(%-50.50(%logger{50})){cyan} : %msg%n"/>
<!-- 文件日志格式。ps:日志文件中没有设置颜色,否则颜色部分会有ESC[0:39em等乱码- -->
<property name="log.pattern"
value="[${contextName},${envName:-dev}] %d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%15.15t] %-50.50(%logger{50}) : %msg%n"/>
<!--1. 输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<Pattern>${console.log.pattern}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--2. 输出到文档-->
<!-- 2.0 输入全部level日志 ，视项目需求而定，可删除-->
<appender name="allLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 当前日志输出路径、文件名 -->
<file>${log.path}/all.log</file>
<!--日志输出格式-->
<encoder>
<pattern>${log.pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
<!--历史日志归档策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 历史日志： 归档文件名，分了目录的话，要加 aux 不然日志文件不能按时生成，%i表示序号，在这里不能少，因为如果当一个文件到了指定大小后，那就要按照%i来生成顺序下的另一个文件 -->
<!--保存日志策略 根据 %d{yyyy-MM-dd} 进行保存 %d{yyyy-MM-dd}:按天进行保存 %d{yyyy-MM-dd HH}:按小时进行保存-->
<fileNamePattern>${log.path}/%d{yyyy-MM, aux}/all/all.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!--单个文件的最大大小-->
<maxFileSize>100MB</maxFileSize>
<!-- <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> -->
<!-- <maxFileSize>100MB</maxFileSize> -->
<!-- </timeBasedFileNamingAndTriggeringPolicy> -->
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
<!--用来指定日志文件的上限大小，到了这个值，就会删除旧的日志-->
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
</appender>
<!-- 2.1 level为 DEBUG 日志，时间滚动输出 -->
<appender name="debugLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 当前日志输出路径、文件名 -->
<file>${log.path}/debug.log</file>
<!--日志输出格式-->
<encoder>
<pattern>${log.pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
<!--历史日志归档策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 历史日志： 归档文件名，分了目录的话，要加 aux 不然日志文件不能按时生成，%i表示序号，在这里不能少，因为如果当一个文件到了指定大小后，那就要按照%i来生成顺序下的另一个文件 -->
<fileNamePattern>${log.path}/%d{yyyy-MM, aux}/debug/debug.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!--单个文件的最大大小-->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
<!--用来指定日志文件的上限大小，到了这个值，就会删除旧的日志-->
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
<!-- 此日志文档只记录debug级别的 level过滤器-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.2 level为 INFO 日志，时间滚动输出 -->
<appender name="infoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 当前日志输出路径、文件名 -->
<file>${log.path}/info.log</file>
<!--日志输出格式-->
<encoder>
<pattern>${log.pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
<!--历史日志归档策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 历史日志： 归档文件名，分了目录的话，要加 aux 不然日志文件不能按时生成，%i表示序号，在这里不能少，因为如果当一个文件到了指定大小后，那就要按照%i来生成顺序下的另一个文件 -->
<fileNamePattern>${log.path}/%d{yyyy-MM, aux}/info/info.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!--单个文件的最大大小-->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
<!--用来指定日志文件的上限大小，到了这个值，就会删除旧的日志-->
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
<!-- 此日志文档只记录info级别的 level过滤器-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.3 level为 WARN 日志，时间滚动输出 -->
<appender name="warnLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 当前日志输出路径、文件名 -->
<file>${log.path}/warn.log</file>
<!--日志输出格式-->
<encoder>
<pattern>${log.pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
<!--历史日志归档策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 历史日志： 归档文件名，分了目录的话，要加 aux 不然日志文件不能按时生成，%i表示序号，在这里不能少，因为如果当一个文件到了指定大小后，那就要按照%i来生成顺序下的另一个文件 -->
<fileNamePattern>${log.path}/%d{yyyy-MM, aux}/warn/warn.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!--单个文件的最大大小-->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
<!--用来指定日志文件的上限大小，到了这个值，就会删除旧的日志-->
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
<!-- 此日志文档只记录warn级别的 level过滤器-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.4 level为 ERROR 日志，时间滚动输出 -->
<appender name="errorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 当前日志输出路径、文件名 -->
<file>${log.path}/error.log</file>
<!--日志输出格式-->
<encoder>
<pattern>${log.pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
<!--历史日志归档策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 历史日志： 归档文件名，分了目录的话，要加 aux 不然日志文件不能按时生成，%i表示序号，在这里不能少，因为如果当一个文件到了指定大小后，那就要按照%i来生成顺序下的另一个文件 -->
<fileNamePattern>${log.path}/%d{yyyy-MM, aux}/error/error.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!--单个文件的最大大小-->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
<!--用来指定日志文件的上限大小，到了这个值，就会删除旧的日志-->
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
<!-- 此日志文档只记录error级别的 level过滤器-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>error</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 文件 异步日志(async) -->
<appender name="asyncAppLog" class="ch.qos.logback.classic.AsyncAppender"
immediateFlush="false" neverBlock="true">
<!-- 0：不丢失日志.20：如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
<discardingThreshold>0</discardingThreshold>
<!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
<queueSize>1024</queueSize>
<!-- 队列满了不阻塞调用者-->
<neverBlock>true</neverBlock>
<!-- 添加附加的appender,最多只能添加一个 -->
<appender-ref ref="allLog"/>
</appender>
<!--
由于队列中还会有没有打印的日志内容，因此需要等待一段时间，等待队列处理完毕。
单位是ms。如果队列较大，队列内容较多，可以将此值设置的较大。如果超过此时间队列中的日志还没有处理完毕，则队列中的日志将抛弃
-->
<shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook">
<delay>2000</delay>
</shutdownHook>
<!--
<logger>用来设置某一个包或者具体的某一个类的日志打印级别、 以及指定<appender>。
<logger>仅有一个name属性， 一个可选的level和一个可选的addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。
如果未设置此属性，那么当前logger将会继承上级的级别。
addtivity:是否向上级logger传递打印信息。默认是true。
<logger name="org.springframework.web" level="info"/>
<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
-->
<!--
root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
不能设置为INHERITED或者同义词NULL。默认是DEBUG
可以包含零个或多个元素，标识这个appender将会添加到这个logger。
-->
<!-- 4. 最终的策略 可根据环境分别制定不同的日志策略。注意，这里的 allLog 没在root中声明，在上面的 asyncAppLog 声明（异步处理）-->
<!-- 4.1 开发环境:打印控制台，可把其他打印到文件的<appender-ref>注释 -->
<springProfile name="dev">
<root level="info">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="debugLog"/>
<appender-ref ref="infoLog"/>
<appender-ref ref="warnLog"/>
<appender-ref ref="errorLog"/>
<appender-ref ref="asyncAppLog"/>
</root>
</springProfile>
<!-- 4.2 生产环境:输出到文档
<springProfile name="pro">
<root level="info">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="debugLog"/>
<appender-ref ref="infoLog"/>
<appender-ref ref="warnLog"/>
<appender-ref ref="errorLog"/>
<appender-ref ref="asyncAppLog"/>
</root>
</springProfile> -->
</configuration>
使用一个简单的请求，打印各个层级的日志：
public void logbackDemo(){
log.debug("debug日志示例");
log.info("info日志示例");
log.warn("warn日志示例");
log.error("error日志示例");
}
控制台输出形式： 文件存储目录：
三、具体分析
ps：在引用一个变量时，有两种方式。第一种：无默认值：${变量名} ，第二种：有默认值：${变量名:-默认值} 1、[${contextName},${envName:-dev}]：输出项目名称+运行环境
- contextName 属性值是对应 的 source属性。该属性获取的是applicaton.yml 中 spring.application.name 的值（项目名称）
- envName 属性值对应的是 的 source属性。获取的是 application.yml 中 spring.profiles.active 的值（运行环境）
对应输出内容（选中部分）： 2、%d{yyyy-MM-dd HH:mm:ss.SSS}：时间。写法：%d{时间格式}，%d=%date
3、 %5p：日志级别。5表示对齐五位输出，没有五位的默认在最左边加入一个空格，%p = %le = %level
4、${PID:- }：输出PID，有则显示PID，没有则输出横杆 -
5、---：输出三条横杠 ---，用于更好查看日志
6、[%15.15t]：输出线程名称。如果记录的线程字符长度小于15(第一个)则用空格在左侧补齐,如果字符长度大于15(第二个),则从开头开始截断多余的字符。%t = %thread
7、%-50.50(%logger{50})：日志名称，%logger = %lo = %c
- %-50.50()：如果记录的logger字符长度小于50(第一个)则用空格在右侧补齐,如果字符长度大于50(第二个),则从开头开始截断多余的字符
- %logger{50}：输出日志名字 一般采用日志所在类名或者包名做日志名，默认不给长度，显示所有，日志名字 最右边的名字永远不会被缩写，不管你给的长度是不是小于最右边的长度。
8、%msg%n"：日志输出内容+换行。%m = %msg = %message
四、扩展
1、这里补充一下 %i 的含义：表示序号的意思
尤其在生成日志文件的时候，这个是非常有必要的，因为日志文件必须要设置最大文件大小，如果在生成日志文件的规则内，一个日志文件生成到了最大值，那就需要生成2号文件。 这里把上面的 logback-spring.xml 中 allLog 的滚动策略修改一下： :::tips 10KB ::: 看到，如果all.log文件大小超出10kb后，将分文件存储。这个文件后缀的数字就是 %i 生成的序号
2、对于 allLog 日志配置的说明：
有小伙伴会有疑问，我们不是分别配置了各个日志级别的配置，为什么还需要一个记录全部日志的文件。 这里是因为我为了方便查看项目中的所有日志所做的配置。各位小伙伴可根据实际情况考虑加不加。由于allLog这个文件里的日志是重复日志。所以我这里引入了asyncAppLog 做一个小优化。这个的作用是将日志存入内存队列中，做一个缓存，减少写日志的 RT（响应时间）。 asyncAppLog说明： AsyncAppender 原理简析：AsyncAppender 接收日志，放入其内部的一个阻塞队列，专开一个线程从阻塞队列中取数据（每次一个）丢给链路下游的 appender。当 日志 进入 AsyncAppender 后，AsyncAppender 会调用 appender 方法，append 方法中在将 event 填入 BlockingQueue 中前，会先判断当前 buffer 的容量以及丢弃日志特性是否开启，当消费能力不如生产能力时，AsyncAppender 会超出 Buffer 容量的 Logging Event 的级别，进行丢弃，作为消费速度一旦跟不上生产速度，中转 buffer 的溢出处理的一种方案。AsyncAppender 有个线程类 Worker，它是一个简单的线程类，是 AsyncAppender 的后台线程，所要做的工作是：从 buffer 中取出 event 交给对应的 appender 进行后面的日志推送。 AsyncAppender 并不处理日志，只是将日志缓冲到一个 BlockingQueue 里面去，并在内部创建一个工作线程从队列头部获取日志，之后将获取的日志循环记录到附加的其他 appender 上去，从而达到不阻塞主线程的效果。因此 AsynAppender 仅仅充当事件转发器，必须引用另一个 appender 来做事。 使用时需注意：
- queueSize：BlockingQueue 的最大容量，默认情况下，大小为 256，这个值需调整
- discardingThreshold：默认情况下，当 BlockingQueue 还有 20%容量，他将丢弃 TRACE、DEBUG 和 INFO 级别的 event，只保留 WARN 和 ERROR 级别的 event。为了保持所有的 events，可设置该值为 0。
- includeCallerData：提取调用者数据的代价是相当昂贵的。为了提升性能，默认情况下，当 event 被加入到 queue 时，event 关联的调用者数据不会被提取。默认情况下，只有"cheap"的数据，如线程名。
以上就是 logback-spring.xml 的全部配置信息了，各位小伙伴有什么问题欢迎在评论区留言讨论