log4j2经验总结

---
title: log4j2经验总结
tags:日志 springboot
grammar_cjkRuby: true
---
## log4j2介绍
### 优点：
- 重新配置不会失去事件，具有比logback、log4j 1.x版本跟大的吞吐量  
- Log4j 2在稳定记录状态下，对单机应用是无垃圾的，对Web应用是低垃圾的。这不仅降低了垃圾回收器的压力，还可以提供更好的响应性能。
- 支持自定义日志级别。自定义日志级别可以在代码或配置中定义
- 支持Lambda表达式

## 配置
### 一、配置文件存放位置

**Tips** 
log4j 2.0与以往的1.x有一个明显的不同，其配置文件只能采用 ==.xml==, ==.json==或者 ==.jsn== 作为后缀名，***不支持*** ==.properties #ff0000==

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

- .classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
- .classpath下的名为log4j2-test.xml的文件.
- .classpath下名为log4j2.json 或者log4j2.jsn的文件.
- .classpath下名为log4j2.xml的文件.

springboot项目可以参照我的，将配置文件命名为log4j2.xml放在classpath下

### 二、配置文件解析
#### 根节点：Configuration
根节点有两个属性：status和monitorinterval，两个子节点：Appenders和Loggers
status 用来指定log4j2本身打印日志的级别
monitorinterval：monitor 监视器 interval 时间间隔。顾名思义，这个属性就是用来指定log4j2自动检测配置的检测时间间隔，单位是==s #ff9800==最小5s
#### Appenders 在这个节点下配置appender
appender就是用来配置日志输出目的地
- **Console**节点用来定义输出到控制台的Appender
    - name:指定Appender的名字
    - target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT
    - PatternLayout:输出格式，不设置默认为:%m%n.
    
        ``` xml
        <!--这个输出控制台的配置-->
        <Console name="Console" target="SYSTEM_OUT">
             <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY" />
            <!-- 输出日志的格式-->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n" />
        </Console>
        ```
- **File**节点用来定义输出到指定位置的文件的Appender
    - name:指定Appender的名字 
    - fileName:指定输出日志的目的文件带全路径的文件名  
    - PatternLayout:输出格式，不设置默认为:%m%n  

- **RollingFile**节点用来定义超过指定大小自动删除旧的创建新的的Appende
    - 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属性)。
    
        ``` xml
         <!--这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
            <RollingFile name="RollingFile" fileName="${backupFilePatch}${fileName}"
                filePattern="${backupFilePatch}$${date:yyyy-MM}/app-%d{yyyyMMddHHmmssSSS}.log.gz">
                <PatternLayout
                    pattern="%d{yyyy.MM.dd 'at' HH:mm:ss.SSS z} %-5level %class{36} %L %M - %msg%xEx%n" />
                <!-- 日志文件大小 -->
                <SizeBasedTriggeringPolicy size="20MB" />
                <!-- 最多保留文件数 -->
                <DefaultRolloverStrategy max="20"/>
            </RollingFile>
        ```
#### Loggers 
**Root**节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
- level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
- AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

**Logger**节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

- level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
- name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点
    - AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

``` xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- log4j2使用说明：
使用方式如下：
private static final Logger logger = LogManager.getLogger(实际类名.class.getName());

2、日志说明：
（1）请根据实际情况配置各项参数
（2）需要注意日志文件备份数和日志文件大小，注意预留目录空间
（3）实际部署的时候backupFilePatch变量需要修改成linux目录
 -->
<configuration status="debug">
    <Properties>
        <Property name="fileName">loginModule.log</Property>
        <Property name="backupFilePatch">D:/workspace/workspace-jee/HelloSpring/hello-spring4/log/</Property>
      </Properties>
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <Console name="Console" target="SYSTEM_OUT">
             <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY" />
            <!-- 输出日志的格式-->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n" />
        </Console>
    </appenders>

    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--建立一个默认的root的logger-->
        <Logger name="org.apache.log4j.xml" level="trace"
            additivity="true">
            <AppenderRef ref="RollingFile" />
        </Logger>
        <Root level="error">
            <AppenderRef ref="Console" />
        </Root>
    </loggers>
</configuration>
``` 
使用maven构建项目引入
```xml
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-log4j2</artifactId>
      <version>2.0.4.RELEASE</version>
    </dependency>
```
在项目中可能会与其他日志包冲突，找到冲突的文件 屏蔽掉即可
``` xml
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <exclusions>
        <exclusion>
          <artifactId>logback-access</artifactId>
          <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
          <artifactId>logback-core</artifactId>
          <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
          <artifactId>logback-classic</artifactId>
          <groupId>ch.qos.logback</groupId>
        </exclusion>
      </exclusions>
    </dependency>
```