SpringBoot之log4j2日志自定义配置指南

2024-01-25 21:49:47

使用log4j2在Spring Boot中记录日志的完整指南

简介

Spring Boot是一款流行的Java框架，它简化了Spring应用的开发过程。log4j2是SpringBoot的默认日志框架，它提供了丰富的日志功能和强大的日志管理能力。本文将深入探讨log4j2，指导你完成配置、使用和自定义步骤，让你能够有效地管理应用程序日志。

配置log4j2

1. 添加log4j2依赖

在项目的pom.xml文件中添加以下依赖：

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

2. 配置log4j2配置文件

在项目根目录下创建log4j2.xml配置文件，添加以下内容：

<?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>
    <File name="FILE" fileName="logs/mylog.log">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </File>
  </Appenders>
  <Loggers>
    <Root level="INFO">
      <AppenderRef ref="CONSOLE"/>
      <AppenderRef ref="FILE"/>
    </Root>
  </Loggers>
</Configuration>

log4j2日志级别

log4j2提供了多种日志级别，包括：

TRACE ：最详细的日志级别，记录应用程序的详细执行过程。
DEBUG ：记录应用程序的调试信息，帮助开发人员发现问题。
INFO ：记录应用程序的重要信息，如启动、停止、错误等。
WARN ：记录应用程序的警告信息，如潜在的错误或问题。
ERROR ：记录应用程序的错误信息，如未处理的异常或故障。
FATAL ：记录应用程序的致命错误信息，如系统崩溃或数据丢失。

log4j2日志输出格式

log4j2允许您自定义日志输出格式，常用的格式包括：

%d{yyyy-MM-dd HH:mm:ss.SSS}：日志时间，格式为年-月-日 时:分:秒.毫秒
%t：线程名称
%-5level：日志级别，左对齐，宽度为5个字符
%logger{36}：日志记录器的名称，左对齐，宽度为36个字符
- %msg%：日志消息
%n：换行符

log4j2日志文件滚动策略

log4j2提供了多种日志文件滚动策略，常用的策略包括：

SizeBasedTriggeringPolicy ：当日志文件达到指定大小时，滚动日志文件。
TimeBasedTriggeringPolicy ：当日志文件达到指定时间时，滚动日志文件。
CompositeTriggeringPolicy ：将多种滚动策略组合在一起使用。

使用示例

在项目中使用log4j2非常简单，您只需要在代码中添加以下代码即可：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyClass {
  private static final Logger logger = LoggerFactory.getLogger(MyClass.class);

  public void doSomething() {
    logger.info("This is an info message.");
    logger.warn("This is a warn message.");
    logger.error("This is an error message.");
  }
}

常见问题解答

如何修改日志级别？

编辑log4j2.xml配置文件，在元素中设置desired级别，如：
```
<Root level="DEBUG">
```
如何添加自定义日志输出格式？

在log4j2.xml配置文件的元素中定义自定义模式，如：
```
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg% %n"/>
```

如何设置日志文件滚动策略？

在log4j2.xml配置文件的元素中添加元素，并指定desired策略，如：

<File name="FILE" fileName="logs/mylog.log">
  <RollingFile sizeBasedTriggeringPolicy="SizeBasedTriggeringPolicy{size=1MB}"/>
  <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg% %n"/>
</File>

如何禁用log4j2？

删除项目中的log4j2依赖，并从项目根目录中删除log4j2.xml配置文件。
如何排除特定包或类的日志？

在log4j2.xml配置文件中添加元素，并指定要排除的包或类，如：
```
<Logger name="com.example.mypackage" level="OFF"/>
```