针对Spring boot的项目,博主采用的日志框架是slf4j + log4j 2.x。
Spring Boot提供了对多种日志框架的支持,而默认使用的是Logback。然而,如果你的项目中引入了依赖于Log4j的第三方库,可能会引发Log4j的版本冲突。通过引入log4j-to-slf4j,Spring Boot可以将这些依赖于Log4j的日志消息转发到SLF4J中,并由底层的日志框架(比如Logback)进行处理,从而避免潜在的冲突和问题。如果采用log4j 2.x,那么就不需要logback,log4j-to-slf4j,依赖排除:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>${spring.boot.version}</version>
<exclusions>
<exclusion>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-to-slf4j</artifactId>
</exclusion>
</exclusions>
</dependency>
SLF4J
SLF4J(Simple Logging Facade for Java)是一个简单的 Java 日志门面,用于统一日志系统的接口。它提供了一个抽象层,允许应用程序以统一的方式记录日志,而无需关心底层的日志实现。 在实际项目中我们一般使用这个抽象层,底层对接具体的日志框架。本文的目的是为了快速跑起来,实现一个简单的日志demo。
Log4j2 和 SLF4j 绑定
为了使 Log4j2 与 SLF4J 一起工作,我们需要包含以下 4 个依赖项。
slf4j-api.jar– SLF4J 提供了一个统一的日志接口,包括 Logger、LoggerFactory、Marker 等,使得应用程序能够通过这些接口来进行日志记录。log4j-slf4j-impl.jar– Log4j2和SLF4J 绑定。它充当 SLF4J接口和Log4j2实现之间的适配器,log4j-slf4j-impl 模块提供了 SLF4J 的一个实现,使得应用程序可以使用 SLF4J API 进行日志记录,而实际的日志输出将由 Log4j 2 处理。log4j-api.jar– 为实现类提供创建日志记录实现所需的适配器组件接口。log4j-core.jar– 核心 Log4j 实现类。
第一个是SLF4J,第三、四个是log4j 2的依赖,第二个是Log4j2和SLF4J绑定的依赖
1、Maven 依赖
<properties>
<log4j.version>2.17.1</log4j.version>
<slf4j.version>1.7.25</slf4j.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j.version}</version>
</dependency>
</dependencies>
2、Log4j2.properties 配置文件
一般 log4j2.properties 配置文件的结构可以分为:全局配置,根 logger 配置,Appender(日志记录器)配置。
2.1 配置两个日志记录输出(控制台和文件)的log4j2.properties,日志文件按天进行打包。【通用】
#status = debug
name= Log4jPropertiesConfig
# Configure root logger
rootLogger.level = info
rootLogger.appenderRef.rolling.ref = fileLogger
rootLogger.appenderRef.stdout.ref = STDOUT
# Console appender
appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n
# RollingFileAppender name, pattern, path and rollover policy
appender.rolling.type = RollingFile
appender.rolling.name = fileLogger
appender.rolling.fileName= app.log
appender.rolling.filePattern= app_%d{yyyyMMdd}.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 1
appender.rolling.policies.time.modulate = true
根logger要绑定对应的Appender。STDOUT和fileLogger对应两个Appender的name。
rootLogger.appenderRef.rolling.ref = fileLogger
rootLogger.appenderRef.stdout.ref = STDOUT
如果只配置一个日志记录(Appender)也可以。
日志回滚appender.rolling.filePattern= app_%d{yyyyMMdd}.log.gz去掉.gz表示不压缩日志文件,若压缩,可用zless命令来直接查看(此命令可能需要安装)。
2.2 只配置输出到控制台(标准输出)的log4j2.properties
#status = debug
name= Log4jPropertiesConfig
rootLogger.level = info
rootLogger.appenderRef.stdout.ref = STDOUT
# Console appender
appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n
2.3 只配置输出到文件的log4j2.properties
#status = debug
name= Log4jPropertiesConfig
rootLogger.level = info
rootLogger.appenderRef.rolling.ref = fileLogger
# RollingFileAppender name, pattern, path and rollover policy
appender.rolling.type = RollingFile
appender.rolling.name = fileLogger
appender.rolling.fileName= app.log
appender.rolling.filePattern= app_%d{yyyyMMdd}.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 1
appender.rolling.policies.time.modulate = true
#appender.rolling.strategy.delete.ifLastModified.age = 30d
配置解释:
name= Log4jPropertiesConfig是一个名字,随便取。rootLogger.level = info:设置根记录器的日志级别。在这种情况下,设置为 "info",表示将记录 "info" 级别及以上的日志(debug、info、warn、error)。appender.rolling.policies.time.interval = 1:时间间隔为1,其单位取决于appender.rolling.filePattern中时间的最小单位,比如此处是app_%d{yyyyMMdd}.log.gz,最小是dd,即天,所以此处是一天打包一次,即每天的日志在0点就打包成一个文件,yyyyMMdd改为yyyyMMdd-HH,此处最小单位是HH,小时,那么间隔就是1小时打包一次。appender.rolling.filePattern = app_%d{yyyyMMdd}.log.gz:配置打包的日志文件格式。appender.rolling.strategy.delete.ifLastModified.age = 30d:设置删除日志文件的年龄阈值。超过 30 天的文件将被删除。appender.rolling.fileName= app.log修改app.log来改变日志文件的名字,比如改为application.log,支持添加相对路径,比如./logs/application.log
除了基于时间的rotation,还有基于日志文件size的rotation。
3、代码测试
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Log4jExample {
private static final Logger logger = LoggerFactory.getLogger(Log4jExample.class);
public static void main(final String[] args) {
System.out.println("Logging to console and file...");
logger.debug("Debug Message Logged !!!");
logger.info("Info Message Logged !!!");
logger.error("Error Message Logged !!!", new NullPointerException("NullError"));
}
}
将依赖添加pom.xml文件中,将log4j2.properties文件放入resources目录下,代码运行起来,就会发现有一个app.log日志文件生成,并且控制台有输出,也可以修改rootLogger.level来控制日志输出的等级,查看变化。
至此,一个简单的日志记录框架就有已经搭建起来了。