Springboot整合slf4j搭配log4j2
【摘要】 Springboot整合slf4j搭配log4j2
一、啥是日志
其实像我们在前端用的alert、console.log(),后台就是System.out.print等都可以看作日志,可以通过这些方式打印出重要的信息
总而言之,日志是用来记录用户操作、系统运行状态等,是一个系统的重要组成部分。
二、选什么日志框架
首先列举一下日志门面和实现
| 日志门面(接口) | 日志实现 |
| JCL、SLF4J、Jboss logging、 | Log4j、JUL、Log4j2、Logback |
SpringBoot选用SLF4J和Logback
Log4j2是log4j 1.x和logback的改进版,所以这里我选SLF4J和Log4j2,Spring Boot 默认使用 logback,但相比较而言,log4j2 在性能上面会更好。log4j2在使用方面与 log4j 基本上没什么区别,比较大的区别是 log4j2 不再支持 properties 配置文件,支持 xml、json 格式的文件。
log4j、logback、log4j2都是一种日志具体实现框架,它们是可以单独使用的,那为什么还要搭配SLF4J呢?
slf4j是对所有日志框架制定的一种规范、标准、接口,并不是一个框架的具体的实现,我们知道接口中的方法是没有实现的,需要和具体的日志框架实现配合使用(如log4j、logback),使用接口的好处是当项目需要更换日志框架的时候,只需要更换jar和配置,不需要更改相关java代码
三、使用
1、POM文件中引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!-- 去掉logback配置 -->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- spring-boot-starter-log4j2 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
<version>2.2.5.RELEASE</version>
</dependency>

2、测试
// 这了两种写法都 OK,推荐第一种,不用每次都要修改类名
public final Logger logger = LoggerFactory.getLogger(this.getClass());
public final Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);

package com.example.demo;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class DemoApplicationTests {
public final Logger logger = LoggerFactory.getLogger(this.getClass());
@Test
public void demoOne(){
logger.debug("debug");
logger.warn("warn");
logger.info("info");
logger.error("error");
}
}

3、结果


这里我们没有写配置文件,log4j2在spring启动时会给系统添加默认配置
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>

实际项目中我们还是需要配置一下的,所以我们开始写个配置文件,该配置文件的名称我们按官网推荐的来,也可以自定义


在resources下新建log4j2-spring.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">
<!--先定义所有的appender-->
<appenders>
<!--这个输出控制台的配置-->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<!--控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</console>
<!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->
<File name="Filelog" fileName="log/test.log" append="false">
<!--%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符 -->
<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
</File>
<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
</appenders>
<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<loggers>
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<root level="info">
<appender-ref ref="Console"/>
<appender-ref ref="Filelog"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>

在application.properties中添加配置logging.config=classpath:log4j2-spring.xml
再次测试:
package com.example.demo;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class DemoApplicationTests {
public final Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);
@Test
public void demoOne(){
logger.debug("debug信息");
logger.warn("warn信息");
logger.info("info信息");
logger.error("error信息");
}
}

控制台:




扩展:关于日志level
共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
程序会打印高于或等于所设置级别的日志
All:最低等级的,用于打开所有日志记录.
Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.
Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
Info:消息在粗粒度级别上突出强调应用程序的运行过程.
Warn:输出警告及warn以下级别的日志.
Error:输出错误信息日志.
Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
OFF:最高等级的,用于关闭所有日志记录.
解析Log4j2配置文件
1、根节点Configuration有两个属性status和monitorInterval,两个子节点Appenders和Loggers
status用来指定本身的日志打印级别
monitorinterval为log4j 2.x新特点自动重载配置。指定自动重新配置的监测间隔时间,单位是s,最小是5s。
2、Appenders节点,常见的有三种子节点:Console、File、RollingFile
Console节点用来定义输出到控制台的
Appender
name:指定 Appender 的名字target:SYSTEM_OUT或SYSTEM_ERR,一般只设置默认:SYSTEM_OUTPatternLayout:输出格式,不设置默认为%m%n这里的格式采用类似C语言中的printf函数的打印格式格式化日志信息,
%m 输出代码中指定的消息; %n 输出一个回车换行符
File节点用来定义输出到指定位置的文件的Appender
name:指定Appender的名字fileName:指定输出日志的目的文件带全路径的文件名PatternLayout:输出格式,不设置默认为%m%n
RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender
name:指定Appender的名字fileName:指定输出日志的目的文件带全路径的文件名PatternLayout:输出格式,不设置默认为%m%nfilePattern:指定新建日志文件的名称格式Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7amSizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size 属性用来定义每个日志文件的大小.DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。
3、Loggers节点,常见的有两种Root和Logger:
Root 节点用来指定项目的根日志,如果没有单独指定
Logger,那么就会默认使用该Root日志输出
level:日志输出级别AppenderRef:Root的子节点,用来指定该日志输出到哪个AppenderLogger 节点用来单独指定日志的形式,比如要为指定包下的
class指定不同的日志级别等。
level:日志输出级别name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root。如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者



评论(0)