log4j2使用教程

1 基本用法

1.1 基本介绍

1.1.1 种类

市面上常见的日志框架有很多。通常情况下，日志是由一个抽象层+实现层的组合来搭建的，而用户通常来说不应该直接使用具体的日志实现类，应该使用日志的抽象层。使用接口的好处是当项目需要更换日志框架的时候，只需要更换 jar 和配置，不需要更改相关 java 代码。

• 抽象层：JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Facade for Java）、jboss-logging
• 实现层：Log4j 、JUL（java.util.logging）、Log4j2、Logback
• Log4j 是 apache 实现的一个开源日志组件
• Logback 同样是由 Log4j 的作者设计完成的，拥有更好的特性，用来取代 Log4j 的一个日志框架，是 SLF4j 的原生实现
• Log4j2 已经不仅仅是 Log4j 的一个升级版本了，它从头到尾都被重写了。由于使用了 LMAX Disruptor 技术（无锁异步），使得日志的吞吐量、性能比 log4j 1.x 提高 10 倍，并解决了一些死锁的 bug，而且配置更加简单灵活。

1.1.2 优势

SpringBoot 默认选择的是 SLF4J + Logback 的组合，在实际项目中我们可以整合 Log4j2 来代替原来的 Logback（形成 SLF4J + Log4j2 组合）。采用 Log4j2 有如下几个优点

• 相比与其他的日志系统，log4j2 丢数据的情况少；
• 采用 disruptor 技术，在多线程环境下，性能高于 logback 等 10 倍以上（无论在同步日志模式还是异步日志模式下，在所有日志框架中 log4j2 性能都是最佳的）
• 利用 jdk1.5 并发的特性，减少了死锁的发生；

1.2 整合Log4j2

1.2.1 编辑项目的 pom.xml 文件，引入 log4j2 依赖

如项目中有导入 spring-boot-starter-web 依赖包，记得去掉 spring 自带的日志依赖 spring-boot-starter-logging。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 去掉springboot默认日志配置 -->
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

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

 <dependency>
     <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
      <version>1.18.12</version>
 </dependency>

1.2.2 测试代码

package com.example.demo.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class TestController {
    Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/test")
    public void test() {
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }
}

2 日志配置文件

如果需要实现个性化的日志输出需求，我们可以通过配置文件进行设置。过去 log4j 是通过一个 .properties 文件作为主配置文件，而现在的 log4j2 则弃用了这种方式，采用的是 .xml、.json 或者 .jsn 这种方式来做，这也是技术发展的一个必然性，因为 properties 文件的可阅读性真的是有点差。

2.1 添加配置文件

• 默认配置文件名 log4j2-spring.xml，一般放置在 src/main/resources 根目录下即可。
• 如果自定义了文件名，需要在 application.properties 或者 application.yml 文件中配置：logging.config=classpath:log4j2-dev.xml

2.2 配置文件内容

下面是一个配置文件模版，可根据实际情况进行修改

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--变量配置-->
    <Properties>
        <!-- 这里定义两个格式化输出格式，分别用于文件日志和控制台日志（带颜色）-->
        <!-- %date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符 -->
        <property name="LOG_PATTERN" value="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%L] : %msg%n"/>
        <property name="LOG_PATTERN_HIGHLIGHT"
                  value="%date{yyyy-MM-dd HH:mm:ss:SSS} %highlight{%5level} [%thread] %style{%logger}{bright,cyan} [%style{%L}{bright,blue}] : %msg%n"/>

        <!-- 定义日志存储的路径，不要配置相对路径 该路径在本机一定要存在 否则会报错-->
        <property name="FILE_PATH" value="/Users/jacksonmike/IdeaProjects/springboot-log4j2/log"/>
        <!-- 定义日志归档压缩包名字，通常设置为项目名 -->
        <property name="FILE_NAME" value="springboot-log4j2"/>
    </Properties>

    <appenders>

        <!--*********************控制台日志***********************-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN_HIGHLIGHT}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--*********************文件日志***********************-->
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

3 异步输出日志

默认情况下 Log4j2 使用的是同步日志模式。但由于其采用的是 disruptor 高速并发框架，速度很快，因此我们也可以将其改成异步日志模式，提升性能。Log4j2 支持完全异步模式，也支持异步/同步混合模式，它们性能梯度为：完全异步模式 > 混合模式 > 同步模式。

3.1 要启用异步模式的话，除了要引入 Log4j2 依赖外，还需要引入 disruptor 并发框架。

<!-- 引入disruptor并发框架 -->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
</dependency>

3.2 完全异步模式

3.2.1 完全异步模式可以最大提升性能，也是官方也比较推荐的模式。一种方法是在启动类中加入相关属性参数即可：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        //下面语句使得日志输出使用异步处理，减小输出日志对性能的影响
        System.setProperty("Log4jContextSelector",
                "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");
        SpringApplication.run(DemoApplication.class, args);
    }

}

3.2.2 也可以在启动参数里设置

java -jar -DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector xxx.jar

3.3 异步/同步混合模式

如果需要采用混合模式的话，可以通过 log4j2 配置文件中的 Logger 部分进行设置（不需要在启动类或者启动命令中设置参数）。比如下面配置在前文基础上增加的高亮部分标示：只有该 APP 日志（com.example 包下的代码产生的日志）采用异步模式，其他日志仍然使用同步模式：

<loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--监控系统信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>
 
    <!-- com.example 包下日志采用异步模式 -->
    <AsyncLogger name="com.example" level="info" additivity="false">
        <AppenderRef ref="Console" />
        <AppenderRef ref="Filelog" />
        <AppenderRef ref="RollingFileInfo" />
        <AppenderRef ref="RollingFileWarn" />
        <AppenderRef ref="RollingFileError" />
    </AsyncLogger>
 
    <root level="info">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>

3.4 异步模式下类方法和行数信息不显示问题解决

3.4.1 问题描述

当我们使用异步模式时，会发现打印的类方法或者行号都无法显示。这是由于默认情况下，异步日志记录器不会将 location 信息传递给 I/O 线程。

3.4.2 解决办法

通过设置 includeLocation="true" 可以解决这个问题。设置后 log4j2 将会获取堆栈的快照（snapshot），并遍历堆栈跟踪以查找位置信息。当然这种方式对性能会有影响，所以如果打印日志的行数和所在方法并非十分必要的话，includeLocation="true" 这个配置能不用尽量不用

3.4.3 完全异步模式可以如此配置该参数

<loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--监控系统信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>

    <root level="info" includeLocation="true">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>

3.4.4 混合模式时可以如此配置该参数

<loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--监控系统信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>
 
    <!-- com.example 包下日志采用异步模式 -->
    <AsyncLogger name="com.example" level="info" additivity="false" includeLocation="true">
        <AppenderRef ref="Console" />
        <AppenderRef ref="Filelog" />
        <AppenderRef ref="RollingFileInfo" />
        <AppenderRef ref="RollingFileWarn" />
        <AppenderRef ref="RollingFileError" />
    </AsyncLogger>
 
    <root level="info">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>