SpringBoot 使用 log4j2

一、新建工程

选择一些基础依赖 填写工程名称和项目路径

二、工程配置

修改文件编码格式 设置Java Compiler 修改maven配置文件路径

三、pom.xml的web依赖中排除掉logging依赖，并且引入log4j2依赖

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!-- 排除掉logging，不使用logback，改用log4j2 --> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <!-- log4j2 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>

四、springboot配置

logging: config: classpath:log4j2.xml

五、log4j2配置文件

<configuration status="OFF" monitorInterval="30"> <Properties> <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss,SSS}|%p|%c|%L|%m%n</Property> <Property name="logPath">logs</Property> </Properties> <Appenders> <!--设置在控制台打印日志--> <Console name="console" target="SYSTEM_OUT"> <PatternLayout pattern="${pattern}"/> </Console> <!--设置级别为 DEBUG 日志输出到 debug.log 中--> <RollingRandomAccessFile name="debug" immediateFlush="false" fileName="${logPath}/debug.log" filePattern="${logPath}/debug-%d{yyyy-MM-dd}.log"> <Filters> <!--设置只输出级别为 debug 的日志--> <ThresholdFilter level="DEBUG"/> <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <PatternLayout pattern="${pattern}"/> <Policies> <!-- 按天生成日志文件--> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <!-- 最多保存日志文件的数目 --> <DefaultRolloverStrategy max="15"/> </RollingRandomAccessFile> <RollingRandomAccessFile name="info" immediateFlush="false" fileName="${logPath}/info.log" filePattern="${logPath}/info-%d{yyyy-MM-dd}.log"> <Filters> <ThresholdFilter level="INFO"/> <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <PatternLayout pattern="${pattern}"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <DefaultRolloverStrategy max="60"/> </RollingRandomAccessFile> <RollingRandomAccessFile name="warn" immediateFlush="false" fileName="${logPath}/warn.log" filePattern="${logPath}/warn-%d{yyyy-MM-dd}.log"> <Filters> <ThresholdFilter level="WARN"/> <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <PatternLayout pattern="${pattern}"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <DefaultRolloverStrategy max="60"/> </RollingRandomAccessFile> <RollingRandomAccessFile name="error" immediateFlush="false" fileName="${logPath}/error.log" filePattern="${logPath}/error-%d{yyyy-MM-dd}.log"> <PatternLayout pattern="${pattern}"/> <Filters> <ThresholdFilter level="ERROR"/> </Filters> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <DefaultRolloverStrategy max="60"/> </RollingRandomAccessFile> <!-- 设置 task_suc 日志 --> <RollingRandomAccessFile name="task_suc" immediateFlush="false" fileName="${logPath}/task_suc.log" filePattern="${logPath}/task_suc-%d{yyyy-MM-dd}.log"> <PatternLayout pattern="${pattern}"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <DefaultRolloverStrategy max="90"/> </RollingRandomAccessFile> <!-- 设置 task_fail 日志 --> <RollingRandomAccessFile name="task_fail" immediateFlush="false" fileName="${logPath}/task_fail.log" filePattern="${logPath}/task_fail-%d{yyyy-MM-dd}.log"> <PatternLayout pattern="${pattern}"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <DefaultRolloverStrategy max="90"/> </RollingRandomAccessFile> </Appenders> <Loggers> <Logger name="com.example.log4j2demo" level="DEBUG" additivity="true"> <AppenderRef ref="debug"/> <AppenderRef ref="info"/> <AppenderRef ref="warn"/> <AppenderRef ref="error"/> </Logger> <!-- org.springframework 只输出 ERROR 级别以上的日志 --> <Logger name="org.springframework" level="ERROR"/> <!-- org.apache 只输出 ERROR 级别以上的日志 --> <Logger name="org.apache" level="ERROR"/> <!-- task_suc 日志 --> <Logger name="task_suc" additivity="true"> <AppenderRef ref="task_suc"/> </Logger> <!-- task_fail 日志 --> <Logger name="task_fail" additivity="true"> <AppenderRef ref="task_fail"/> </Logger> <Root level="DEBUG"> <AppenderRef ref="console"/> </Root> </Loggers> </configuration>

---

注：

1、configuration 标签

<!-- status 级别有8个：ALL,TRACE, DEBUG, INFO, WARN, ERROR ,FATAL,OFF。是帮助开发者找错用的，它可以检测log4j 2的配置文件是否有错，也可以检测到死循环的logger monitorInterval log4j2 自动检测配置文件的时间间隔（单位：秒） --> <configuration status="OFF" monitorInterval="30">

2、Console标签

<!-- 设置在控制台打印日志 将输出写到 System.err 或 System.out 。如果想将输出写到System.out，设置Console标签下的target为 SYSTEM_OUT ；如果想将输出写到System.err，设置Console标签下的target为 SYSTEM_ERR --> <Console name="console" target="SYSTEM_OUT"> <PatternLayout pattern="${pattern}"/> </Console>

3、日志输出格式

<!-- 日志输出格式，每个转换说明符以百分号(%)开头，'%'后面的转换字符有如下: p (level) 日志级别 c（logger） Logger的Name C (class) Logger调用者的全限定类名 d (date) 日期 highlight 高亮颜色 l (location) 调用位置 L (line) 行号 m (msg/message) 输出的内容 M (methode) 调用方法 *** maker marker的全限定名 n 输出平台相关的换行符,如'\n' '\r\n' pid (processId) 进程ID level （p）日志级别 r JVM启动后经过的微秒 t (tn/thread/threadName) 线程名称 T (tid/threadId) 线程ID tp (threadPriority) 线程优先级 x (NDC) 线程Context堆栈 --> <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss,SSS}|%p|%c|%L|%m%n</Property>

4、RollingRandomAccessFile 标签

<!-- 设置级别为 DEBUG 日志输出到 debug.log 中 日志写入策略 immediateFlush log4j2接收到日志事件时，是否立即将日志刷到磁盘。默认为true 。 异步日志将会自动批量刷新到磁盘，所以这里设置为false --> <RollingRandomAccessFile name="debug" immediateFlush="false" fileName="${logPath}/debug.log" filePattern="${logPath}/debug-%d{yyyy-MM-dd}.log"> <Filters> <!--设置只输出级别为 debug 的日志--> <ThresholdFilter level="DEBUG"/> <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <PatternLayout pattern="${pattern}"/> <Policies> <!-- 根据时间生成日志文件 单位：以文件命名中的时间精度来确定单位。比如 yyyy-MM-dd 单位为天，yyyy-MM-dd-HH 单位为小时 interval：时间间隔 --> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> </Policies> <!-- 最多保存日志文件的数目 --> <DefaultRolloverStrategy max="15"/> </RollingRandomAccessFile>

RollingRandomAccessFile 为异步日志，RollingFile 为同步日志。

5、Logger 标签

<!-- 整个工程默认日志实例，name=工程名，例如用@Slf4j这个注解或者LoggerFactory.getLogger(XXX.class)的日志实例 --> <Logger name="com.example.log4j2demo" level="DEBUG" additivity="true"> <AppenderRef ref="debug"/> <AppenderRef ref="info"/> <AppenderRef ref="warn"/> <AppenderRef ref="error"/> </Logger>

六、使用示例

@Slf4j @SpringBootTest class Log4j2DemoApplicationTests { private static final Logger sucLog = LoggerFactory.getLogger("task_suc"); private static final Logger failLog = LoggerFactory.getLogger("task_fail"); private static final Logger sysLog = LoggerFactory.getLogger(Log4j2DemoApplicationTests.class); @Test void log4j2() { sucLog.debug("task_suc debug"); sucLog.info("task_suc info"); sucLog.warn("task_suc warn"); sucLog.error("task_suc error"); failLog.debug("task_fail debug"); failLog.info("task_fail info"); failLog.warn("task_fail warn"); failLog.error("task_fail error"); log.debug("normal debug"); log.info("normal info"); log.warn("normal warn"); log.error("normal error"); sysLog.debug("sys debug"); sysLog.info("sys info"); sysLog.warn("sys warn"); sysLog.error("sys error"); } }

控制台输出结果：

日志文件：