【JAVA】Log4j2日志详解

淳于典

2023-12-01

一、log4j2配置详解

项目里使用了log4j2作为日志打印，但是log4j2和log4j相比配置文件有很大的差异，所以这里记录一下配置文件的说明

二、配置解析

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

在查阅资料的时候看到有的博客写的是log4j2的配置文件名是log4j2-spring.xml，但是我测试了一下其实不写这个也可以的。

log4j 2.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 这样就可以测试环境用log4j2-test.xml，正式环境用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`，这里都带着`s`说明可以有多个子节点。

status：用来设置log4j2本身的日志打印级别，也可以不设置，当设置为trace时，就可以看到所有级别的日志
monitorInterval：用于指定log4j自动重新配置的监测时间，设置间隔为秒数，默认为5s

(2). Appenders节点，常见的有三种子节点：`Console`，`RollingFile`和`File`

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

name：指定Appender的名字

target：指定输出模式，一般是SYSTEM_OUT和SYSTEM_ERR，默认为前者。

PatternLayout：输出格式，不设置默认为%m%n
File节点用来定义输出到指定位置的文件Appender

name：指定Appender的名字

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

PatternLayout：输出格式，不设置默认为%m%n
RollingFile节点用来定义超过指定文件大小自动删除旧的创建新的Apender

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

(3). Loggers节点，常见的有两种：`Root` 和 `Logger`

Root节点用来指定项目的根日志，如果没有单独指定Logger，呢么就会使用该Root日志输出输出

level：日志输出级别，共有8个级别

AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender
Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别

level：日志输出级别，共有8个级别

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:最高等级的，用于关闭所有日志记录.

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

5. 样例模板：

<?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">
<!-- 可以设置公共属性 -->
<Properties>
        <property name="logPath">/opt/logs</property>
        <property name="charset">UTF-8</property>
        <property name="pattern">[%d{yyyy-MM-dd HH:mm:ss.SSS}][%-5p] [%t] [%c{1}:%M %L] %m %n</property>
</Properties>
 <!--先定义所有的appender-->
<appenders>
<!--这个输出控制台的配置-->
	<console name="Console" target="SYSTEM_OUT">
	 <!--输出日志的格式 ${pattern}使用属性变量-->
		 <PatternLayout pattern="${pattern}" charset="${charset}"/>
	 </console>
 <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
 <File name="log" fileName="${logPath}/log/test.log" append="false">
	<PatternLayout pattern="${pattern}" charset="${charset}"/>
 </File>
 <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
	 <RollingFile name="RollingFileInfo" fileName="${logPath}/logs/info.log"
				  filePattern="${logPath}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
		 <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->        
		 <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
		 <PatternLayout pattern="${pattern}" charset="${charset}"/>
		 <Policies>
                <!-- 按天分割 -->
                <TimeBasedTriggeringPolicy modulate="true" interval="1" />
                <SizeBasedTriggeringPolicy size="100MB" />
           </Policies>
         <!-- max 最多20个文件  IfLastModified 保留日志的天数 超过30天删除旧的日志  basePath 删除目录 maxDepth 搜索层数-->
         <DefaultRolloverStrategy max="20"> 
                <Delete basePath="${logPath}/logs/$${date:yyyy-MM}/" maxDepth="1">
                    <IfFileName glob="info-*.log" />
                    <IfLastModified age="30d" />
                </Delete>
            </DefaultRolloverStrategy>
	 </RollingFile>
	 <RollingFile name="RollingFileWarn" fileName="${logPath}/logs/warn.log"
				  filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
		<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->  
         <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
		 <PatternLayout pattern="${pattern}" charset="${charset}"/>
		 <Policies>
			  <!-- 按天分割 -->
               <TimeBasedTriggeringPolicy modulate="true" interval="1" />
			 <SizeBasedTriggeringPolicy size="100 MB"/>
		 </Policies>
	 	 <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
		 <DefaultRolloverStrategy max="20"/>
	 </RollingFile>
	 <RollingFile name="RollingFileError" fileName="${logPath}/logs/error.log"
				  filePattern="${logPath}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
		 <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
		 <PatternLayout pattern="${pattern}" charset="${charset}"/>
		 <Policies>
			 <TimeBasedTriggeringPolicy/>
			 <SizeBasedTriggeringPolicy size="100 MB"/>
		 </Policies>
	 </RollingFile>
    	<!-- RollingFileXing日志 com.gitee.xing-->
        <RollingFile name="RollingFileXing" fileName="${logPath}/logs/xing.log"
           filePattern="${logPath}/logs/$${date:yyyy-MM}/xing-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="${pattern}" charset="${charset}"/>
            <Policies>
                <TimeBasedTriggeringPolicy modulate="true" interval="1" /> <!-- 按天分割 -->
                <SizeBasedTriggeringPolicy size="100MB" /> <!-- 按100MB分割 -->
            </Policies>
            <DefaultRolloverStrategy max="20">
                <Delete basePath="${logPath}/logs/$${date:yyyy-MM}/" maxDepth="1">
                    <IfFileName glob="xing-*.log" />
                    <IfLastModified age="30d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
 </appenders>
 <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
 <loggers>
	 <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
	 <logger name="org.springframework" level="INFO"></logger>
     <logger name="org.mybatis" level="INFO"></logger>
     <!-- 设置Logger的additivity="false"只在自定义的Appender中进行输出 -->
     <Logger name="com.gitee.xing" additivity="false" level="INFO">
            <appender-ref ref="audit" level="ALL" />
        </Logger>
	 <root level="all">
		 <appender-ref ref="Console"/>
		 <appender-ref ref="RollingFileInfo"/>
		 <appender-ref ref="RollingFileWarn"/>
		 <appender-ref ref="RollingFileError"/>
	 </root>
 </loggers>
</configuration>

参考文章：https://www.cnblogs.com/hafiz/p/6170702.html

【JAVA】Log4j2日志详解

一、log4j2配置详解

二、配置解析

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

2. 默认配置文件样式

3. 配置文件节点解析

(1). 根节点`Configuration` 有两个属性：`status`和`monitorInterval`，有两个子节点：`Appenders`和`Loggers`，这里都带着`s`说明可以有多个子节点。

(2). Appenders节点，常见的有三种子节点：`Console`，`RollingFile`和`File`

(3). Loggers节点，常见的有两种：`Root` 和 `Logger`

4. 关于日志level

5. 样例模板：

相关阅读

相关文章

相关问答

相关文档

【JAVA】Log4j2日志详解

一、log4j2配置详解

二、配置解析

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

2. 默认配置文件样式

3. 配置文件节点解析

(1). 根节点Configuration 有两个属性：status和monitorInterval，有两个子节点：Appenders和Loggers，这里都带着s说明可以有多个子节点。

(2). Appenders节点，常见的有三种子节点：Console，RollingFile和File

(3). Loggers节点，常见的有两种：Root 和 Logger

4. 关于日志level

5. 样例模板：

相关阅读

相关文章

相关问答

相关文档

(1). 根节点`Configuration` 有两个属性：`status`和`monitorInterval`，有两个子节点：`Appenders`和`Loggers`，这里都带着`s`说明可以有多个子节点。

(2). Appenders节点，常见的有三种子节点：`Console`，`RollingFile`和`File`

(3). Loggers节点，常见的有两种：`Root` 和 `Logger`