Springboot整合slf4j搭配log4j2

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: springboot日志

一、啥是日志

其实像我们在前端用的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>

image.gif

2、测试  

// 这了两种写法都 OK,推荐第一种,不用每次都要修改类名publicfinalLoggerlogger=LoggerFactory.getLogger(this.getClass());
publicfinalLoggerlogger=LoggerFactory.getLogger(DemoApplicationTests.class);

image.gif

packagecom.example.demo;
importorg.junit.jupiter.api.Test;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importorg.springframework.boot.test.context.SpringBootTest;
@SpringBootTestclassDemoApplicationTests {
publicfinalLoggerlogger=LoggerFactory.getLogger(this.getClass());
@TestpublicvoiddemoOne(){
logger.debug("debug");
logger.warn("warn");
logger.info("info");
logger.error("error");
    }
}

image.gif

3、结果

image.gif9.png

这里我们没有写配置文件,log4j2在spring启动时会给系统添加默认配置

<?xmlversion="1.0"encoding="UTF-8"?><Configurationstatus="WARN"><Appenders><Consolename="Console"target="SYSTEM_OUT"><PatternLayoutpattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/></Console></Appenders><Loggers><Rootlevel="error"><AppenderRefref="Console"/></Root></Loggers></Configuration>

image.gif

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

image.gif10.png

resources下新建log4j2-spring.xml

<?xmlversion="1.0"encoding="UTF-8"?><!--日志级别以及优先级排序: OFF>FATAL>ERROR>WARN>INFO>DEBUG>TRACE>ALL--><!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出--><!--monitorInterval:Log4j能够自动检测修改配置文件和重新配置本身,设置间隔秒数--><configurationstatus="WARN"monitorInterval="30"><!--先定义所有的appender--><appenders><!--这个输出控制台的配置--><consolename="Console"target="SYSTEM_OUT"><!--输出日志的格式--><PatternLayoutpattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/><!--控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)--><ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/></console><!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用--><Filename="Filelog"fileName="log/test.log"append="false"><!--%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><PatternLayoutpattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/></File><!--这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档--><RollingFilename="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)--><ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/><Policies><TimeBasedTriggeringPolicy/><SizeBasedTriggeringPolicysize="100 MB"/></Policies></RollingFile><RollingFilename="RollingFileWarn"fileName="${sys:user.home}/logs/warn.log"filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"><ThresholdFilterlevel="warn"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/><Policies><TimeBasedTriggeringPolicy/><SizeBasedTriggeringPolicysize="100 MB"/></Policies><!--DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20--><DefaultRolloverStrategymax="20"/></RollingFile><RollingFilename="RollingFileError"fileName="${sys:user.home}/logs/error.log"filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"><ThresholdFilterlevel="error"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/><Policies><TimeBasedTriggeringPolicy/><SizeBasedTriggeringPolicysize="100 MB"/></Policies></RollingFile></appenders><!--然后定义logger,只有定义了logger并引入的appender,appender才会生效--><loggers><!--过滤掉spring和mybatis的一些无用的DEBUG信息--><loggername="org.springframework"level="INFO"></logger><loggername="org.mybatis"level="INFO"></logger><rootlevel="info"><appender-refref="Console"/><appender-refref="Filelog"/><appender-refref="RollingFileInfo"/><appender-refref="RollingFileWarn"/><appender-refref="RollingFileError"/></root></loggers></configuration>

image.gif

application.properties中添加配置logging.config=classpath:log4j2-spring.xml

再次测试:

packagecom.example.demo;
importorg.junit.jupiter.api.Test;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importorg.springframework.boot.test.context.SpringBootTest;
@SpringBootTestclassDemoApplicationTests {
publicfinalLoggerlogger=LoggerFactory.getLogger(DemoApplicationTests.class);
@TestpublicvoiddemoOne(){
logger.debug("debug信息");
logger.warn("warn信息");
logger.info("info信息");
logger.error("error信息");
    }
}

image.gif

控制台:

image.gif11.png

image.gif12.png

扩展:关于日志level  

共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

程序会打印高于或等于所设置级别的日志

       All:最低等级的,用于打开所有日志记录.

       Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.

       Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

       Info:消息在粗粒度级别上突出强调应用程序的运行过程.

       Warn:输出警告及warn以下级别的日志.

       Error:输出错误信息日志.

       Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

       OFF:最高等级的,用于关闭所有日志记录.

    解析Log4j2配置文件

1、根节点Configuration有两个属性statusmonitorInterval,两个子节点AppendersLoggers

status用来指定本身的日志打印级别

monitorinterval为log4j 2.x新特点自动重载配置。指定自动重新配置的监测间隔时间,单位是s,最小是5s。

2、Appenders节点,常见的有三种子节点:ConsoleFileRollingFile

Console节点用来定义输出到控制台Appender

    • name:指定 Appender 的名字
    • targetSYSTEM_OUTSYSTEM_ERR,一般只设置默认:SYSTEM_OUT
    • PatternLayout:输出格式,不设置默认为%m%n

    这里的格式采用类似C语言中的printf函数的打印格式格式化日志信息,

    %m   输出代码中指定的消息; %n  输出一个回车换行符

    File节点用来定义输出到指定位置的文件的Appender

      • name:指定Appender的名字
      • fileName:指定输出日志的目的文件带全路径的文件名
      • PatternLayout:输出格式,不设置默认为%m%n

      RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender

        • name:指定Appender的名字
        • fileName:指定输出日志的目的文件带全路径的文件名
        • PatternLayout:输出格式,不设置默认为%m%n
        • filePattern:指定新建日志文件的名称格式
        • Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志
        • TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hourmodulate=true用来调整时间:比如现在是早上3aminterval是4,那么第一次滚动是在4am,接着是8am12am...而不是7am
        • SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size 属性用来定义每个日志文件的大小.
        • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。

        3、Loggers节点,常见的有两种RootLogger

        Root 节点用来指定项目的根日志,如果没有单独指定 Logger,那么就会默认使用该 Root日志输出

          • level:日志输出级别
          • AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender

          Logger 节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。

            • level:日志输出级别
            • name:用来指定该 Logger所适用的类或者类所在的包全路径,继承自 Root节点.
            • AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自 Root。如果指定了,那么会在指定的这个AppenderRootAppender中都会输出,此时我们可以设置 Loggeradditivity="false"只在自定义的 Appender中进行输出。
            相关实践学习
            日志服务之使用Nginx模式采集日志
            本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
            相关文章
            |
            9天前
            |
            XML 安全 Java
            【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
            本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
            108 30
            【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
            |
            6天前
            |
            Java 中间件
            SpringBoot入门(6)- 添加Logback日志
            SpringBoot入门(6)- 添加Logback日志
            40 5
            |
            14天前
            |
            JSON Java 数据库
            SpringBoot项目使用AOP及自定义注解保存操作日志
            SpringBoot项目使用AOP及自定义注解保存操作日志
            28 1
            |
            19天前
            |
            Java 程序员 API
            Android|集成 slf4j + logback 作为日志框架
            做个简单改造,统一 Android APP 和 Java 后端项目打印日志的体验。
            73 1
            |
            1月前
            |
            Java Maven Spring
            SpringBoot日志整合
            SpringBoot日志整合
            19 2
            |
            1月前
            |
            数据采集 监控 Java
            SpringBoot日志全方位超详细手把手教程,零基础可学习 日志如何配置及SLF4J的使用......
            本文是关于SpringBoot日志的详细教程,涵盖日志的定义、用途、SLF4J框架的使用、日志级别、持久化、文件分割及格式配置等内容。
            118 0
            SpringBoot日志全方位超详细手把手教程,零基础可学习 日志如何配置及SLF4J的使用......
            |
            1月前
            |
            SQL XML 监控
            SpringBoot框架日志详解
            本文详细介绍了日志系统的重要性及其在不同环境下的配置方法。日志用于记录系统运行时的问题,确保服务的可靠性。文章解释了各种日志级别(如 info、warn、error 等)的作用,并介绍了常用的日志框架如 SLF4J 和 Logback。此外,还说明了如何在 SpringBoot 中配置日志输出路径及日志级别,包括控制台输出与文件输出的具体设置方法。通过这些配置,开发者能够更好地管理和调试应用程序。
            |
            2月前
            |
            运维 NoSQL Java
            SpringBoot接入轻量级分布式日志框架GrayLog技术分享
            在当今的软件开发环境中,日志管理扮演着至关重要的角色,尤其是在微服务架构下,分布式日志的统一收集、分析和展示成为了开发者和运维人员必须面对的问题。GrayLog作为一个轻量级的分布式日志框架,以其简洁、高效和易部署的特性,逐渐受到广大开发者的青睐。本文将详细介绍如何在SpringBoot项目中接入GrayLog,以实现日志的集中管理和分析。
            223 1
            |
            3月前
            |
            存储 监控 Java
            Java日志通关(三) - Slf4j 介绍
            作者日常在与其他同学合作时,经常发现不合理的日志配置以及五花八门的日志记录方式,后续作者打算在团队内做一次Java日志的分享,本文是整理出的系列文章第三篇。
            |
            3月前
            |
            存储 监控 Java
            Java日志通关(三) - Slf4j 介绍
            作者日常在与其他同学合作时,经常发现不合理的日志配置以及五花八门的日志记录方式,后续作者打算在团队内做一次Java日志的分享,本文是整理出的系列文章第三篇。