Springboot中slf4j+log4j2的使用

Springboot中slf4j+log4j2的使用

0.简介

slf4j: 日志门面

log4j2: 日志实现

我要是直接用log4j2打日志当然可以,但是我想换的时候,就需要修改很多代码.

比如说导入的日志类啊,logger的声明啊等等.

但是我可以让slf4j来做,slf4j是多个日志框架的上层,大家都基于slf4j来做.

这样,要切换具体的日志框架时,只用换个依赖那些就好了, 代码之类的不用任何修改.

这就是面向接口编程的思想,方法形参放置接口,运行时传入不同的实现类,就能产生出不同的实现效果.

1.导入pom

        <!-- log4j2依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

2.排除默认的logback

默认的是logback,需要在pom中排除掉这个默认的.

网上说的排spring-boot-starter-web,试了不行.此处排的是spring-boot-starter中的.

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                 <!-- 20210714去掉logback配置 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
                 <!-- 20210714去掉logback配置 end -->
                <exclusion>
                    <artifactId>logback-classic</artifactId>
                    <groupId>ch.qos.logback</groupId>
                </exclusion>
            </exclusions>
        </dependency>

3.编写配置文件

放到项目的resources目录下即可.

文件名:log4j2.xml

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

    <!-- 参数声明 -->
    <Properties>
        <property name="LOG_PATTERN"
                  value="%d{yyyy-MM-dd HH:mm:ss.SSS} -- %style{[%t]}{bright,magenta} %highlight{%-5level}{ERROR=Bright RED, WARN=Bright Yellow, INFO=Bright Green, DEBUG=Bright Cyan, TRACE=Bright White} %logger{36}.%M - %msg%n"/>
        <!-- ./当前路径 此处为项目根路径-->
        <!-- debug 日志文件位置及名称，在rollFile的时候老文件的生成规则 -->
        <property name="DEBUG_FILE_PATH_ING" value="./logs/debug.log"/>
        <property name="DEBUG_FILE_PATH_ED" value="./logs/debug-%d{yyyy-MM-dd}.%i.log"/>

        <!-- info 日志文件位置及名称，在rollFile的时候老文件的生成规则 -->
        <property name="INFO_FILE_PATH_ING" value="./logs/info.log"/>
        <property name="INFO_FILE_PATH_ED" value="./logs/info-%d{yyyy-MM-dd}.%i.log"/>

        <!-- error 日志文件位置及名称，在rollFile的时候老文件的生成规则 -->
        <property name="ERROR_FILE_PATH_ING" value="./logs/error.log"/>
        <property name="ERROR_FILE_PATH_ED" value="./logs/error-%d{yyyy-MM-dd}.%i.log"/>

        <!-- warn 日志文件位置及名称，在rollFile的时候老文件的生成规则 -->
        <property name="WARN_FILE_PATH_ING" value="./logs/warn_error.log"/>
        <property name="WARN_FILE_PATH_ED" value="./logs/warn_error-%d{yyyy-MM-dd}.%i.log"/>

        <!-- 日志文件最大文件大小全局配置，一天之内最大文件产生数量全局配置 -->
        <property name="MAX_FILE_SIZE" value="100MB"/>
        <property name="MAX_FILE_NUM" value="30"/>
    </Properties>

    <appenders>
        <!-- 控制台输出日志信息 -->
        <console name="Console_Log" target="SYSTEM_OUT">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </console>

        <!-- debug日志文件输出日志信息 -->
        <RollingFile name="Debug_File" fileName="${DEBUG_FILE_PATH_ING}" filePattern="${DEBUG_FILE_PATH_ED}">
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="${MAX_FILE_SIZE}"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <DefaultRolloverStrategy max="${MAX_FILE_NUM}"/>
        </RollingFile>

        <!-- info日志文件输出日志信息 -->
        <RollingFile name="Info_File" fileName="${INFO_FILE_PATH_ING}" filePattern="${INFO_FILE_PATH_ED}">
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="${MAX_FILE_SIZE}"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <DefaultRolloverStrategy max="${MAX_FILE_NUM}"/>
        </RollingFile>

        <!-- warn日志文件输出日志信息 -->
        <RollingFile name="Warn_File" fileName="${ERROR_FILE_PATH_ING}" filePattern="${ERROR_FILE_PATH_ED}">
            <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="${MAX_FILE_SIZE}"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <DefaultRolloverStrategy max="${MAX_FILE_NUM}"/>
        </RollingFile>

        <!-- error日志文件输出日志信息 -->
        <RollingFile name="Error_File" fileName="${ERROR_FILE_PATH_ING}" filePattern="${ERROR_FILE_PATH_ED}">
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="${MAX_FILE_SIZE}"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <DefaultRolloverStrategy max="${MAX_FILE_NUM}"/>
        </RollingFile>

    </appenders>

    <!--配置总的日志监听级别-->
    <loggers>
        <root level="DEBUG">
            <appender-ref ref="Console_Log"/>
            <appender-ref ref="Debug_File"/>
            <appender-ref ref="Info_File"/>
            <appender-ref ref="Error_File"/>
        </root>
    </loggers>
</configuration>

配置文件示例2

<?xml version="1.0" encoding="UTF-8" ?>
<!--
    status="warn" 日志框架本身的输出日志级别，可以修改为debug
    monitorInterval="5" 自动加载配置文件的间隔时间，不低于 5秒；生产环境中修改配置文件，是热更新，无需重启应用
 -->
<configuration status="warn" monitorInterval="5">
    <!--
    集中配置属性进行管理
    使用时通过:${ }
    -->
    <properties>
        <property name="LOG_HOME">D:ProjectFiles1-IntelliJIDEAWorksYangStudylogs</property>
    </properties>

    <!-- 日志处理 -->
    <Appenders>
        <!-- 控制台输出 appender，SYSTEM_OUT输出黑色，SYSTEM_ERR输出红色 -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n" />
        </Console>

        <!-- 日志文件输出 appender -->
        <File name="file" fileName="${LOG_HOME}/myfile.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n" />
        </File>

        <!-- 使用随机读写流的日志文件输出 appender，性能提高 -->
        <RandomAccessFile name="accessFile" fileName="${LOG_HOME}/myAcclog.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n" />
        </RandomAccessFile>

        <!-- 按照一定规则拆分的日志文件的appender -->  <!-- 拆分后的文件 -->

        <!-- filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/myrollog-%d{yyyy-MM-dd-HH-mm}-%i.log"> -->
        <RollingFile name="rollingFile" fileName="${LOG_HOME}/myrollog.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/myrollog-%d{yyyy-MM-dd}-%i.log">
            <!-- 日志级别过滤器 -->
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
            <!-- 日志消息格式 -->
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %msg%n" />
            <Policies>
                <!-- 在系统启动时，出发拆分规则，生产一个新的日志文件 -->
                <OnStartupTriggeringPolicy />
                <!-- 按照文件大小拆分，10MB -->
                <SizeBasedTriggeringPolicy size="2MB" />
                <!-- 按照时间节点拆分，规则根据filePattern定义的 -->
                <TimeBasedTriggeringPolicy />
            </Policies>
            <!-- 在同一个目录下，文件的个限定为 30个，超过进行覆盖 -->
            <DefaultRolloverStrategy max="10" />
        </RollingFile>

    </Appenders>

    <!-- logger 定义 -->
    <Loggers>
        <!-- 使用 rootLogger 配置 日志级别见第5节 -->
        <Root level="trace">
            <!-- 指定日志使用上面哪个处理器 -->
            <AppenderRef ref="Console" />
            <AppenderRef ref="file" />
            <AppenderRef ref="rollingFile" />
            <AppenderRef ref="accessFile" />
        </Root>
    </Loggers>
</configuration>

4.使用

类上面加注解@Slf4j

// info
log.info("请求地址: "+ request.getRequestURI());
// 占位符的使用{}
log.info("<< | {} | 返回给调用方的响应的报文:
 {}", msgId, JSON.toJSONString(sxResponse));
// << | msgId | 返回给调用方的响应的报文:
 JSON.toJSONString(sxResponse)", msgId, JSON.toJSONString(sxResponse)

5.日志级别

通过改变配置文件中的日志级别,就能打印出不同的日志.

eg: 有的场景只是你在debug的时候看看,所以你代码写log.debug(),有的信息你经常想看到,所以你代码写log.info().

由于级别info>debug,所以在配置文件中设置级别为debug时能看到debug+info的信息,设置级别为info时就可以不看到debug的信息.

在log4j2中, 共有8个级别,按照从低到高为:

ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

• All:最低等级的,用于打开所有日志记录.
• Trace:是追踪,就是程序推进一下.
• Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
• Info:消息在粗粒度级别上突出强调应用程序的运行过程.
• Warn:输出警告及warn以下级别的日志.
• Error:输出错误信息日志.
• Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
• OFF:最高等级的，用于关闭所有日志记录.