介绍
SLF4J全称“Simple Logging Facade for Java”,作为各种日志框架的简单门面。例如: java.util.logging、logback 、 reload4j等。只需要切换日志框架的jar包依赖就可以切换日志框架。
SLF4J支持的日志框架包含如下:
- log4j:常用的日志框架,需要有配置文件log4j.properties
- logback:可以通过logback.xml修改日志输出配置,如果没有logback.xml则使用默认配置
- java.util.logging:JDK 1.4 logging
- simple:简单实现,只显示INFO以上级别,实际使用System.err输出
- jcl:Jakarta Commons Logging
- nop:无提示不显示所有日志
使用示例
1、引入依赖jar包
SLF4J目前已将发布了2.X版本,这里以经常用的1.7.36版本为例。
创建简单的maven工程,并引入依赖。
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.36</version>
</dependency>
<!-- log4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-reload4j</artifactId>
<version>1.7.36</version>
</dependency>
<!-- logback
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.11</version>
</dependency> -->
<!-- 简单实现,只显示INFO以上级别,实际使用System.err输出
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.7.36</version>
</dependency> -->
<!-- jdk14
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
<version>1.7.36</version>
</dependency> -->
<!-- nop 无提示不显示所有日志
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-nop</artifactId>
<version>1.7.36</version>
</dependency>-->
<!-- Jakarta Commons Logging
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jcl</artifactId>
<version>1.7.36</version>
</dependency> -->
2、代码使用示例
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
private final static Logger log = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
log.info("这个是测试日志输出,{}","Hello World");
}
}
1)如果使用log4j需要添加配置文件log4j.properties
,如果没有该配置文件,无法打印日志,简单内容如下:
# Root logger option
log4j.rootLogger=INFO,file,stdout
# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c{2}:%L - %m%n
# Direct log messages to a log file
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=log/output-log4j.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c{2}:%L - %m%n
2)如果使用logback,也可以添加配置文件logback.xml
,如果没有该配置文件,就使用默认配置,内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<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>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>
<file>log/output-logback.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>log/output.log.%i</fileNamePattern>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>1MB</MaxFileSize>
</triggeringPolicy>
</appender>
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</configuration>
3、测试打印内容
1)log4j
2023-03-10 14:55:54 [main] INFO demo.LogTest:9 - 这个是测试日志输出,Hello World
2023-03-10 14:55:56 [main] INFO demo.LogTest:9 - 这个是测试日志输出,Hello World
2)logback
2023-03-10 14:53:21 [main] INFO cn.hj.sl4j.demo.LogTest - 这个是测试日志输出,Hello World
2023-03-10 14:53:33 [main] INFO cn.hj.sl4j.demo.LogTest - 这个是测试日志输出,Hello World
3)slf4j-simple
[main] INFO cn.hj.sl4j.demo.LogTest - 这个是测试日志输出,Hello World
4)slf4j-jdk14
三月 10, 2023 3:00:53 下午 cn.hj.sl4j.demo.LogTest main
信息: 这个是测试日志输出,Hello World
5)jcl
三月 10, 2023 3:01:31 下午 org.slf4j.impl.JCLLoggerAdapter info
信息: 这个是测试日志输出,Hello World
总结
SLF4J是一个门面日志框架,统一了日志的使用标准,如果要切换不同的日志实现只需要修改对应的实现依赖jar包就可以,不需要修改java代码