log4j2基础讲解

1. 配置文件加载顺序

log4j会按照以下顺序寻找classpath的配置文件：

1. log4j2-test.properties
2. log4j2-test.yaml or log4j2-test.yml
3. log4j2-test.json or log4j2-test.jsn
4. log4j2-test.xml
5. log4j2.properties
6. log4j2.yaml or log4j2.yml
7. log4j2.json or log4j2.jsn
8. log4j2.xml

2. 配置文件节点解析

2.1 根节点Configuration

根节点Configuration有两个属性: status和monitorinterval

• status用来指定log4j本身的打印日志的级别.
• monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.

2.2 子节点 Appenders

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

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

• 属性
  • name: 指定Appender的名字.
  • target: SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
• 子节点
  • PatternLayout子节点: 输出格式，不设置默认为:%m%n.

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

• 属性
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
• 子节点
  • PatternLayout:输出格式，不设置默认为:%m%n.

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

• 属性
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • filePattern:指定新建日志文件的名称格式.
• 子节点
  • PatternLayout:输出格式，不设置默认为:%m%n.
  • Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
    • TimeBasedTriggeringPolicy: Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.
    • SizeBasedTriggeringPolicy: Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
  • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

2.3 Loggers节点，常见的有两种:Root和Logger.

2.3.1. Root节点

• Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
  • 属性
    • level:日志输出级别，共有8个级别，详情见2.4.
  • 子节点
    • AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

2.3.2. Logger节点

• Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
  • 属性
    • level:日志输出级别，共有8个级别，详情见2.4：
    • name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
  • 子节点
    • AppenderRef：用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity=”false”只在自定义的Appender中进行输出。

2.4 日志level

• 共有8个级别，按照从低到高为：

  All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

1. All:最低等级的，用于打开所有日志记录.
2. Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
3. Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
4. Info:消息在粗粒度级别上突出强调应用程序的运行过程.
5. Warn:输出警告及warn以下级别的日志.
6. Error:输出错误信息日志.
7. Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
8. OFF:最高等级的，用于关闭所有日志记录.

注意；程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

3. 比较完整的log4j2.xml配置模板

<?xml version="1.0" encoding="UTF-8"?>

<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="OFF" monitorInterval="10">
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <Console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%-5level] [%t] - %l - %m%n"/>
        </Console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="logs/test.log" append="false">
            <PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5level] [%t] - %l - %m%n"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="logs/info.log"
                     filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFileWarn" fileName="logs/warn.log"
                     filePattern="logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="logs/error.log"
                     filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss,SSS}] [%-5level] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="WARN"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <logger name="com.bin.controller" level="INFO" includeLocation="true" additivity="false">
            <appender-ref ref="log"/>
            <appender-ref ref="Console"/>
        </logger>
        <root level="INFO" includeLocation="true">
            <appender-ref ref="Console"/>
            <appender-ref ref="log"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>