Spring Boot日志：SLF4J和Logback
日志的分类
SpringBoot中的日志库分为两种：
- 实现库：提供具体的日志实现，例如日志级别的控制、打印格式、输出目标等。
- 外观库：自身不提供日志实现，而是对其他日志库进行封装，从而方便使用。基于外观模式实现。
关于外观库的出现，可设想一下：现在有多种日志库，每一种接口都不同。于是我们在不同项目中往往需要调用不同的API。于是希望，无论哪一种日志库，我们都在外面套一层壳，使用时调用这层壳的接口，这样就统一了。这层壳就是外观库。
对于这两种库，常见的有：
- 实现库：
Log4j、Log4j2、Logback - 外观库：
Slf4j、Apache Commons Logging
通常只需要引入Slf4j依赖，然后通过Slf4j来调用Logback或Log4j。
对应地，配置文件除了对Slf4j进行配置，也可以对Logback或Log4j进行配置。
Logback相比于Log4j，性能提高了10倍以上的性能，占用的内存也变小了，并且文档十分详细。推荐使用Slf4j+Logback。
官网：
https://logback.qos.ch/
官方文档：
https://logback.qos.ch/documentation.html
Slf4j、Logback和Log4j是同一个作者，使用了相同的设计，因此Slf4j直接可调用Logback和Log4j。而对于其他日志实现库，例如java.util.logging等，需要使用一个适配器模块来将Apache Commons Logging的接口转换为Slf4j的可调用接口。
Spring Boot日志
依赖
Spring Boot默认使用Logback。只需要引入spring-boot-starter或spring-boot-starter-web就会默认包含，不需要再单独引入。
lombok中默认包含了Slf4j，因此只要引入了lombok就无需再单独引入Slf4j：
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<version>1.18.24version>
dependency>
日志对象
要打印，就要先获取日志对象。
通常地，使用Slf4j包中的LoggerFactory来得到日志对象，然后打印：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class LoggerController {
// 得到日志对象
private Logger logger = LoggerFactory.getLogger(LoggerController.class);
@RequestMapping("/logger")
public String logger() {
// 日志打印
logger.trace("日志级别: trace");
logger.debug("日志级别: debug");
logger.info("日志级别: info");
logger.warn("日志级别: warn");
logger.error("日志级别: error");
return "logger";
}
}
如果项目中引入了lombok组件，则可在类前添加@Slf4j注解，这样就可在类中直接使用log日志对象，而无需通过LoggerFactory来获取。
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Slf4j // 通过lombok的`@Slf4j`得到日志实例
public class LoggerController {
@RequestMapping("/logger")
public String logger() {
// 日志打印
log.trace("日志级别: trace");
log.debug("日志级别: debug");
log.info("日志级别: info");
log.warn("日志级别: warn");
log.error("日志级别: error");
return "logger";
}
}
日志级别及配置
日志级别
日志有8个级别：
- ALL: 开启所有日志
- TRACE: 追踪，程序每次执行一步都输出。级别较低，通常不会使用
- DEBUG: 调试日志，细粒度
- INFO: 普通日志，粗粒度
- WARN: 警告日志
- ERROR: 错误日志，但不影响系统同运行
- FATAL: 严重错误日志，会导致系统退出
- OFF: 关闭所有日志
对于这8个级别，级别依次递增。级别越高，打印的日志越少。
通常地，只使用TRACE、DEBUG、INFO、WARN、ERROR这5个等级。
Spring Boot会打印指定级别及更高级的日志。
例如日志设置为INFO级，那么Spring Boot会打印INFO、WARN、ERROR。
配置文件
logback的配置可在application.yml和xml中配置，其中xml配置更加灵活。
若多个配置同时存在，则其加载顺序为：
logback.xml → application.yml → logback-spring.xml
后加载的会覆盖先加载的。因此application.yml会覆盖logback.xml中的相同配置。即后加载的优先级更高。
同理，若要使用 application.yml 中定义的变量，应使用 logback-spring.xml 。官方推荐使用 logback-spring.xml 。
logback.xml
加载logback.xml时，默认会在classpath查找以下文件: 用户自定义xml > logback-test.xml > logback.groovy > logback.xml 。
如果上述4个配置文件都不存在，那么logback会调用BasicConfigurator来创建一个最小化配置将日志输出到控制台。最小化配置会构造一个父为PatternLayoutEncoder为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n。
其中用户自定义xml是在application.yml中通过logging.config=classpath:logging-config.xml配置的。
yml配置
logging:
config: classpath:logback.xml # 自定义配置文件
pattern:
file: "%d{HH:mm:ss.SSS} [%thread] %highlight(%-5level) %cyan(%logger{15} - %msg %n)" # 文件输出
console: "%d{HH:mm:ss.SSS} [%thread] %highlight(%-5level) %cyan(%logger{15} - %msg %n)" # 控制台输出
file:
name: E:\logs\test.log # 日志文件输出路径
level:
root: INFO # root输出级别
com.spring: WARN # 特定包的输出级别
xml结构
<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
appender>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
appender>
<appender name="ROLLING" class="ch.qos.logback.core.RollingFileAppender">
appender>
<root>root>
<logger>logger>
configuration>
注意区分属性和配置的区别：
- 属性：标签自身的属性，直接写在标签标签内，例如
， 就是`标签的属性。 - 配置：标签的功能设置，使用子标签进行配置，例如
testFile.log
最外层标签
- scan: 启用扫描。默认为true。当为true时，若配置文件发生变更，将会被重新加载。
- scanPeriod: 配置文件扫描时间间隔。默认单位是毫秒，可修改。当scan为true时，此属性生效。默认时间间隔为1分钟。
- debug: 默认为false。若设为true，将实时打印出logback内部日志信息。
例如：
<configuration scan="false" scanPeriod="60 seconds" debug="false">
为了避免同一服务器上多个web应用的logger产生上下文冲突，可使用
例如：
<contextName>TestcontextName>
一个
name: 指定root标签中引用。class: 指定所使用实现库中Appender类的含路径名称。
关于class，有以下几个常用取值：
ch.qos.logback.core.ConsoleAppender: 输出到控制台。ch.qos.logback.core.FileAppender: 输出到静态记录文件。ch.qos.logback.core.rolling.RollingFileAppender: 输出到滚动日志文件。
ConsoleAppender
ConsoleAppender最为简单，直接输出到控制台。通常用于开发调试。
ConsoleAppender常用的设置为：
例如：
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>console %d %p - %m%npattern>
encoder>
appender>
FileAppender
FileAppender会将所有的日志信息都写入到一个文件中。因此若append属性为true，则日志文件会越来越大。
FileAppender常用的设置为：
true，则新的日志会追加到文件末尾；若为false，则写新日志前会清空日志文件。
例如：
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.logfile>
<append>trueappend>
<encoder>
<pattern>%d %p - %m%npattern>
encoder>
RollingFileAppender
RollingFileAppender会将日志滚动记录，即写入一个文件，当满足条件时，再写入下一个文件。例如设置文件大小为30MB，则当写入的日志文件达到30MB时会再新建一个日志文件进行写入。达到条件这个行为称为滚动。
RollingFileAppender常用的设置为：
true，则新的日志会追加到文件末尾；若为false，则写新日志前会清空日志文件。
例如：
<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>testFile.logfile>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${app-name}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
<MaxHistory>30MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>30MBmaxFileSize>
timeBasedFileNamingAndTriggeringPolicy>
rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %-5level ] [ %thread ] - [ %logger{50} : %line ] - %msg%npattern>
layout>
class属性指定滚动策略，不同的策略有不同的配置。
- 基于时间的滚动策略：
ch.qos.logback.core.rolling.TimeBasedRollingPolicy。
该策略根据时间来判定是否触发滚动。最常用。
常用配置为：
%d转换符来接收一个java.text.SimpleDateFormat对象，例如%d{yyyy-MM-dd HH:mm:ss.SSS}。
- 基于文件大小的滚动策略：
ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy。
该策略会监视日志文件大小，当文件超过指定大小时触发滚动。
true，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但此时必须满足：1不支持也不允许文件压缩；2不能设置file属性。
- 定义日志的输出等级。
- 指定哪些
name属性固定为ROOT，且没有上级，故而
level: 最重要，指定日志的打印等级，默认为DEBUG。其值可以为：ALL，TRACE，DEBUG，INFO，WARN，ERROR，FATAL，OFF。不可以设置为INHERITED或NULL`。
可以在
例如：
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="FILE" />
<appender-ref ref="ROLLING" />
root>
其中ref属性即为name属性。
parent属性为null。
例如设置springframework的等级为WARN，此时就可添加一个
name: 指定需单独设置的组件类名。level: 设置组件的日志等级。其值可以为：ALL，TRACE，DEBUG，INFO，WARN，ERROR，FATAL，OFF。可设置为INHERITED或NULL`。若不设置，则默认继承上级的level。additivity: 是否向上级true。若为true，则本false。
例如：
<logger name="TEST_PARENT" level="INFO" additivity="false">
<appender-ref ref="TEST_CHILD"/>
logger>
这样就形成了父子关系，TEST_CHILD的上级为TEST_PARENT。
parent属性，指向其父parent，只有parent属性形成的，而非类继承这样的关系。
定义变量
变量有两种：本地变量和配置文件变量。
本地变量
在xml中定义一个变量，然后在整个xml文件中引用。格式为：
通过${变量名}格式使用变量。例如：
<property name="LOG_HOME" value="E:/logs/" />
<appender>
<file>${LOG_HOME}/${app-name}.logfile>
appender>
配置文件变量
若希望从yml或.properties中读取变量值在xml中使用，则需要使用
例如，在application.yml中定义了一个logback_app_property.level变量：
logback_app_property:
level: INFO
现在希望引用这个level变量，则可在xml中添加source属性指向logback_app_property.level变量。
<springProperty name="YML_LEVEL" source="logback_app_property.level" defaultValue="INFO"/>
同样是通过${变量名}格式使用变量：
<root level="${YML_LEVEL}">
root>
实例
首先在yml中定义
logging:
# 指定 logback-app.xml 作为logback的配置文件
config: classpath:logback-app.xml
# 用于 logback-app.xml 文件配置的参数值
logback_app_property:
# TRACE < DEBUG < INFO < WARN < ERROR
level: INFO
然后在logback-app.xml中定义：
<configuration>
<contextName>ApplicationcontextName>
<jmxConfigurator/>
<property name="LOG_HOME" value="E:/logs/" />
<property name="app-name" value="test-admin"/>
<property name="filename" value="server"/>
<property name="ENCODER_PATTERN" value="%red(%date{ISO8601}]) %highlight(%-5level) %green([%10.10thread]) [%X{X-B3-TraceId}] %boldMagenta(%logger{20}) - %cyan(%msg%n)" />
<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${ENCODER_PATTERN}pattern>
<charset>UTF-8charset>
encoder>
appender>
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${app-name}.logfile>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${app-name}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
<MaxHistory>30MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>30MBmaxFileSize>
timeBasedFileNamingAndTriggeringPolicy>
rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %-5level ] [ %thread ] - [ %logger{50} : %line ] - %msg%npattern>
layout>
appender>
<appender name="errorLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${app-name}-error.logfile>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${app-name}-error-%d{yyyy-MM-dd}.logfileNamePattern>
<maxHistory>90maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %-5level ] [ %thread ] - [ %logger{50} : %line ] - %msg%npattern>
encoder>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>WARNlevel>
filter>
appender>
<logger name="org.springframework" level="WARN"/>
<logger name="org.spring" level="WARN"/>
<logger name="org.hibernate" level="WARN"/>
<logger name="io.grpc.netty" level="OFF"/>
<logger name="org.eclipse.jetty" level="WARN"/>
<logger name="jndi" level="WARN"/>
<logger name="redis.clients" level="WARN"/>
<logger name="application" level="WARN"/>
<logger name="springfox.documentation" level="WARN"/>
<logger name="com.netflix" level="WARN"/>
<logger name="org.reflections" level="WARN"/>
<logger name="org.apache" level="WARN"/>
<logger name="io.grpc.internal.ClientCallImpl" level="OFF"/>
<logger name="org.springframework.amqp.rabbit" level="ERROR"/>
<logger name="com.baomidou.dynamic.datasource.DynamicRoutingDataSource" level="WARN"/>
<logger name="com.zaxxer.hikari.pool.HikariPool" level="WARN"/>
<logger name="org.quartz.core.QuartzSchedulerThread" level="ERROR"/>
<logger name="io.lettuce.core.protocol.RedisStateMachine" level="INFO"/>
<logger name="io.lettuce.core.RedisChannelHandler" level="INFO"/>
<logger name="io.lettuce.core.protocol.CommandHandler" level="INFO"/>
<logger name="io.lettuce.core.protocol.CommandEncoder" level="INFO"/>
<logger name="io.lettuce.core.protocol.DefaultEndpoint" level="INFO"/>
<logger name="io.lettuce.core.protocol.ConnectionWatchdog" level="INFO"/>
<logger name="io.lettuce.core.RedisClient" level="INFO"/>
<logger name="org.mybatis.spring.mapper.ClassPathMapperScanner" level="INFO"/>
<logger name="com.baomidou.mybatisplus.core.MybatisConfiguration" level="INFO"/>
<springProperty name="LEVEL" source="logback_app_property.level" defaultValue="INFO"/>
<root level="${LEVEL}">
<appender-ref ref="consoleAppender"/>
<appender-ref ref="appLogAppender" />
<appender-ref ref="errorLogAppender" />
root>
configuration>
在程序中动态更改日志级别
在程序中使用代码来动态修改日志级别，首先导入库：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.LoggerContext;
然后获取level：
String loggerName = "ROOT";
String loggerLevel = "DEBUG";
// 获取日志上下文
LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
// 获取ROOT
ch.qos.logback.classic.Logger logger = loggerContext.getLogger(loggerName);
// 修改日志等级
logger.setLevel(Level.valueOf(loggerLevel));
注意这里的loggerName与JMX不同，是大小写不敏感的，例如ROOT可以写作root。
Java管理扩展 JMX（Java Management Extensions）
JMX是一个带窗口的应用程序，为运行中的应用提供管理功能。JMX是跨平台的，与具体应用无关。配置logback开启JMX后即可通过JMX查看logback信息。
配置logback开启JMX，需在xml中添加一行标签：
当应用运行后，打开系统的CMD窗口，在其中输入命令：
jconsole
然后就会打开JMX的应用窗口，并提示新建连接。设应用程序运行在本地，则在本地进程的列表中选择对应的应用程序，然后双击或点连接。
之后可能弹出安全连接失败。是否以不安全的方式重试？，选择不安全的连接即可。
在上方的标签列表中点击MBean标签，然后在列表中找到ch.qos.logbak.classic，依次点击进入default→ch.qos.logback.classic.jmx.JMXConfigurator，其下会列出属性和操作两个列表。在其下分别包含不同的功能。
对于属性，包含LoggerList和Statuses。其中LoggerList列出了所有的Logger。特殊地，ROOT，会列在第一行。
对于操作，可进行：
- 重新加载logback的默认配置文件。
- 通过指定的URL重新加载配置文件。
- 通过指定的文件重新加载配置文件。
- 设置指定logger级别，可设为
null。 - 获取指定logger级别，可返回
null。 - 指定logger的有效级别。
点击属性下的LoggerList，即可看到一个Logger数组。第一个就是ROOT。
点击操作下的getLoggerLevel，需输入一个参数p1，该参数就是LoggerList中的一个Logger。输入ROOT，然后点击按钮getLoggerLevel，即可看到ROOT的等级。注意这里的p1是大小写敏感的，例如ROOT不可以写作root。
点击操作下的setLoggerLevel，需输入两个参数p1和p2，p1为Logger名称，p2为level值。例如p1输入ROOT，p2输入DEBUG，然后点击按钮setLoggerLevel，即可将ROOT变更为DEBUG等级。
同理，更改应用的配置文件 logback.xml ，然后点击 操作 下的reloadDefaultConfiguration，并点击右侧的reloadDefaultConfiguration按钮，即可重新加载配置文件。
但在实际测试中，若配置文件为 logback.xml ，则表现相对正常；而若配置文件为其他名称，例如 logback-spring.xml ，则重载配置文件后原控制台将不再进行打印，且对配置文件的修改也不会生效。似乎reloadDefaultConfiguration只识别 logback.xml 。
另外，修改配置文件只能是更改 logback.xml 本身。如果修改的是application.yml中的logback_app_property.level变量，reloadDefaultConfiguration时并不会重新读取该变量并应用到 logback.xml 中。
一般来说，通过JMX来修改的只有ROOT，以及logback.xml中配置的多个