1、 前言
在SpringBoot项目开发的过程中,一般都是使用Slf4j作为日志门面,使用logback作为日志实现。logback日志实现框架需要指定并配置一个配置文件:logback-spring.xml
2、一些记录
logback-spring.xml 配置文件内容,以及一些针对配置项的说明都在里面。
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds" debug="false">
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<contextName>logback</contextName>
<!-- name的值是变量的名称,value的值是变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
<!-- <property name="log.path" value="D:/file/logs/crypto"/> -->
<property name="log.path" value="logs"/>
<!-- 彩色日志 -->
<!-- 配置格式变量:CONSOLE_LOG_PATTERN 彩色日志格式 -->
<!-- magenta:洋红 -->
<!-- boldMagenta:粗红-->
<!-- cyan:青色 -->
<!-- white:白色 -->
<!-- magenta:洋红 -->
<!-- %date 时间 -->
<!-- %-5level 日志级别从左显示5个字符宽度 -->
<!-- %thread 线程名称-->
<!-- %file:%line 文件名:行号 -->
<!-- %logger 日志名字 一般采用日志所在类名或者包名做日志名 -->
<!-- %msg 日志正文信息 -->
<!-- %n 换行 -->
<property name="CONSOLE_LOG_PATTERN"
value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |${PID:-} |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>
<!--输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用,只配置最低级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
<!-- 例如:如果此处配置了INFO级别,则后面其他位置即使配置了DEBUG级别的日志,也不会被输出 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--输出到文件-->
<!-- 时间滚动输出 level为 DEBUG 的日志 -->
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志文件的路径和文件名称 -->
<file>${log.path}/log_debug.log</file>
<!--DEBUG级别日志文件的输出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} - [%thread] - %file:%line - %logger ---> %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大大小 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录debug级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 INFO 的日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志文件的路径和文件名称 -->
<file>${log.path}/log_info.log</file>
<!--INFO级别日志文件的输出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} - [%thread] - %file:%line - %logger ---> %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大大小 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录info级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 WARN 日志 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/log_warn.log</file>
<!--日志文件输出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} - [%thread] - %file:%line - %logger ---> %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大大小 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录warn级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 ERROR 日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/log_error.log</file>
<!--日志文件输出格式-->
<encoder>
<pattern>%msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大大小 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 把所有日志记录到同一个文件中
(1) 根据配置的日志级别进行记录日志,如root标签配置的日志级别是INFO, 则会把INFO, WARN, ERROR 这三个级别的日志都记录到同一个文件中;
(2) 这样做的目的是,上面的 DEBUG_FILE、INFO_FILE、WARN_FILE和ERROR_FILE分别是只记录DEBUG级别、INFO级别、WARN级别和ERROR级别的日志,
大白话就是:上述的日志文件中,只会出现本级别的日志信息,而不会出现其他级别的日志信息。
这就导致一个问题是:日志信息被割裂开了,不连续了。
所以如果想要一个完整的日志(即:所有需要的级别的日志都记录到同一个文件中)那就使用如下 ALL_FILE 这个配置项;如果不需要这么做,就想把每个级别
的日志单独记录到不同的文件中,就需要开启这个。
-->
<appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志文件的路径和文件名称 -->
<file>${log.path}/log_all.log</file>
<!--日志文件的输出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} - [%thread] - %file:%line - %logger ---> %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/all/log-all-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大大小 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<maxHistory>180</maxHistory>
</rollingPolicy>
</appender>
<!--
(一) 此处的 level="INFO" 控制着全局的异常记录级别。打个比喻如下:
1) 此处的root就好比一个大哥,控制着整个项目的日志级别,大哥在这里说了,我先在把你们都开启!(即:使用<appender-ref 标签开启了 控制台、debug级别的日志文件、info级别的日志文件、warn级别的日志文件、error级别的日志文件、全部级别的日志文件)
日志级别是 INFO! 在项目运行过程中,你们各司其职去记录日志吧。
.... 项目开始运行了,大家注意了!
2) 先来看 ref="CONSOLE" 的干活逻辑:老大开启的全局日志级别是INFO级别,我自己配置的是:我要在控制台输出DEBUG及以上级别的日志~ 现在老大开启了全局INFO级别的日志,那DEBUG级别的日志我肯定是见不到了,我只管在控制台输出INFO级别以上的日志就行啦~
3) 然后来看看 ref="DEBUG_FILE" 的干活逻辑: 我自己配置的是:我只复负责在log_debug.log 文件中记录 项目运行过程中的 debug 级别日志;但是现在老大开启的全局日志级别是INFO级别,所以肯定不会有debug级别的日志输出,也就不会有debug级别的日志走到我这里来,我没活可干~~~
4) 在然后来看看 ref="INFO_FILE" 的干活逻辑:我自己配置的是:我只复负责在log_info.log 文件中记录 项目运行过程中的 info 级别日志;但是现在老大开启的全局日志级别是INFO级别,如果项目在运行过程中出现了info级别的日志,我就要开始干活啦,我可不管其他级别的日志,比如 warn,error级别的日志我一概不关心! 对应配置如下:
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
5) ref="WARN_FILE" 和 ref="ERROR_FILE" 干活逻辑和 4) 是类似的。
6) 最后来看看 ref="ALL_FILE" 的干活逻辑:只要项目运行过程中出现了老大开启的全局日志级别INFO 及以上的日志信息,我都要在 log_all.log 文件中记录下来!
(二) 老大虽然开启了全局的日志记录级别为 INFO. 但是作为下面的小弟,也可以选择自己想要记录的哪个级别的日志信息。拿 控制台的输出举例。虽然 root="INFO", 但是如果 CONSOLE 配置如下:
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
那当程序运行过程中出现了 INFO 级别或 WARN 级别的日志,我也不会输出到控制台上!, 我只关心ERROR级别的日志,即:当有ERROR 级别的日志出现时,我才会把ERROR级别的日志信息输出到控制台上。
(3) 如果老大哪天看某个小弟不顺眼,就可以不开启他。比如今天老大看 CONSOLE 这个小弟不顺眼,就把其给注释掉了,那么就不会在控制台输出程序运行过程中的日志信息了。但是其他小弟还是按照 (一)中分析的干活逻辑,卖命的干活。
-->
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="DEBUG_FILE"/>
<appender-ref ref="INFO_FILE"/>
<appender-ref ref="WARN_FILE"/>
<appender-ref ref="ERROR_FILE"/>
<appender-ref ref="ALL_FILE"/>
</root>
</configuration>