首先,Java日志框架可以分为两类:门面型日志框架和记录型日志框架。
门面型日志框架
- JCL:Java日志接口,后更名为Commons Logging
- SLF4J:是一套简易Java日志门面,本身并无日志的实现
记录型日志框架
- JUL:JDK中的日志记录工具,自JDK1.4以来的官方日志实现
- Log4j:基于Java的日志记录工具
- Log4j2:
- logBack:一个具体的日志实现框架,与SLF4J是同一个作者,但其性能更好。
下面主要介绍一下常用的Slf4j门面框架搭配各种记录型日志框架的基础配置方法。
不引入记录型日志框架:
如果我们项目中单纯只引入Slf4j,如下所示。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>log</artifactId>
<groupId>org.luxinfeng</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>slf4j</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
</dependency>
</dependencies>
</project>
在执行日志记录时,会提示如下:即如果没有选定具体的记录型日志框架时,会使用默认的NOP实现,即什么都不输出。
SLF4J: No SLF4J providers were found.
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See https://www.slf4j.org/codes.html#noProviders for further details.
引入simple日志框架:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>log</artifactId>
<groupId>org.luxinfeng</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>slf4j</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>2.0.6</version>
</dependency>
</dependencies>
</project>
slf4j-simple是一个用于在Java程序中实现简单日志记录的组件,它使用简单的文本格式记录日志消息,并且不支持配置文件或其他高级功能,因此非常适合调试和开发环境。但是,如果需要对生产环境中的日志进行更严格的管理和控制,则可能需要使用其他更加复杂的日志实现。(slf4j-simple只支持INFO及以上级别的日志展示),示例如下。
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(Slf4jWithoutImpl.class);
logger.info("Info message");
logger.error("Error message");
logger.warn("Warn message");
logger.debug("Debug message");
}
输出为
[main] INFO slf4j.Slf4jWithoutImpl - Info message
[main] ERROR slf4j.Slf4jWithoutImpl - Error message
[main] WARN slf4j.Slf4jWithoutImpl - Warn message
引入JUL(Java.util.logging)框架
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>log</artifactId>
<groupId>org.luxinfeng</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>slf4j</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
<version>2.0.6</version>
</dependency>
</dependencies>
</project>
输出
二月 11, 2023 11:31:03 上午 slf4j.Slf4jWithoutImpl main
信息: Info message
二月 11, 2023 11:31:03 上午 slf4j.Slf4jWithoutImpl main
严重: Error message
二月 11, 2023 11:31:03 上午 slf4j.Slf4jWithoutImpl main
警告: Warn message
通过配置文件可以修改日志的展示形式。
创建配置文件logging.properties,然后在VM Options加上参数:-Djava.util.logging.config.file=C:\Users\123456\IdeaProjects\log\slf4j\src\main\resources\logging.properties(配置文件的绝对日志)
注意:java.util.logging中的日志等级与我们常用的有所区别,比如SEVERE对应的是ERROR,详情可见:https://ost.51cto.com/posts/235
handlers = java.util.logging.ConsoleHandler
java.util.logging.ConsoleHandler.level = SEVERE
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format= [%1$tF %1$tT] [%4$-7s] %3$s %5$s %n
修改配置文件后输出为:
[2023-02-11 21:49:46] [严重 ] slf4j.Slf4jWithoutImpl Error message
引入LogBack框架
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>log</artifactId>
<groupId>org.luxinfeng</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>slf4j</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.3.5</version>
</dependency>
</dependencies>
</project>
输出:
22:09:50.477 [main] INFO slf4j.Slf4jWithoutImpl - Info message
22:09:50.477 [main] ERROR slf4j.Slf4jWithoutImpl - Error message
22:09:50.477 [main] WARN slf4j.Slf4jWithoutImpl - Warn message
配置文件
生成logback.xml文件,并放置到resources目录下。
日志级别:OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="/home" />
<!--控制台日志, 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!--文件日志, 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 日志输出级别 -->
<root level="WARN">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE"/>
</root>
</configuration>
输出:
2023-02-11 22:22:35.547 [main] ERROR slf4j.Slf4jWithoutImpl - Error message
2023-02-11 22:22:35.547 [main] WARN slf4j.Slf4jWithoutImpl - Warn message
引入Log4J2框架
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>log</artifactId>
<groupId>org.luxinfeng</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>slf4j</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
</dependency>
<!--log4j2核心包-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.9.1</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.9.1</version>
</dependency>
<!--用于与slf4j保持桥接-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>2.0.6</version>
</dependency>
</dependencies>
</project>
配置文件:
在resources文件夹下创建文件:log4j.properties文件,文件内容为
log4j.rootLogger=ALL, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
输出:
2023-02-11 23:00:49,407 INFO [slf4j.Slf4jWithoutImpl] - Info message
2023-02-11 23:00:49,407 ERROR [slf4j.Slf4jWithoutImpl] - Error message
2023-02-11 23:00:49,407 WARN [slf4j.Slf4jWithoutImpl] - Warn message
参考文献
- https://www.slf4j.org/manual.html
- https://www.slf4j.org/api/org/slf4j/simple/SimpleLogger.html
- https://segmentfault.com/a/1190000015802324
- https://juejin.cn/post/6905026199722917902
- https://www.cnblogs.com/gavincoder/p/10091757.html
- https://zhuanlan.zhihu.com/p/36554554
- https://developer.aliyun.com/article/852432
- https://www.jianshu.com/p/41e0a730347f
- https://stackoverflow.com/questions/34704267/log4j-logging-not-working
10.https://blog.51cto.com/u_3664660/3213853