文章目录
一、Logback日志介绍
我首先了解一下SLF4J
(Simple Logging Facade For Java),它是一个针对于各类Java日志框架的统一Facade抽象。简而言之就是定义了统一的日志抽象接口。
Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。
SpringBoot 的默认日志框架使用的是 Logback,启动的时候就可以看到日志。
logback 分为 3 个模块:
- logback-core:核心模块,提供了关键的通用机制;
- logback-classic:可以看作是 log4j 的改进版,实现了简单的日志门面 SLF4J;
- logback-access:主要用来和 Servlet 容器交互,比如说 Tomcat,提供了一些 HTTP 访问的功能
二、SpringBoot集成Logback
1.pom文件中添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
2.Logback日志配置
两种配置方式:
- Springboot在application.yml中进行配置logging.*设置相关配置
- 自定义配置文件,文件名默认为:logback-spring.xml或者logback.xml,放置在src/main/resources目录下面。如果需要自定义配置文件名,则需要在application.yml中申明:
logging:
config: classpath:loback-config.xml ##自定义的配置文件名
3.Logback使用
这里采用lombok的@Slf4j注解
- 首先类上面添加@Slf4j注解
- 其次采用:log.info、log.error…等方法
@Slf4j
@RestController
@RequestMapping("/index")
public class LogbackTestController {
@GetMapping(value = "/logback")
public String hello(){
// TRACE < DEBUG < INFO < WARN < ERROR < FATAL
log.debug("DEBUG 日志输出");
log.info("INFO 日志输出");
log.warn("WARN 日志输出");
log.error("ERROR 日志输出");
return "Hello Logback Test";
}
}
三、Logback配置文件详解
1.根节点<configuration>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
...
</configuration>
scan
:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。scanPeriod
:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。debug
:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
2.子节点<contextName>
设置上下文名称,每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
<contextName>logback</contextName>
3. 子节点<property>
<property name="log.path" value="/usr/local/src/supervisionLog"/>
设置变量 用来定义变量值的标签,有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量
4. 子节点<springProperty>
需要使用springProperty,才可使用application.properties(或application.yml)中的值
<!--这里最好设置default属性,否则spring.application.name没有设置的情况下,会报文件没有定义的异常-->
<springProperty name="app.name" source="spring.application.name" default="111"/>
5. 子节点<appender>
<appender>
标签用来配置格式化日志输出,其包含两个属性
- name:指定 appender 的名称
- class:指定日志的输出策略
ch.qos.logback.core.ConsoleAppender:指定日志输出到控制台
ch.qos.logback.core.rolling.RollingFileAppender:指定日志输出到滚动文件
控制台输出ConsoleAppender:
<!--输出到控制台-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<encoder>
表示对日志进行编码,<pattern>
指定日志的格式,<charset>
用来指定编码,以下是格式说明:
%d{HH: mm:ss.SSS}
—表示日期,日期格式:yyyy-MM-dd HH:mm:ss%thread
—表示线程名%-5level
—表示日志级别,-5表示从左显示5个字符宽度%logger{36}
—表示 logger 的名称,36个字符宽度%msg
—表示日志内容%n
—表示换行
<filter>
标签对日志进行过滤。<filter>
标签只有 1 个属性class,用来指定过略器。常用的过滤器有 2 种:
- ThresholdFilter:临界值过滤器,过滤掉低于指定临界值的日志。
当日志级别等于或高于临界值时,过滤器返回NEUTRAL;
当日志级别低于临界值时,日志会被拒绝。
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<!-- 输出 INFO 级别及以上的日志 -->
<level>INFO</level>
</filter>
- LevelFilter:级别过滤器,根据日志级别进行过滤。
如果日志级别等于配置级别,过滤器会根据 onMath (用于配置符合过滤条件的操作) 和 onMismatch (用于配置不符合过滤条件的操作)接收或拒绝日志。
<!-- 日志过滤 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 指定日志级别 -->
<level>ERROR</level>
<!-- 匹配则全部接受 -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配则全部拒绝 -->
<onMismatch>DENY</onMismatch>
</filter>
输出到文件RollingFileAppender:
日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志:
<!--输出到文件-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
滚动策略rollingPolicy的定义:
<rollingPolicy>
标签用来指定滚动策略, 所谓的滚动策略其实就是对日志文件进行归档。 标签只有 1 个class属性,其常见的属性值如下:
- ch.qos.logback.core.rolling.TimeBaseRollingPolicy:基于时间的滚动策略
- ch.qos.logback.core.rolling.SizeAndTimeBaseRollingPolicy:基于文件大小和时间滚动策略
<rollingPolicy>
的子标签如下:
<fileNamePattern>
:指定归档后的日志文件名
<maxHistory>
:指定日志的保留天数
<totalSizeCap>
:指定归档文件的总大小,超过其指定的值后,旧的日志文件会被删除
<maxFileSize>
:指定日志文件的限制大小,在 “基于文件大小和时间滚动策略” 中使用
6. 子节点<root>
root节点是必选节点,用来指定最基础的日志输出级别,根logger,也是一种logger,且只有一个level属性。
日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL
,如果设置为WARN,则低于WARN的信息都不会输出
<root level="DEBUG">
<appender-ref ref="LOGSTASH"/>
</root>
7. 子节点<logger>
用来设置某一个包或者具体的某一个类的日志打印级别以及指定appender。
<logger>
有 3 个属性:
name
:必选属性,用来指定受此logger约束的某一个包或者具体的某一个类。level
:可选属性,用来设置日志打印级别,大小写无关:TRACE,DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。addtivity
:是否向上级logger传递打印信息(默认是true)。如果 addtivity 的属性值为 true,则在当前 logger 所绑定的 appender 中的输出的日志,在 root 绑定的 appender 中也会输出
<!--没有指定level、addtivity以及appender,则默认继承上级日志配置-->
<logger name="com.xmc.controller"/>
8.子节点<include>
引入其他Logback配置文件
<include resource="org/springframework/boot/logging/logback/base.xml"/>
base.xml是SpringBoot Logback的基础配置
9.子节点<springProfile>
用于多环境配置
<!-- 多环境配置 -->
<springProfile name="dev,test">
<!-- root -->
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
四、配置参考模板
<?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="60 seconds" debug="false">
<!--需要使用springProperty,才可使用application.properties(或application.yml)中的值 -->
<springProperty name="app.name" source="spring.application.name" default="111"/>
<!-- 定义日志目录 -->
<property name="DEBUG_LOG_PATH" value="logs/debug"/>
<property name="INFO_LOG_PATH" value="logs/info"/>
<property name="WARN_LOG_PATH" value="logs/warn"/>
<property name="ERROR_LOG_PATH" value="logs/error"/>
<!-- 定义日志保留天数 -->
<property name="MAX_HISTORY" value="7"/>
<!-- 定义日志文件总大小 -->
<property name="TOTAL_SIZE_CAP" value="10GB"/>
<!-- 定义单个日志文件大小 -->
<property name="MAX_FILE_SIZE" value="50MB"/>
<!-- 输出到控制台 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<!-- 日志输出格式 -->
<!--<pattern>[%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}: %msg%n</pattern>-->
<!--日期 日志等级 PID 线程名 类路径 方法名 java源文件 行号 打印信息 换行-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%5p) %green(${PID:- }) - %magenta([%15.15t]) %cyan(%C.%M\(%F:%L\)) : %msg%n</pattern>
<!--同上, 仅输出类路径, 不输出 方法名 java源文件 行号 -->
<!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%5p) %green(${PID:- }) - %magenta([%15.15t]) %cyan(%-40.40logger{40}) : %msg%n</pattern>-->
</encoder>
</appender>
<!-- 只输出DEBUG日志 -->
<appender name="DEBUG_LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${DEBUG_LOG_PATH}/output.log</file>
<!-- 基于文件大小和时间的滚动策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${DEBUG_LOG_PATH}/output-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 日志文件保留天数 -->
<maxHistory>${MAX_HISTORY}</maxHistory>
<!-- 日志归档文件总大小 -->
<totalSizeCap>${TOTAL_SIZE_CAP}</totalSizeCap>
<!-- 单个日志文件大小 -->
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</rollingPolicy>
<!-- 日志输出格式 -->
<encoder>
<pattern>[%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}: %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志过滤 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 指定日志级别 -->
<level>DEBUG</level>
<!-- 匹配则全部接受 -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配则全部拒绝 -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 只输出INFO日志 -->
<appender name="INFO_LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${INFO_LOG_PATH}/output.log</file>
<!-- 基于文件大小和时间的滚动策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${INFO_LOG_PATH}/output-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 日志文件保留天数 -->
<maxHistory>${MAX_HISTORY}</maxHistory>
<!-- 日志归档文件总大小 -->
<totalSizeCap>${TOTAL_SIZE_CAP}</totalSizeCap>
<!-- 单个日志文件大小 -->
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</rollingPolicy>
<!-- 日志输出格式 -->
<encoder>
<pattern>[%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}: %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志过滤 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 指定日志级别 -->
<level>INFO</level>
<!-- 匹配则全部接受 -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配则全部拒绝 -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 只输出WARN日志 -->
<appender name="WARN_LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${WARN_LOG_PATH}/output.log</file>
<!-- 基于文件大小和时间的滚动策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${WARN_LOG_PATH}/output-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 日志文件保留天数 -->
<maxHistory>${MAX_HISTORY}</maxHistory>
<!-- 日志归档文件总大小 -->
<totalSizeCap>${TOTAL_SIZE_CAP}</totalSizeCap>
<!-- 单个日志文件大小 -->
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</rollingPolicy>
<!-- 日志输出格式 -->
<encoder>
<pattern>[%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}: %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志过滤 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 指定日志级别 -->
<level>WARN</level>
<!-- 匹配则全部接受 -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配则全部拒绝 -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 只输出ERROR日志 -->
<appender name="ERROR_LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${ERROR_LOG_PATH}/output.log</file>
<!-- 基于文件大小和时间的滚动策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${ERROR_LOG_PATH}/output-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 日志文件保留天数 -->
<maxHistory>${MAX_HISTORY}</maxHistory>
<!-- 日志归档文件总大小 -->
<totalSizeCap>${TOTAL_SIZE_CAP}</totalSizeCap>
<!-- 单个日志文件大小 -->
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</rollingPolicy>
<!-- 日志输出格式 -->
<encoder>
<pattern>[%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}: %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志过滤 -->
<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 -->
<!--
使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:
-->
<!-- <logger name="com.xmc.biz.mapper" level="DEBUG" />-->
<!--
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。
默认是DEBUG 可以包含零个或多个元素,标识这个appender将会添加到这个logger。
-->
<!-- 多环境配置 -->
<springProfile name="test,prod">
<!-- root -->
<root level="INFO">
<appender-ref ref="INFO_LOG_FILE"/>
<appender-ref ref="ERROR_LOG_FILE"/>
</root>
</springProfile>
<!-- 多环境配置 -->
<springProfile name="dev,test">
<!-- root -->
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
</configuration>
五、 参考文档
官方文档
Spring Boot logback日志配置
SpringBoot 整合 Logback 框架
Logback 配置文件