l配置log4j完成日志输出与配置文件log4j2.xml详解

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/chenaini119/article/details/81775157

一、配置文件节点解析

　　
(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:最高等级的，用于关闭所有日志记录.
程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

二.比较完整的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>

三、项目配置

1、配置web.xml

<servlet>
    <servlet-name>BaseServlet</servlet-name>
    <servlet-class>yzx.sv.lt.BaseServelt.BaseServlet</servlet-class>
    <init-param>
        <param-name>log4j-xml-path</param-name>
        <param-value>/WEB-INF/classes/conf/log4j/log4j.xml</param-value>
    </init-param>
    <load-on-startup>2</load-on-startup>
</servlet>

2、完成servlet init（）读取配置

package yzx.sv.lt.BaseServelt;

import org.apache.log4j.xml.DOMConfigurator;
import org.springframework.web.context.support.WebApplicationContextUtils;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

public class BaseServlet extends HttpServlet {

    public void init() throws ServletException {
        super.init();
                //完成log4j配置
        String prefix = getServletContext().getRealPath("/");
        String xml = getInitParameter("log4j-xml-path");
        if (xml != null) {
            DOMConfigurator.configure(prefix + xml);
        }


    }

}

3、配置log4j.xml

<?xml version="1.0" encoding="UTF-8" ?>    
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
   <!-- ========================== 自定义输出格式说明================================ -->
   <!-- %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL -->
   <!-- #%r 输出自应用启动到输出该log信息耗费的毫秒数  -->
   <!-- #%c 输出所属的类目，通常就是所在类的全名 -->
   <!-- #%t 输出产生该日志事件的线程名 -->
   <!-- #%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” -->
   <!-- #%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22:10:28,921  -->
   <!-- #%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)  -->
   <!-- ========================================================================== -->

   <!-- ========================== 输出方式说明================================ -->
   <!-- Log4j提供的appender有以下几种:  -->  
   <!-- org.apache.log4j.ConsoleAppender(控制台),  -->
   <!-- org.apache.log4j.FileAppender(文件),  -->
   <!-- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), -->
   <!-- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),  -->
   <!-- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)   -->
   <!-- ========================================================================== -->
   <!-- 输出日志到控制台 ConsoleAppender -->
   <appender name="console" class="org.apache.log4j.ConsoleAppender">
      <param name="Threshold" value="DEBUG"></param>
      <layout class="org.apache.log4j.TTCCLayout">
         <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %l %m%n" />
      </layout>
   </appender>

   <!-- info级别日志滚动文件，文件大小到达指定尺寸的时候产生一个新的文件 -->
   <appender name="debugRollingFile" class="org.apache.log4j.RollingFileAppender">
      <!-- 设置File参数：日志输出文件名 -->
      <param name="File" value="/LOG4J/logs/debug.log"></param>
      <!-- 输出到日志文件的日志门槛（级别） -->
      <param name="Threshold" value="debug"></param>
      <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
      <param name="Append" value="true"></param>
      <!-- 设置文件大小 -->
      <param name="MaxFileSize" value="1MB"></param>
      <!-- 设置文件备份个数 -->
      <param name="MaxBackupIndex" value="10"></param>
      <!-- 设置输出文件项目和格式 -->
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %l %m%n" />
      </layout>
   </appender>

   <!-- info级别日志滚动文件，文件大小到达指定尺寸的时候产生一个新的文件 -->
   <appender name="infoRollingFile" class="org.apache.log4j.RollingFileAppender">
      <!-- 设置File参数：日志输出文件名 -->
      <param name="File" value="/LOG4J/logs/info.log"></param>
      <!-- 输出到日志文件的日志门槛（级别） -->
      <param name="Threshold" value="INFO"></param>
      <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
      <param name="Append" value="true"></param>
      <!-- 设置文件大小 -->
      <param name="MaxFileSize" value="1MB"></param>
      <!-- 设置文件备份个数 -->
      <param name="MaxBackupIndex" value="10"></param>
      <!-- 设置输出文件项目和格式 -->
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %l %m%n" />
      </layout>
   </appender>

   <!-- error级别日志滚动文件，文件大小到达指定尺寸的时候产生一个新的文件 -->
   <appender name="errorRollingFile" class="org.apache.log4j.RollingFileAppender">
      <!-- 设置File参数：日志输出文件名 -->
      <param name="File" value="/LOG4J/logs/error.log"></param>
      <!-- 输出到日志文件的日志门槛（级别） -->
      <param name="Threshold" value="ERROR"></param>
      <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
      <param name="Append" value="true"></param>
      <!-- 设置文件大小 -->
      <param name="MaxFileSize" value="1MB"></param>
      <!-- 设置文件备份个数 -->
      <param name="MaxBackupIndex" value="10"></param>
      <!-- 设置输出文件项目和格式 -->
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %l %m%n" />
      </layout>
   </appender>

   <!-- 定义全局的日志输出级别,但是在输出目的地的配置中配置的具体输出级别优先级高于全局定义的优先级。-->
   <!-- 如果在rollingFile中定义<param name="Threshold" value="info" />，那么将会把info以上级别的信息输出 -->
   <root>
      <priority value="DEBUG" />
      <appender-ref ref="console" />
      <appender-ref ref="debugRollingFile" />
      <appender-ref ref="infoRollingFile" />
      <appender-ref ref="errorRollingFile" />
   </root>

</log4j:configuration>