Spring Boot 下的 log4j2的使用

应

         在前些年一直在net平台上做开发，也使用了log4net进行日志管理，并且基于log4net进行了组件开发，实现了对“东方财富网”股吧的全站日志监控系统。东方财富网股吧注册用户1300万，日活600万，日新增帖子20万，日回帖300万，这些数据全部通过log4net组件进行接入“日志监控系统”，实现功能包括所有接口的访问日志（用户ID、设备UDID、设备终端来源、访问入口、请求接口）、超时日志（接口耗时统计）、设备统计等。

        今天研究了下log4j2，轻松上手，主要有如下要点。

一.pom.xml依赖

因为spring boot 包含logback日志功能，避免冲突，需先排除

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <!--引入log4j需排除Logback-->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

 添加log4j2依赖

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

二.application.yml配置

logging:
  config: classpath:log4j2.xml

三.log4j2.xml配置

    这里是重点，我不贴全部属性，贴最简属性做讲解。如下图所示：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="error">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <!--先定义所有的appender -->
    <appenders>
        <!--输出控制台的配置 -->
        <Console name="Console00" target="SYSTEM_OUT">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式 -->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </Console>

        <!--append属性true：表示消息追加到文件中；false：消息覆盖，默认值是true -->
        <File name="trace11" fileName="D:/logs/trace.log" append="false">
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        <File name="debug22" fileName="D:/logs/debug.log" append="false">
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <File name="Info33" fileName="D:/logs/info.log" append="false">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <File name="Warn44" fileName="D:/logs/warn.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <File name="ERROR55" fileName="D:/logs/error.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <!--这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
<!--        <RollingFile name="RollingFile" fileName="D:/logs/web.log"-->
<!--                     filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">-->
<!--            <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>-->
<!--            <SizeBasedTriggeringPolicy size="2MB"/>-->
<!--      </RollingFile>-->
    </appenders>


    <!--appender-ref 指向 appenders下file的name属性,一致时才输出-->
    <loggers>
        <root level="trace">
            <appender-ref ref="RollingFile"/>
            <appender-ref ref="Console00"/>
            <appender-ref ref="trace11" />
            <appender-ref ref="debug22" />
            <appender-ref ref="ERROR33" />
            <appender-ref ref="Warn44"/>
            <appender-ref ref="Info55"/>
        </root>
    </loggers>
</configuration>

 讲解： 

       <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

      1.<appenders> 下有<Console>、<File>、<RollingFile>各种节点，表示日志可以以Console控制输出、File单个文件输入（覆盖或追加）、RollingFile多个文件（限制文件大小）。<File>方式，一般对于日志量不多可用，日志量输出较多时文件会越来越大，导致文件输入流、打开时都非常缓慢，因此引入RollingFile文件，可以按日创建日志文件，或按文件大小创建日志文件。
       <File>、<RollingFile>可以配置多个，问各个Level分别设置，如上面的代码，我设置了5个<File>节点，分别设置各个level日志的存储路径、输出格式等。

            2.<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>节点属性，表示只输出level及以上级别的信息，低于它的将不会写入。

          我们用上面的配置，结合测试代码来看运行结果。添加测试代码如下：

package com.example;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class Log4j2Test {
    private static Logger logger= LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);

    public static void main(String[] args) {
        for(int i=0;i<1;i++){
            // 记录trace级别的信息
            logger.trace("log4j2日志输出：This is trace message.");
            // 记录debug级别的信息
            logger.debug("log4j2日志输出：This is debug message.");
            // 记录info级别的信息
            logger.info("log4j2日志输出：This is info message.");
            // 记录warn级别的信息
            logger.warn("log4j2日志输出：This is warn message.");
            // 记录error级别的信息
            logger.error("log4j2日志输出：This is error message.");
        }
    }
}

       输出结果如下：

首先控制台输入：

File输出：

再看每个File输出的详细：