Log4j2配置文件XML详解

目前实现日志的常用的框架主要有Log4j2，Logback，Log4j(已经停止更新，它的升级版本Log4j2)，slf4j（只是一个日志标准，并不是日志系统的具体实现）。网上说Log4j2的效率高于Logback，但是具体我没有去深入的了解。关于slf4j整合log4j2可以参考： 使用Slf4j集成Log4j2构建项目日志系统的完美解决方案 

依赖引入：

       <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.23.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.23.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.23.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-jul</artifactId>
            <version>2.23.1</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jul-to-slf4j</artifactId>
            <version>2.0.13</version>
        </dependency>

或者直接使用springboot log4j2依赖

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

1.Log4j2支持的配置文件名

log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为".xml",".json"或者".jsn".

　　　　系统选择配置文件的优先级(从先到后)如下：

　　　　　　(1).classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.

　　　　　　(2).classpath下的名为log4j2-test.xml的文件.

　　　　　　(3).classpath下名为log4j2.json 或者log4j2.jsn的文件.

　　　　　　(4).classpath下名为log4j2.xml的文件.

　　　　　我们一般默认使用log4j2.xml进行命名。如果本地要测试，可以把log4j2-test.xml放到classpath，而正式环境使用log4j2.xml，则在打包部署的时候不要打包log4j2-test.xml即可。

2.缺省默认配置文件

 <?xml version="1.0" encoding="UTF-8"?>
  <Configuration status="WARN">
    <Appenders>
      <Console name="Console" target="SYSTEM_OUT">
        <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
      </Console>
    </Appenders>
    <Loggers>
      <Root level="error">
        <AppenderRef ref="Console"/>
      </Root>
    </Loggers>
 </Configuration>

3 配置文件节点解析　

         log4j的节点详细可以参考官网：Log4j – Configuring Log4j 2 

3.1 根节点Configuration 

　　根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

　　　status用来指定log4j本身的打印日志的级别.

　　　monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.

3.2 Appenders节点 

Appenders节点，常见的有三种子节点:Console、RollingFile、File.

　　1. Console节点用来定义输出到控制台的Appender.

　　　　name:指定Appender的名字.

　　　　target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

　　　　PatternLayout:输出格式，不设置默认为:%m%n.

　　　2.File节点用来定义输出到指定位置的文件的Appender.

　　　　　name:指定Appender的名字.

　　　　　fileName:指定输出日志的目的文件带全路径的文件名.

　　　　　PatternLayout:输出格式，不设置默认为:%m%n.

　　　3.RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.

　　　　　name:指定Appender的名字.

　　　　　fileName:指定输出日志的目的文件带全路径的文件名.

　　　　　PatternLayout:输出格式，不设置默认为:%m%n.

　　　　　filePattern:指定新建日志文件的名称格式.

　　　　　Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.

　　　　   TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.

　　　　  SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

　　　　  DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

　 4. Root节点

　　Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出，

        level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

5.Logger节点

　　　Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

         name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.

　　AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出。

        additivity：是否继承root节点，默认是true继承。默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。

　3.3关于日志level

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

　　All:最低等级的，用于打开所有日志记录.

　Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.

　　Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

　　Info:消息在粗粒度级别上突出强调应用程序的运行过程.

　　Warn:输出警告及warn以下级别的日志.

　　Error:输出错误信息日志.

　　Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

　 OFF:最高等级的，用于关闭所有日志记录.

4. Log4j2完整的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: 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{yyyy-MM-dd HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="logs/test.log" append="false">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="logs/info.log"
                     filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>

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

            <filters>
                <!--不包含-->
                <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
                <!--包含-->
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            </filters>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="logs/error.log"
                     filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <root level="ALL">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="INFO" additivity="false">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </logger>
        <logger name="org.mybatis" level="INFO"></logger>
    </loggers>
</configuration>

PatternLayout布局：

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
%-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%c : logger的名称(%logger)
%t : 输出当前线程名称
%p : 日志输出格式
%m : 日志内容，即 logger.info("message")
%n : 换行符
%C : Java类名(%F)
%L : 行号
%M : 方法名
%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
hostName : 本地机器名
hostAddress : 本地ip地址

Policy触发策略：

SizeBasedTriggeringPolicy
基于日志文件大小的触发策略。单位有：KB，MB，GB
<SizeBasedTriggeringPolicy size="1KB"/>

CronTriggeringPolicy
基于Cron表达式的触发策略，很灵活。
<CronTriggeringPolicy schedule="0/5 * * * * ?" />   每5秒执行一次

TimeBasedTriggeringPolicy
<TimeBasedTriggeringPolicy/>

基于时间的触发策略。该策略主要是完成周期性的log文件封存工作。有两个参数：

interval，integer型，指定两次封存动作之间的时间间隔。这个配置需要和filePattern结合使用，filePattern日期格式精确到哪一位，interval也精确到哪一个单位。注意filePattern中配置的文件重命名规则是%d{yyyy-MM-dd HH-mm-ss}-%i，最小的时间粒度是ss，即秒钟。
TimeBasedTriggeringPolicy默认的size是1，结合起来就是每1秒钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件

log4j2 自带过滤日志： 

<!--log4j2 自带过滤日志-->
      <Logger name="org.apache.catalina.startup.DigesterFactory" level="error" />
      <Logger name="org.apache.catalina.util.LifecycleBase" level="error" />
      <Logger name="org.apache.coyote.http11.Http11NioProtocol" level="warn" />
      <logger name="org.apache.sshd.common.util.SecurityUtils" level="warn"/>
      <Logger name="org.apache.tomcat.util.net.NioSelectorPool" level="warn" />
      <Logger name="org.crsh.plugin" level="warn" />
      <logger name="org.crsh.ssh" level="warn"/>
      <Logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="error" />
      <Logger name="org.hibernate.validator.internal.util.Version" level="warn" />
      <logger name="org.springframework.boot.actuate.autoconfigure.CrshAutoConfiguration" level="warn"/>
      <logger name="org.springframework.boot.actuate.endpoint.jmx" level="warn"/>
      <logger name="org.thymeleaf" level="warn"/>

5.使用$加载配置

1.date

用于插入时间,例如$(date:yyyy-MM-dd),在log4j2.xml中对filePattern

2.sys

java获取的属性（System properties）。例如：${sys:user.dir}

 3.env

获取系统环境变量。例如：${env:appname}

 4.使用$获取自定义属性

获取在Properties标签中定义自己的属性。例如：${logpath}

6. log4j2.xml 使用 application.yml 属性 

        log4j2.xml不是 spring 管理的，所以没法读取到 application.yml 里面的配置了。 
解决方式： 通过 spring 的 监听器(Listener)功能再设置系统属性System.setProperty()。 

@Component
public class LoggingListener implements ApplicationListener<ApplicationEvent>, Ordered {
 
 
    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {
 
        if (applicationEvent instanceof ApplicationEnvironmentPreparedEvent) {
            ConfigurableEnvironment environment = ((ApplicationEnvironmentPreparedEvent) applicationEvent).getEnvironment();
            String filePath = environment.getProperty("myproperty");
            if (StringUtils.isNotEmpty(filePath)) {
                System.err.println("=================" + filePath);
                System.setProperty("myproperty", filePath);
            }
        }
    }
 
    @Override
    public int getOrder() {
        // 当前监听器的启动顺序需要在日志配置监听器的前面，所以此处减 1
        return LoggingApplicationListener.DEFAULT_ORDER - 1;
    }
 
}

7.Log4j2异步日志

        Log4j2中的异步日志实现方式有AsyncAppender和AsyncLogger两种。其中，AsyncAppender采用了ArrayBlockingQueue来保存需要异步输出的日志事件；AsyncLogger则使用了Disruptor框架来实现高吞吐。

AsyncAppender 会调用到： org.apache.logging.log4j.core.appender.AsyncAppender#append AsyncLogger会调用到： org.apache.logging.log4j.core.async.AsyncLoggerConfig#log

7.1 AsyncAppender

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
  <Appenders>
	<!--error及更高级别日志  同步Appender-->
        <RollingFile name="errorFileAppender"
                     fileName="${LOG_HOME}/error.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
            <!--设置日志格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>
		
    <Async name="Async_errorFileAppender">
      <AppenderRef ref="errorFileAppender"/>
    </Async>
  </Appenders>
  
  
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Async_errorFileAppender"/>
    </Root>
  </Loggers>
</Configuration>

AsyncAppender的常用参数

参数名	类型	说明
name	String	Async Appender的名字。
AppenderRef	String	异步调用的Appender的名字，可以配置多个。
blocking	boolean	默认为true。如果为true，appender将一直等待直到queue中有空闲；如果为false，当队列满的时候，日志事件将被丢弃。(如果配置了error appender，要丢弃的日志事件将由error appender处理)
bufferSize	integer	队列中可存储的日志事件的最大数量，默认为128。(源码中为128，Log4j2官网为1024，官网信息有误)

7.2  AsyncLogger

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="debug" name="MyApp" packages="">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <RollingFile name="RollingFile" fileName="logs/app.log"
                     filePattern="logs/app-%d{yyyy-MM-dd HH}.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="500MB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
	 <!--过滤掉springboot的一些无用的DEBUG信息-->
        <AsyncLogger name="org.springframework" level="info" additivity="false">
            <appender-ref ref="RollingFile"/>
        </AsyncLogger>
		
        <Root level="debug">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="RollingFile"/>
        </Root>
    </Loggers>
</Configuration>