springboot log4j2 配置介绍

配置文件节点介绍

根节点Configuration

属性：

• status: 用来指定log4j本身的打印日志级别;
• monitorinterval: 用来指定log4j自动重新配置的检测间隔时间，单位: s, 最小5s;

子节点：

• Appenders
• Loggers

Appenders节点

Configuration根节点的子节点。

子节点：

• Console: 用来定义输出到控制台的Appender;
• RollingFile: 用来定义超过指定大小自动删除旧的创建新的的Appender;
• File: 用来定义输出到指定位置的文件的Appender;

Console节点

Appenders节点的子节点，用来定义输出到控制台的Appender。

属性：

• name: 用来指定Appender的名称;
• target: 可选值 SYSTEM_OUT 或 SYSTEM_ERR。一般只设置默认:SYSTEM_OUT;

子节点：

• PatternLayout: 输出格式，默认值：%m%n;

File节点

Appenders节点的子节点，用来定义输出到指定位置的文件的Appender，一般用来测试输出。

属性：

• name: 用来指定Appender的名称;
• fileName: 指定输出日志的目的文件带全路径的文件名;

子节点：

• PatternLayout: 输出格式，默认值：%m%n;
• ThresholdFilter: 指定输出级别;

RollingFile节点

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

属性：

• name: 用来指定Appender的名称;
• fileName: 指定输出日志的目的文件带全路径的文件名;
• filePattern: 指定新建日志文件的名称格式;

子节点：

• PatternLayout: 输出格式，默认值：%m%n;
• DefaultRolloverStrategy: 用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性);
• Policies: 指定滚动日志的策略，就是什么时候进行新建日志文件输出日志;
• Filters: 决定日志事件能否被输出。过滤条件有三个值：ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立);

Policies节点

RollingFile节点的子节点，指定滚动日志的策略。

子节点：

• TimeBasedTriggeringPolicy: 基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am;
• SizeBasedTriggeringPolicy: 基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小;

PatternLayout节点

Console节点、File节点、RollingFile节点的子节点，指定输出格式，不设置默认为:%m%n。

属性：

• pattern: 指定日志格式;

日期格式：

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间

%-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0

%p : 日志输出格式

%c : logger的名称(%logger)

%m : 日志内容, 即 logger.info("message")

%n : 换行符

%C : Java类名(%F)

%L : 日志输出所在行数

%M : 日志输出所在方法名

%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数

%t: 表示线程名(%thread)

hostName : 本地机器名

hostAddress : 本地ip地址

ThresholdFilter节点

Filter节点的子节点，决定日志事件能否被输出。过滤条件有三个值：ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立)。

ACCEP和DENY比较好理解就是接受和拒绝的意思，在使用单个过滤器的时候，一般就是使用这两个值。但是在组合过滤器中，如果用接受ACCEPT的话，日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以，在组合过滤器中，接受使用NEUTRAL（中立），被第一个过滤器接受的日志信息，会继续用后面的过滤器进行过滤，只有符合所有过滤器条件的日志信息，才会被最终写入日志文件。

属性：

• level: 指定过滤日志的级别;
• onMatch: 默认值是NEUTRAL;
• onMismatch: 默认是DENY

Loggers节点

子节点：

• Root: 用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出;
• Logger: 用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等;

Root节点

Loggers节点的子节点。

属性：

• level: 指定日志输出级别;

子节点：

• appender-ref: 用来指定该日志输出到哪个Appender，通过ref指定;

Logger节点

Loggers节点的子节点。

属性：

• level: 指定日志输出级别;
• name: 用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点;

子节点：

• appender-ref: 用来指定该日志输出到哪个Appender，通过ref指定;

日志级别

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

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

示例

application.properties配置

loggging.config=classpath:log4j2.xml

pom.xml添加依赖

<!-- springboot核心包 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <!-- 去掉springboot默认log配置 -->
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <version>2.4.0</version>
</dependency>

配置log4j2.xml

在resources下新建log4j2.xml文件并写入一下内容：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF" monitorInterval="5">
    <!--变量配置-->
    <Properties>
        <!--输出文件位置-->
        <property name="FILE_PATH" value="/Users/chenglulu/Documents/log" />
        <!--日志输出格式 %date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%logger{36}：表示Logger名字最长36个字符，%m：日志消息，%n是换行符-->
        <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} %L %M - %m%n" />
        <!--日期名后缀-->
        <property name="LOG_DATE_PATTERN" value=".%d{yyyy-MM-dd}" />
    </Properties>
    <appenders>
        <!--控制台输出的配置-->
        <Console name="Console" target="SYSTEM_OUT">
            <!--日志格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
        </Console>
        <!--文件会打印所有日志信息，一般用户测试使用，这个log每次运行程序会自动清空，由append属性决定，-->
        <File name="FileLog" filename="${FILE_PATH}/demo-debug.log" append="false">
            <!--日志内容格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
        </File>
        <!--DEBUG日志文件配置-->
        <RollingFile name="RollingFileDebug" filename="${FILE_PATH}/demo-api-debug.log" filePattern="${FILE_PATH}/demo-api-debug.log${LOG_DATE_PATTERN}">
            <!--匹配DEBUG及以上级别日志，其他拒绝-->
            <Filters>
                <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!--日志内容格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
            <Policies>
                <!--依据时间创建新的日志文件：1d-->
                <TimeBasedTriggeringPolicy interval="1"/>
            </Policies>
        </RollingFile>
        <!--INFO日志文件配置-->
        <RollingFile name="RollingFileInfo" filename="${FILE_PATH}/demo-api-info.log" filePattern="${FILE_PATH}/demo-api-info.log${LOG_DATE_PATTERN}">
            <!--匹配INFO及以上级别日志，其他拒绝-->
            <Filters>
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!--日志内容格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
            <Policies>
                <!--依据时间创建新的日志文件：1d-->
                <TimeBasedTriggeringPolicy interval="1"/>
            </Policies>
        </RollingFile>
        <!--WARN日志文件配置-->
        <RollingFile name="RollingFileWarn" filename="${FILE_PATH}/demo-api-warn.log" filePattern="${FILE_PATH}/demo-api-warn.log${LOG_DATE_PATTERN}">
            <!--匹配WARN及以上级别日志，其他拒绝-->
            <Filters>
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!--日志内容格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
            <Policies>
                <!--依据时间创建新的日志文件：1d-->
                <TimeBasedTriggeringPolicy interval="1"/>
            </Policies>
        </RollingFile>
        <!--ERROR日志文件配置-->
        <RollingFile name="RollingFileError" filename="${FILE_PATH}/demo-api-error.log" filePattern="${FILE_PATH}/demo-api-error.log${LOG_DATE_PATTERN}">
            <!--匹配ERROR及以上级别日志，其他拒绝-->
            <Filters>
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!--日志内容格式-->
            <PatternLayout pattern="${LOG_PATTERN}" />
            <Policies>
                <!--依据时间创建新的日志文件：1d-->
                <TimeBasedTriggeringPolicy interval="1"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <root level="DEBUG">
            <appender-ref ref="Console"/>
            <appender-ref ref="FileLog"/>
            <appender-ref ref="RollingFileDebug"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
        <!--这里配置 过滤日志 -->
        <logger name="org.hibernate.validator" level="ERROR"/>
    </loggers>
</configuration>

使用

配合Slf4j

@Slf4j
public class LogExample(){
    public static void main(){
        log.error("something is error")
    }
}

配合LoggerFactory

public class LogExample(){

    private static final Logger logger = LoggerFactory.getLogger(LogExample.class);
    
    public static void main(){
        logger.error("something is error")
    }
}