SpringBoot基础系列文章
SpringBoot基础(一):快速入门
SpringBoot基础(二):配置文件详解
SpringBoot基础(三):Logback日志
目录
- 一、日志依赖
- 二、日志格式
- 1、记录日志
- 2、默认输出格式
- 3、springboot默认日志配置
- 三、日志级别
- 1、基础设置
- 2、日志分组
- 四、文件输出
- 五、文件归档(按日期和大小)
- 1、文件滚动和归档的属性
- 1.1、 `<appender>`
- 1.2、 `<file>`
- 1.3、`<encoder>`
- 1.4、 `<rollingPolicy>`(日志滚动策略)
- 1.5、**`<filter>`**(日志过滤器)
- 2、logback-spring.xml完整配置文件
一、日志依赖
- 此依赖位于
spring-boot-starter-web
下的spring-boot-starter
内部
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
- 默认使用
SLF4J
作为日志门面
,logback
作为日志实现
来记录日志 - Logback是由
log4j创始人
设计的另一个开源日志组件,性能比log4j要好
适配器作用:以后想要换其他日志框架,只要排除掉logback日志实现,导入log4j2或jul的日志实现即可,代码中API还是slf4j不需要修改,只修改maven依赖就改变了日志的底层实现
。
二、日志格式
1、记录日志
@Slf4j
注解的原理就是在编译后的Class文件的类名下生成private static final Logger log = LoggerFactory.getLogger(XXX.class);
,所以这两使用哪个都一样。
@Slf4j
@RestController
public class HelloLog {
// private static final Logger log = LoggerFactory.getLogger(HelloLog.class);
@GetMapping("/log")
public String log(){
log.error("error信息");
log.warn("warn信息");
log.info("info信息");
log.debug("debug信息");
log.trace("trace信息");
return "log";
}
}
2、默认输出格式
时间和日期
:毫秒级精度日志级别
: ERROR、WARN、INFO、DEBUG 或 TRACE进程 ID
:通过此id可以将当前java进程杀掉(kill -9 ID)线程名称
:用[]括起来日志记录器Logger名字
:通常是产生日志的类名日志记录的信息
3、springboot默认日志配置
控制台默认输出格式
%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}
%d{yyyy-MM-dd HH:mm:ss.SSS}
:日志时间%5p
:日志级别,固定宽度5字符默认右对齐${PID:- }
:PID表示进程ID,:-
表示不存在输出空格%15.15t
:固定15长度的线程名称,不够左边补空格,超过截取字符串右边内容%logger{36}
:输出日志器名称(类名),36表示最多输出36个字符,如果不设置 {36} 则输出全名%msg
:日志消息内容%n
:换行符%wEx
:打印精简的异常堆栈信息
彩色编码输出
例如,要使文本为黄色,可使用以下设置:
%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}
支持颜色:blue(蓝)、cyan(青)、faint(淡)、green(绿)、magenta(洋红)、red(红)、yellow(黄)
三、日志级别
1、基础设置
- 由低到高:ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF
ALL
:打印所有日志TRACE
:追踪框架详细流程日志,一般不使用DEBUG
:开发调试细节日志INFO
:关键、感兴趣信息日志WARN
:警告但不是错误的信息日志,比如:版本过时ERROR
:业务错误日志,比如出现各种异常OFF
:关闭所有日志记录
- 不指定级别的所有类,都使用
root
指定的级别作为默认级别 - SpringBoot日志默认级别是
INFO
- 如下application.properties配置表示所有
未指定
日志级别都使用root
的warn级别
logging.level.root=warn
2、日志分组
- 支持定义
日志记录组
,将多个不同的包放到同一个组别中统一管理设置日志级别
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
- 定义完成后,只需一行即可更改组中所有日志记录器的级别
logging.level.tomcat=trace
- SpringBoot
预定义
两个组
Name | Loggers |
---|---|
web | org.springframework.core.codec, org.springframework.http,org.springframework.web org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans |
sql | org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener |
四、文件输出
SpringBoot默认只把日志写在控制台,如果想额外记录到文件,可以在application.properties中添加logging.file.name
或者logging.file.path
配置项。
logging.file.name | logging.file.path | 示例 | 效果 |
---|---|---|---|
未指定 | 未指定 | 仅控制台输出 | |
指定 | 未指定 | my.log | 写入指定文件,可以加路径 |
未指定 | 指定 | /var/log | 写入指定目录,文件名为spring.log |
指定 | 指定 | 以logging.file.name 为准 |
五、文件归档(按日期和大小)
1、文件滚动和归档的属性
- 这里是只过滤
日志级别为errer
的日志进行归档,下面详细介绍下属性
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${log.path}/error.log</file>
<!--日志文档输出格式-->
<encoder>
<Pattern>${FILE_PATTERN}</Pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文档只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
1.1、 <appender>
name="ERROR_FILE"
:定义了该appender
的名称为ERROR_FILE
,可以在<root>
或<logger>
中通过appender-ref
引用它,用来将ERROR
级别的日志输出到文件class="ch.qos.logback.core.rolling.RollingFileAppender"
:用于将日志写入文件,并根据时间
或文件大小
进行滚动和归档
1.2、 <file>
<file>${log.path}/error.log</file>
:指定日志文件的路径和文件名
1.3、<encoder>
-
<Pattern>${FILE_PATTERN}</Pattern>
:指定日志的输出格式 -
<charset>UTF-8</charset>
:设置日志文件的字符编码为UTF-8
1.4、 <rollingPolicy>
(日志滚动策略)
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
:定义日志文件的滚动策略,按时间和大小进行日志文件的分割和归档<fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
:- 日志文件名的模式为
error-YYYY-MM-DD.i.log
,表示日志文件按天生成,每天的日志文件以日期命名,且支持每天多个日志文件(如果大小超限),通过%i
表示文件的序号
- 日志文件名的模式为
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
:- 使用SizeAndTimeBasedFNATP(按时间和大小的文件命名和触发策略),确保日志文件在每天生成的基础上,当文件大小超过
100MB
时会切分日志文件 <maxFileSize>100MB</maxFileSize>
:定义单个日志文件的最大大小为100MB
。超过这个大小会创建一个新的日志文件(例如error-2024-10-03.1.log
,error-2024-10-03.2.log
)
- 使用SizeAndTimeBasedFNATP(按时间和大小的文件命名和触发策略),确保日志文件在每天生成的基础上,当文件大小超过
<maxHistory>15</maxHistory>
:设置日志保留的历史天数,最多保留15天的日志文件,超过这个天数的日志会被自动删除
1.5、<filter>
(日志过滤器)
<filter class="ch.qos.logback.classic.filter.LevelFilter">
:使用LevelFilter
来过滤日志,只允许指定级别的日志写入文件<level>ERROR</level>
:表示该appender
只接受ERROR
级别的日志<onMatch>ACCEPT</onMatch>
:当日志级别是ERROR
时,日志将被接受并写入文件<onMismatch>DENY</onMismatch>
:当日志级别不为ERROR
时(如info
、warn
等),日志将被拒绝,不写入文件
2、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">
<contextName>logback</contextName>
<!--
springProperty表示从Spring的配置属性中读取值,需要读取logging.file.path的属性然后赋值给myLogLocation
这里有个属性default,字面上如果配置文件不设置路径的默认路径,实际是项目路径下创建文件夹(总之不可用)
-->
<springProperty scope="context" name="myLogLocation" source="logging.file.path" default="/data/logs/"/>
<!-- 作用是将myLogLocation变量的值赋给log.path变量,定义后,可以使“${}”来使用变量 -->
<property name="log.path" value="${myLogLocation}"/>
<!--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" />
<!-- 彩色日志格式,springboot控制台的默认格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 文件日志格式 -->
<!--
时间戳格式为 yyyy-MM-dd HH:mm:ss.SSS,以毫秒精度输出时间
[thread]:输出线程名称,便于查看日志是在哪个线程中产生的
[traceId]:从 MDC(Mapped Diagnostic Context)中获取 traceId 值,通常用于分布式系统中进行日志追踪(如果没有设置 traceId,这里将为空)
[level]:日志级别,例如 INFO、DEBUG、ERROR 等
class:line:类名和行号,标识日志产生的具体位置
[M]:方法名称,表示在哪个方法中生成日志
%m:日志内容,表示输出的具体日志消息
%n:换行符,用于格式化日志的换行
-->
<property name="FILE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] [%level] %class:%line [%M] - %m%n"/>
<!--1. 输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--2. 输出到文档-->
<!-- 2.1 level为 DEBUG 日志,时间滚动输出 -->
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${log.path}/debug.log</file>
<!--日志文档输出格式-->
<encoder>
<Pattern>${FILE_PATTERN}</Pattern>
<charset>UTF-8</charset> <!-- 设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志归档 -->
<fileNamePattern>${log.path}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文档只记录debug级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<!-- 当日志的级别与 INFO 匹配时,日志将被接受并记录到文件中 -->
<onMatch>ACCEPT</onMatch>
<!-- 当日志的级别不匹配时(如 INFO、ERROR),这些日志将被拒绝,且不会记录到该日志文件 -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.2 level为 INFO 日志,时间滚动输出 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${log.path}/info.log</file>
<!--日志文档输出格式-->
<encoder>
<Pattern>${FILE_PATTERN}</Pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文档记录info及以上级别的 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>info</level>
</filter>
</appender>
<!-- 2.3 level为 WARN 日志,时间滚动输出 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${log.path}/warn.log</file>
<!--日志文档输出格式-->
<encoder>
<Pattern>${FILE_PATTERN}</Pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文档只记录warn级别的 -->
<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="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${log.path}/error.log</file>
<!--日志文档输出格式-->
<encoder>
<Pattern>${FILE_PATTERN}</Pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文档只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--
<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"/>
-->
<!--
使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:
设置1. mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl
设置2. logging.level.com.xxx.mapper=debug
-->
<!--
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
-->
<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" />
</root>
<!-- <logger name="com.xxx.mapper" level="debug"/> -->
</configuration>