Spring Boot 集成使用log4j2（异步）

log4j2异步的模式，采用的是disruptor高速并发框架，所以速度很快，适合高并发的系统使用。

1、首先要去掉Spring Boot的默认日志

主要是在spring-boot-starter增加例外。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions><!-- 去掉依赖的默认日志框架 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

2、引入log4j2的相关依赖

这里有两种方式：

1）第一种引入Spring Boot的默认配置，Spring Boot来引入相关的日志包。

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

2）第一种直接引入log4j2的相关配置。

这种方式需要引入两个包，一个是core核心实现，一个是API。

        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.11.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.11.2</version>
        </dependency>

以上两种，二选一，别重复引入。

3、引入disruptor并发框架

        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
        </dependency>

4、设置异步模式

1）完全异步模式

在开始程序里面设置参数，对于参数变量，许多朋友可能看到过“Log4jContextSelector”，也看到过“log4j2.contextSelector”，这两个变量效果是一样的。

System.setProperty("Log4jContextSelector", "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");

或者启动参数里设置

-DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

同样是循环1W次，输出日志，最后的性能结果如下图所示。注意：因为是异步的，所以控制台的日志就暂时不输出了，否则控制台看不到完成的时间。

Spring-boot-log4j2-完全异步.png

2）异步/同步混合模式

在配置文件中Logger使用<asyncRoot> 或 <asyncLogger>,而且<asyncRoot> 或 <asyncLogger>可以和<root> 或 <logger>混合使用。
主要改动为loggers里面的这一段，增加异步日志输入。

        <AsyncLogger name="AsyncLogger" level="trace" includeLocation="true">
            <appender-ref ref="RollingFileInfo" />
            <appender-ref ref="RollingFileWarn" />
            <appender-ref ref="RollingFileError" />
        </AsyncLogger>

完整的log4j2配置为如下所示。

<?xml version="1.0" encoding="UTF-8"?>
<!--设置log4j2的自身log级别为warn-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，
    当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="warn" monitorInterval="30">
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n"/>
        </console>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，
        则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="logs/log4j2/info.log"
                     filePattern="logs/log4j2/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="logs/log4j2/warn.log"
                     filePattern="logs/log4j2/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="logs/log4j2/error.log"
                     filePattern="logs/log4j2/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="ERROR"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>

    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <AsyncLogger name="AsyncLogger" level="trace" includeLocation="true">
            <appender-ref ref="RollingFileWarn" />
            <appender-ref ref="RollingFileError" />
        </AsyncLogger>
        <root level="all">
            <appender-ref ref="RollingFileInfo" />
        </root>
    </loggers>
</configuration>

这里需要注意的是，如果使用<asyncRoot> 或 <asyncLogger>，includeLocation="true"是必须要设置才会有类路径等一些信息打印出来。最后的性能结果如下图所示。

Spring-boot-log4j2-混合.png

5、性能比较

最后说明，通过学习前面的同步配置，我们可以看出性能梯度为：
全异步>混合模式>同步

其它注意

本文章样例：
工程名：spring-boot-log4j2-async
GitHub：https://github.com/zzyjb/SpringBootLearning