maven中slf4j+log4j的使用

0.背景

参考我这篇

Springboot中slf4j+log4j2的使用

1.导入pom

2023.3.20,此时的最新版是2.20.0,这个版本里不再需要引入slf4j-api了。

	    <!-- 日志相关 - Start -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.20.0</version>
        </dependency>
        <!-- log4j2和slf4j桥接依赖-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.20.0</version>
        </dependency>
        <!-- 日志相关 - End -->

2021-09-09,用的2.8.2版本。

    <!-- 日志相关 - Start -->
    <!-- slf4j -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>
    <!-- log4j2: 建议2.6以上-->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.8.2</version>
    </dependency>
    <!-- log4j2和slf4j桥接依赖-->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.8.2</version>
    </dependency>
    <!-- 日志相关 - End -->

2.编写配置文件

文件名:log4j2.xml,放在resources目录下

image-20240116165157126

在 Log4j2 中,ThresholdFilter 是用来指定日志事件必须达到的最低级别的,即日志文件默认是>=的展示效果。

日志彩色显示需要启动ANSI支持

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

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

    <!-- 参数声明 -->
    <Properties>
        <property name="application.name">app</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][%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>

3.使用

  • (lombok)类上加注解@Slf4j
  • log.xx

4.效果

package cn.yang37.util;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;

@Slf4j
class ExcelUtilsTest {

    @Test
    void readContent() {
        log.debug("content");
        log.debug("content");
        
        log.info("content");
        log.info("content");
        
        log.warn("content");
        log.warn("content");
        
        log.error("content");
        log.error("content");
    }
}

image-20240116165521489

image-20240116165557840

5.其他

  • 如果我非要warn中只展示warn的日志,不显示更高级别的error日志呢?
<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">
    ...
    <Filters>
        <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
        <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
    </Filters>
    ...
</RollingFile>

这里使用了 <Filters> 标签来包含一组过滤器。

这样配置后,WARN 级别的日志将被接受,而 ERROR 级别及以上的日志将被拒绝。

NEUTRAL 决策意味着如果当前过滤器无法决定是否接受或拒绝日志事件,它会将决策留给下一个过滤器。

注意:

这种配置可能会使日志的管理变得复杂,因为它违反了日志级别的自然层次结构。

通常情况下,我们会记录一个级别以及以上的所有日志,这样可以确保错误总是被记录下来,即使它们没有被明确地写入到对应的日志文件中。

如果你决定只记录每个级别的日志,那么在发生错误时可能会丢失一些重要信息,除非你同时确保所有错误日志也被记录到了一个集中的地方。

posted @ 2021-09-09 19:42  羊37  阅读(692)  评论(0编辑  收藏  举报