log4j2配置文件log4j2.xml

一、背景

　　最近由于项目的需要，我们把log4j 1.x的版本全部迁移成log4j 2.x 的版本，那随之而来的slf4j整合log4j的配置（使用slf4j集成log4j2构建项目日志系统的完美解决方案）以及log4j2配置文件的详解，就需要我们来好好聊一聊了。本文就专门来讲解下log4j2.xml配置文件的各项标签的意义。

二、配置全解

　　1.关于配置文件的名称以及在项目中的存放位置

　　　　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.配置文件节点解析　　　　

　　　　(1).根节点configuration有两个属性:status和monitorinterval,有两个子节点:appenders和loggers(表明可以定义多个appender和logger).

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

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

　　　　(2).appenders节点，常见的有三种子节点:console、rollingfile、file.

　　　　　　　console节点用来定义输出到控制台的appender.

　　　　　　　　name:指定appender的名字.

　　　　　　　　target:system_out 或 system_err,一般只设置默认:system_out.

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

　　　　　　　file节点用来定义输出到指定位置的文件的appender.

　　　　　　　　name:指定appender的名字.

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

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

　　　　　　　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属性)。

　　　　(3).loggers节点，常见的有两种:root和logger.

　　　　　　　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中进行输出。

　　　　(4).关于日志level.

　　　　　　共有8个级别，按照从低到高为：all < trace < debug < info < warn < error < fatal < off.

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

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

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

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

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

　　　　　　error:输出错误信息日志.

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

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

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

　　4.比较完整的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="warn" monitorinterval="30">
    <!--先定义所有的appender-->
    <appenders>
    <!--这个输出控制台的配置-->
        <console name="console" target="system_out">
        <!--输出日志的格式-->
            <patternlayout pattern="[%d{hh:mm:ss:sss}] [%p] - %l - %m%n"/>
        </console>
    <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
    <file name="log" filename="log/test.log" append="false">
       <patternlayout pattern="%d{hh:mm:ss.sss} %-5level %class{36} %l %m - %msg%xex%n"/>
    </file>
    <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <rollingfile name="rollingfileinfo" filename="${sys:user.home}/logs/info.log"
                     filepattern="${sys:user.home}/logs/$${date:yyyy-mm}/info-%d{yyyy-mm-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->        
            <thresholdfilter level="info" onmatch="accept" onmismatch="deny"/>
            <patternlayout pattern="[%d{hh:mm:ss:sss}] [%p] - %l - %m%n"/>
            <policies>
                <timebasedtriggeringpolicy/>
                <sizebasedtriggeringpolicy size="100 mb"/>
            </policies>
        </rollingfile>
        <rollingfile name="rollingfilewarn" filename="${sys:user.home}/logs/warn.log"
                     filepattern="${sys:user.home}/logs/$${date:yyyy-mm}/warn-%d{yyyy-mm-dd}-%i.log">
            <thresholdfilter level="warn" onmatch="accept" onmismatch="deny"/>
            <patternlayout pattern="[%d{hh:mm:ss:sss}] [%p] - %l - %m%n"/>
            <policies>
                <timebasedtriggeringpolicy/>
                <sizebasedtriggeringpolicy size="100 mb"/>
            </policies>
        <!-- defaultrolloverstrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <defaultrolloverstrategy max="20"/>
        </rollingfile>
        <rollingfile name="rollingfileerror" filename="${sys:user.home}/logs/error.log"
                     filepattern="${sys:user.home}/logs/$${date:yyyy-mm}/error-%d{yyyy-mm-dd}-%i.log">
            <thresholdfilter level="error" onmatch="accept" onmismatch="deny"/>
            <patternlayout pattern="[%d{hh:mm:ss:sss}] [%p] - %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="info"></logger>
        <logger name="org.mybatis" level="info"></logger>
        <root level="all">
            <appender-ref ref="console"/>
            <appender-ref ref="rollingfileinfo"/>
            <appender-ref ref="rollingfilewarn"/>
            <appender-ref ref="rollingfileerror"/>
        </root>
    </loggers>
</configuration>