Log4j2配置文件XML详解
目前实现日志的常用的框架主要有Log4j2，Logback，Log4j(已经停止更新，它的升级版本Log4j2)，slf4j（只是一个日志标准，并不是日志系统的具体实现）。网上说Log4j2的效率高于Logback，但是具体我没有去深入的了解。关于slf4j整合log4j2可以参考： 使用Slf4j集成Log4j2构建项目日志系统的完美解决方案
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.缺省默认配置文件
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完整的配置文件
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
log4j2 自带过滤日志：
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, 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
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
%d %p %c{1.} [%t] %m%n