log4j.xml / logback.xml

发表于2022年3月24日由kaisin

一、Log4j2介绍

  Log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为".xml",".json"或者".jsn"。

  • 配置文件的格式：log2j配置文件可以是xml格式的，也可以是json格式的。
  • 配置文件的位置：log4j2默认会在classpath目录下寻找log4j2.xml、log4j.json、log4j.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.

二、配置文件节点解析

(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.
  • Patt　ernLayout:输出格式，不设置默认为:%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属性)。
  • ThresholdFilter属性：onMatch表示匹配设定的日志级别后是DENY还是ACCEPT，onMismatch表示不匹配设定的日志级别是DENY还是ACCEPT还是NEUTRAL

(3).Loggers节点

常见的有两种:Root和Logger.

  • Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
  • level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
  • 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:最高等级的，用于关闭所有日志记录.
  • 　　程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。
  • 配置参数解释
  • %d{HH:mm:ss.SSS} 表示输出到毫秒的时间
  • %t 输出当前线程名称
%-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0

三、Maven依赖

<dependencies>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-api</artifactId>  
        <version>2.5</version>  
    </dependency>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-core</artifactId>  
        <version>2.5</version>  
    </dependency> 
</dependencies>

使用SLF4J + LOG4J配置时，可以简化到仅一个依赖：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.20.0</version>
</dependency>

使用SLF4J + LOGBACK配置时，可以简化到仅一个依赖：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
<!--    <version>1.3.6</version> -->
    <version>1.2.11</version>
</dependency>

注意选用1.3.x/1.2.x版本，不要使用1.4.0, 1.4.x 版本出现UnsupportedClassVersionError异常。
目前 Logback 发布了 1.3 & 1.4 两个版本，logback 1.3.x 支持 Java EE 版本，而 logback 1.4.x 支持 Jakarta EE，两个版本的功能相同。

在springboot中使用log4j2时，需要排除springboot默认的logback

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

 

四、LOG4J基础配置

<?xml version="1.0" encoding="UTF-8"?>
 <Configuration>
   <Appenders>
     <Console name="Console" target="SYSTEM_OUT">
       <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %level %logger{1.} - %msg%n"/>
     </Console>
   </Appenders>
   <Loggers>
     <Root level="error">
       <AppenderRef ref="Console"/>
     </Root>
   </Loggers>
 </Configuration>

五、LOG4J较全配置

<?xml version="1.0" encoding="UTF-8"?>
<!--
日志级别以及优先级排序:
OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL
-->
<configuration status="WARN" monitorInterval="30">
    <Properties>
        <!--        <Property name="LOG_ROOT">${sys:user.home}/logs</Property>-->
        <Property name="LOG_ROOT">./logs</Property>
        <Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss,SSS} %level [%thread] %logger{1.} - %msg%n</Property>
    </Properties>
    <!--定义appender-->
    <appenders>
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </console>
        <RollingFile name="info" fileName="${LOG_ROOT}/info.log"
                     filePattern="${LOG_ROOT}/$${date:yyyyMM}/info-%d{yyyyMMdd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="1024 MB"/>
            </Policies>
        </RollingFile>
        <RollingFile name="warn" fileName="${LOG_ROOT}/warn.log"
                     filePattern="${LOG_ROOT}/$${date:yyyyMM}/warn-%d{yyyyMMdd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="1024 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="error" fileName="${LOG_ROOT}/error.log"
                     filePattern="${LOG_ROOT}/$${date:yyyyMM}/error-%d{yyyyMMdd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="1024 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <loggers>
        <!-- OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
        <!--过滤 spring mybatis 的 DEBUG 信息-->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <root level="INFO">
            <appender-ref ref="Console"/>
            <appender-ref ref="info"/>
            <appender-ref ref="warn"/>
            <appender-ref ref="error"/>
        </root>
    </loggers>
</configuration>

 

六、LOGBACK配置

logback.xml or logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志存放路径 -->
    <property name="log.path" value="./logs"/>
    <!-- 日志天数 -->
    <property name="log.history" value="60"/>
    <!-- 日志轮转大小 -->
    <property name="log.size" value="1024MB"/>
    <!-- 日志输出格式 -->
    <!--    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n" />-->
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p [%15.15t] %-40.40logger{30} : %m%n"/>

    <!-- 控制台输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- 系统日志输出 -->
    <!-- ch.qos.logback.classic.AsyncAppender -->
    <appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/info.log</file>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/info-%d{yyyyMMdd}.%i.log</fileNamePattern>
            <maxHistory>${log.history}</maxHistory>
            <maxFileSize>${log.size}</maxFileSize>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 用户访问日志输出  -->
    <appender name="warn" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/warn.log</file>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn-%d{yyyyMMdd}.%i.log</fileNamePattern>
            <maxHistory>${log.history}</maxHistory>
            <maxFileSize>${log.size}</maxFileSize>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/error.log</file>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error-%d{yyyyMMdd}.%i.log</fileNamePattern>
            <maxHistory>${log.history}</maxHistory>
            <maxFileSize>${log.size}</maxFileSize>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日志级别  -->
    <logger name="org.springframework" level="warn"/>
    <logger name="org.mybatis" level="INFO"/>

    <!-- OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <springProfile name="default">
        <root level="INFO">
            <appender-ref ref="console"/>
            <appender-ref ref="info"/>
            <appender-ref ref="warn"/>
            <appender-ref ref="error"/>
        </root>
    </springProfile>

    <springProfile name="beta,test">
        <root level="INFO">
            <appender-ref ref="console"/>
            <appender-ref ref="info"/>
            <appender-ref ref="warn"/>
            <appender-ref ref="error"/>
        </root>
    </springProfile>

    <springProfile name="prod">
        <root level="WARN">
            <appender-ref ref="console"/>
            <appender-ref ref="info"/>
            <appender-ref ref="warn"/>
            <appender-ref ref="error"/>
        </root>
    </springProfile>

</configuration>

 

备注：内容摘自网络，有问题联系我们删除或修改。

.

此条目发表在java分类目录。将固定链接加入收藏夹。