Springboot中slf4j+log4j2的使用

Springboot中slf4j+log4j2的使用

0.简介

slf4j: 日志门面

log4j2: 日志实现

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

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

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

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

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

image-20210719192859747

1.导入pom

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

2.排除默认的logback

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

此处排的是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>

如果依赖的比较细,是具体的spring-boot-starter-xx,就在这些细的依赖里面排除下,例如.

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

3.编写配置

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

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

<!--status:log4j包内部日志等级 600s刷新一次配置 -->
<Configuration status="WARN" monitorInterval="600">

    <!-- 参数声明 -->
    <Properties>
        <property name="application.name">yang-spring</property>
        <!-- 日志文件存放根路径 -->
        <property name="DEFAULT_LOG_ROOT_PATH" value="./"/>

        <!-- 日志格式 -->
        <property name="LOG_LEVEL_STYLES">FATAL=Bright Red, ERROR=Bright Red, WARN=Bright Yellow, INFO=Bright Green,
            DEBUG=Bright Cyan, TRACE=Bright White
        </property>
        <property name="THREAD_STYLE">bright,magenta</property>
        <!-- 日志样式-高亮 -->
        <property name="LOG_PATTERN"
                  value="[${application.name}][%d{yyyy-MM-dd HH:mm:ss.SSS}][%highlight{%-5level}{${LOG_LEVEL_STYLES}}][thread#%style{%thread}{${THREAD_STYLE}}][traceId#%X{traceId}][%C{50}:%L][%M][%highlight{%X{preMsg}}] %msg%n"/>
        <!-- 日志样式-无高亮 -->
        <!--        <property name="LOG_PATTERN" value="[${application.name}][%d{yyyy-MM-dd HH:mm:ss.SSS}][%-5level][thread#%thread][traceId#%X{traceId}][%C{50}:%L][%M][%X{preMsg}] %msg%n"/>-->

        <!-- 日志文件最大文件大小全局配置,单位可以为KB、MB或GB,一天之内最大文件产生数量全局配置 -->
        <property name="MAX_FILE_SIZE" value="100MB"/>
        <property name="MAX_FILE_NUM" value="30"/>

        <!-- debug 日志文件位置及名称,在rollFile的时候老文件的生成规则 -->
        <property name="DEBUG_FILE_PATH_ING" value="${DEFAULT_LOG_ROOT_PATH}/logs/current/debug.log"/>
        <!-- info 日志文件位置及名称,在rollFile的时候老文件的生成规则 -->
        <property name="INFO_FILE_PATH_ING" value="${DEFAULT_LOG_ROOT_PATH}/logs/current/info.log"/>
        <!-- warn 日志文件位置及名称,在rollFile的时候老文件的生成规则 -->
        <property name="WARN_FILE_PATH_ING" value="${DEFAULT_LOG_ROOT_PATH}/logs/current/warn.log"/>
        <!-- error 日志文件位置及名称,在rollFile的时候老文件的生成规则 -->
        <property name="ERROR_FILE_PATH_ING" value="${DEFAULT_LOG_ROOT_PATH}/logs/current/error.log"/>
    </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="${DEFAULT_LOG_ROOT_PATH}/logs/history/$${date:yyyy-MM-dd}/debug-%d{yyyy-MM-dd}.%i.log">
            <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="${DEFAULT_LOG_ROOT_PATH}/logs/history/$${date:yyyy-MM-dd}/info-%d{yyyy-MM-dd}.%i.log">
            <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="${WARN_FILE_PATH_ING}"
                     filePattern="${DEFAULT_LOG_ROOT_PATH}/logs/history/$${date:yyyy-MM-dd}/warn-%d{yyyy-MM-dd}.%i.log">
            <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="${DEFAULT_LOG_ROOT_PATH}/logs/history/$${date:yyyy-MM-dd}/error-%d{yyyy-MM-dd}.%i.log">
            <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="info">
            <appender-ref ref="Console_Log"/>
            <appender-ref ref="Debug_File"/>
            <appender-ref ref="Info_File"/>
            <appender-ref ref="Warn_File"/>
            <appender-ref ref="Error_File"/>
        </root>
    </loggers>

</Configuration>


如果要指定日志的位置,在springboot中可以使用如下配置。

logging:
  config: ./config/log4j2.xml

image-20240308152129159

4.使用

类上面加注解@Slf4j

// info
log.info("请求地址: "+ request.getRequestURI());

// 占位符的使用{}
log.info("请求地址: {}", request.getRequestURI());

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:最高等级的,用于关闭所有日志记录.
posted @ 2021-07-19 19:31  羊37  阅读(900)  评论(0编辑  收藏  举报