概 述
Java应用中,日志一般分为以下5个级别:
- ERROR 错误信息
- WARN 警告信息
- INFO 一般信息
- DEBUG 调试信息
- TRACE 跟踪信息
Spring Boot使用Apache的Commons Logging作为内部的日志框架,其仅仅是一个日志接口,在实际应用中需要为该接口来指定相应的日志实现。
Spring Boot默认的日志实现是Java Util Logging,是JDK自带的日志包,此外Spring Boot当然也支持Log4J、Logback这类很流行的日志实现。
统一将上面这些日志实现统称为日志框架
下面我们来实践一下!
使用 SpringBoot Logging 插件
- 首先application.properties文件中加配置:
logging.level.root=INFO
- 测试代码如下:
package com.dhx;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class DemoApplicationTests {
private static Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);
@Test
void contextLoads() {
logger.info("test logging...");
}
}
- 运行结果
由于将日志等级设置为INFO
,因此包含INFO及以上级别的日志信息都会打印出来
这里可以看出,很多大部分的INFO日志均来自于SpringBoot框架本身,如果我们想屏蔽它们,可以将日志级别统一先全部设置为ERROR,这样框架自身的INFO信息不会被打印。然后再将应用中特定的包设置为DEBUG级别的日志,这样就可以只看到所关心的包中的DEBUG及以上级别的日志了。
- 控制特定包的日志级别
application.yml中改配置
logging:
level:
root: error
com.dhx: debug
很明显,将root日志级别设置为ERROR
,然后再将 com.dhx
包的日志级别设为DEBUG
,此即:即先禁止所有再允许个别的 设置方法
- 运行结果
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.3.6.RELEASE)
2022-12-22 10:35:16.962 INFO 14448 --- [ main] com.dhx.DemoApplicationTests : Starting DemoApplicationTests on LAPTOP-J10UUG6A with PID 14448 (started by DXH in D:\gitcode\test\springboot-demo\testlog)
2022-12-22 10:35:16.962 DEBUG 14448 --- [ main] com.dhx.DemoApplicationTests : Running with Spring Boot v2.3.6.RELEASE, Spring v5.2.11.RELEASE
2022-12-22 10:35:16.962 INFO 14448 --- [ main] com.dhx.DemoApplicationTests : No active profile set, falling back to default profiles: default
2022-12-22 10:35:18.313 INFO 14448 --- [ main] com.dhx.DemoApplicationTests : Started DemoApplicationTests in 1.602 seconds (JVM running for 2.407)
2022-12-22 10:35:18.503 INFO 14448 --- [ main] com.dhx.DemoApplicationTests : test logging...
可见框架自身的INFO级别日志全部藏匿,而指定包中的日志按级别顺利地打印出来
- 将日志输出到某个文件中
logging:
level:
root: error
com.dhx: debug
file:
name: ${user.home}/logs/hello.log
- 运行结果
使用Spring Boot Logging
,我们发现虽然日志已输出到文件中,但控制台中依然会打印一份,发现用org.slf4j.Logger
是无法解决这个问题的
集成 Log4J 日志框架
- pom.xml中添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
- 在resources目录下添加 log4j2.xml文件,内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration >
<!-- 先定义所有的appender -->
<appenders>
<File name="file" fileName="${sys:user.home}/logs/hello2.log">
<PatternLayout pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"/>
</File>
</appenders>
<!-- 然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->
<loggers>
<root level="ERROR">
<!-- 输出到控制台-->
<appender-ref ref="Console" />
<!-- 输出到文件 -->
<appender-ref ref="file"/>
</root>
<logger name="com.dhx" level="DEBUG"/>
</loggers>
</configuration>
- 其他代码都保持不变
运行程序发现控制台没有日志输出,而hello2.log文件中有内容,这符合我们的预期:
而且日志格式和 pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"格式中定义的相匹配
Log4J 更进一步实践
- pom.xml配置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
- log4j2.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<configuration status="WARN" monitorInterval="30" >
<properties>
<Property name="APP_NAME">springboot-web</Property>
<!--日志路径-->
<property name="LOG_HOME">C:/Users/DXH/logs/${APP_NAME}</property>
<property name="PATTERN">[%d][%t][%p][%l] %m%n</property>
</properties>
<!-- 先定义所有的appender -->
<appenders>
<!-- 这个输出控制台的配置 -->
<Console name="Console" target="SYSTEM_OUT">
<!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
<ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY" />
<!-- 这个都知道是输出日志的格式 -->
<PatternLayout pattern="${PATTERN}" />
</Console>
<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/info.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/info-%d{yyyy-MM-dd}-%i.log.gz">
<Filters>
<ThresholdFilter level="INFO" />
<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL" />
</Filters>
<PatternLayout pattern="${PATTERN}" />
<Policies>
<!--归档每天的文件-->
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<!--限制单个文件大小-->
<SizeBasedTriggeringPolicy size="1 MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了10 -->
<DefaultRolloverStrategy compressionLevel="0" max="10"></DefaultRolloverStrategy>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${LOG_HOME}/warn.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/warn-%d{yyyy-MM-dd}-%i.log.gz">
<Filters>
<ThresholdFilter level="WARN" />
<ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL" />
</Filters>
<PatternLayout pattern="${PATTERN}" />
<Policies>
<!--归档每天的文件-->
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<!--限制单个文件大小-->
<SizeBasedTriggeringPolicy size="1 MB"/>
</Policies>
<DefaultRolloverStrategy compressionLevel="0" max="10"></DefaultRolloverStrategy>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${LOG_HOME}/error.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/error-%d{yyyy-MM-dd}-%i.log.gz">
<ThresholdFilter level="ERROR" />
<PatternLayout pattern="${PATTERN}" />
<Policies>
<!--归档每天的文件-->
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<!--限制单个文件大小-->
<SizeBasedTriggeringPolicy size="1 MB"/>
</Policies>
<DefaultRolloverStrategy compressionLevel="0" max="10"></DefaultRolloverStrategy>
</RollingFile>
</appenders>
<!-- 然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->
<loggers>
<root level="INFO" >
<!-- 输出到控制台 -->
<appender-ref ref="Console" />
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
<!-- 数据库操作日志 -->
<logger name="dao" level="debug"></logger>
<!-- Spring日志只打印 -->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.eclipse" level="ERROR"></logger>
<logger name="org.apache.zookeeper" level="ERROR"></logger>
</loggers>
</configuration>
- 测试代码
package com.dhx;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class DemoApplicationTests {
private static Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);
@Test
void contextLoads() {
for (int i = 0; i < 10000000; i++) {
logger.info("info execute index method");
logger.warn("warn execute index method");
logger.error("error execute index method");
}
}
}
- 运行结果
日志会根据不同的级别存储在不同的文件,当日志文件大小超过1M
以后会分多个文件压缩存储,生产环境的日志文件大小建议调整为20-50MB
。