Log4j2是Apache推出的高性能日志框架,支持通过xml格式的配置文件定义日志的输出规则、格式、级别等内容,灵活度远高于properties配置方式。掌握Log4j2的xml配置文件写法,能更好地适配不同项目的日志需求。

Log4j2.xml核心配置结构
完整的Log4j2.xml配置文件主要由<Configuration>根标签包裹,内部包含<Properties>、<Appenders>、<Loggers>三个核心部分,每个部分承担不同的配置职责。
1. Properties配置段
该部分用于定义全局可复用的变量,比如日志文件路径、日志格式模板等,后续配置可以通过${变量名}的方式引用,减少重复配置。
2. Appenders配置段
Appenders用于定义日志的输出目的地,常见的输出类型包括控制台、文件、滚动文件等,每个Appender需要指定名称、输出类型、输出格式等属性。
3. Loggers配置段
Loggers用于定义日志记录器,包括Root根日志器和自定义Logger,每个Logger可以关联对应的Appender,并指定该Logger的日志输出级别。
完整配置示例
以下是一个适配普通Java项目的Log4j2.xml完整配置示例,包含控制台输出和按天滚动的文件输出两种规则:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<!-- 全局变量定义 -->
<Properties>
<Property name="LOG_PATH">./logs</Property>
<Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Property>
</Properties>
<Appenders>
<!-- 控制台输出Appender -->
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="${LOG_PATTERN}"/>
</Console>
<!-- 滚动文件输出Appender -->
<RollingFile name="RollingFile" fileName="${LOG_PATH}/app.log"
filePattern="${LOG_PATH}/app-%d{yyyy-MM-dd}.log.gz">
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="100MB"/>
</Policies>
<DefaultRolloverStrategy max="30"/>
</RollingFile>
</Appenders>
<Loggers>
<!-- 自定义Logger,指定特定包的日志级别 -->
<Logger name="com.example" level="debug" additivity="false">
<AppenderRef ref="Console"/>
<AppenderRef ref="RollingFile"/>
</Logger>
<!-- Root根日志器 -->
<Root level="info">
<AppenderRef ref="Console"/>
<AppenderRef ref="RollingFile"/>
</Root>
</Loggers>
</Configuration>
核心配置项说明
- status属性:<Configuration>标签的status属性用于设置Log4j2框架自身的日志输出级别,设置为WARN可以避免框架冗余日志输出。
- PatternLayout:用于定义日志的输出格式,%d表示时间,%t表示线程名,%-5level表示日志级别,%logger表示类名,%msg表示日志内容,%n表示换行。
- TimeBasedTriggeringPolicy:时间触发策略,interval="1"表示每天滚动一次日志文件。
- SizeBasedTriggeringPolicy:大小触发策略,size="100MB"表示单个日志文件达到100MB时触发滚动。
- additivity属性:自定义Logger的additivity设为false时,日志不会向上传递给Root日志器,避免重复输出。
注意事项
配置文件需要放在项目的classpath路径下,比如Maven项目的src/main/resources目录,Log4j2会自动加载该路径下的log4j2.xml文件。如果需要自定义配置文件路径,可以通过系统参数log4j2.configurationFile指定配置文件的绝对路径。另外,日志级别从低到高依次为trace、debug、info、warn、error、fatal,只有级别不低于Logger设置级别的日志才会被输出。