【知识总结】使用log4j 2记录Spring Boot应用程序日志

博主： Fivk
发布时间：2024 年 01 月 25 日
1090 次浏览
3434字数
分类：知识总结

引言：

在开发和维护Spring Boot应用程序时，了解和记录应用程序的日志是至关重要的。日志记录可以帮助我们追踪代码的执行过程、排查错误和监控应用程序的运行状态。本文将介绍如何使用log4j 2来记录Spring Boot应用程序的日志，并说明为什么选择log4j 2作为日志记录框架。

</div>

# 一、log4j 2的优势

1. 更新和维护：log4j已经停止更新，而log4j 2是其最新版本，持续得到维护和更新，可以获得更好的支持和bug修复。
2. 配置灵活：log4j 2支持多种配置文件格式，包括.properties、.xml和.yml等，使得日志配置更加灵活和易于管理。
3. 性能优化：log4j 2在性能方面进行了优化，具有更高的吞吐量和更低的资源消耗，可以提升应用程序的性能。

# 二、配置log4j 2记录Spring Boot应用程序日志

1. 添加依赖：在项目的pom.xml文件中添加log4j 2的相关依赖，并排除默认的日志依赖。

```xml
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</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>
<dependency> 
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-yaml</artifactId>
</dependency>
```

2. 创建配置文件：在resources目录下创建log4j2.yml配置文件，并按需配置日志的输出方式、格式和级别等。

```yaml
Appenders:
  Console:
    name: CONSOLE
    target: SYSTEM_OUT
    PatternLayout:
      pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"
  RollingFile:
    - name: ROLLING_FILE
      ignoreExceptions: false
      fileName: /springboot/logs/springboot.log
      filePattern: "/springboot/logs/$${date:yyyy-MM}/springboot -%d{yyyy-MM-dd}-%i.log.gz"
      PatternLayout:
        pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"
      Policies:
        SizeBasedTriggeringPolicy:
          size: "256 MB"
      DefaultRolloverStrategy:
        max: 1000
Loggers:
  Root:
    level: info
    AppenderRef:
      - ref: CONSOLE
  Logger:
    - name: app.com.kenho.mapper
      additivity: false
      level: trace
      AppenderRef:
        - ref: CONSOLE
        - ref: ROLLING_FILE

```

- `fileName`属性：将`/springboot/logs/springboot.log`修改为适合你项目的日志文件路径和名称。
- `filePattern`属性：将`/springboot/logs/$${date:yyyy-MM}/springboot -%d{yyyy-MM-dd}-%i.log.gz`修改为适合你项目的日志文件归档规则。
- `level`属性：根据你的需求，修改`Root`和`Logger`中的`level`属性，以设置全局和特定包/类的日志级别。
- `AppenderRef`属性：根据你的需求，修改`Root`和`Logger`中的`AppenderRef`属性，以指定要使用的日志输出目标。

# 三、使用log4j 2记录Spring Boot应用程序日志的实例

通过一个实例来演示如何使用log4j 2记录Spring Boot应用程序的日志。

1. 创建一个Spring Boot应用程序，并添加log4j 2的相关依赖。
2. 在application.yml配置文件中禁用默认的日志配置。

```yaml
spring:
  main:
    banner-mode: off
  autoconfigure:
    exclude: org.springframework.boot.autoconfigure.logging.Log4J2LoggingSystem
```

3. 创建一个简单的Controller类，用于测试日志输出。

```java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LogController {
    private static final Logger logger = LoggerFactory.getLogger(LogController.class);

@GetMapping("/log")
    public String logTest() {
        logger.info("This is an info log message.");
        logger.warn("This is a warning log message.");
        logger.error("This is an error log message.");
        return "Log test completed.";
    }
}
```

4. 启动应用程序，并访问`http://localhost:8080/log`，查看控制台和日志文件中的日志输出结果。

结论：
使用log4j 2来记录Spring Boot应用程序的日志可以带来许多好处，包括更好的维护和更新支持、灵活的配置方式以及优化的性能。通过合理配置log4j 2，我们可以更好地监控和排查应用程序的问题，提高开发和维护效率。因此，建议在开发和部署Spring Boot应用程序时，使用log4j 2作为日志记录框架。

</div>

参考链接：

- [Spring Boot日志记录](https://docs.spring.io/spring-boot/docs/current/reference/html/howto-logging.html)
- [log4j 2官方文档](https://logging.apache.org/log4j/2.x/)

最后修改：2024 年 01 月 25 日

如果觉得我的文章对你有用，请随意赞赏

【知识总结】使用log4j 2记录Spring Boot应用程序日志

Fivk • 2024 年 01 月 25 日

引言：

</div>

# 一、log4j 2的优势

# 二、配置log4j 2记录Spring Boot应用程序日志

1. 添加依赖：在项目的pom.xml文件中添加log4j 2的相关依赖，并排除默认的日志依赖。

2. 创建配置文件：在resources目录下创建log4j2.yml配置文件，并按需配置日志的输出方式、格式和级别等。

```

# 三、使用log4j 2记录Spring Boot应用程序日志的实例

通过一个实例来演示如何使用log4j 2记录Spring Boot应用程序的日志。

1. 创建一个Spring Boot应用程序，并添加log4j 2的相关依赖。
2. 在application.yml配置文件中禁用默认的日志配置。

```yaml
spring:
  main:
    banner-mode: off
  autoconfigure:
    exclude: org.springframework.boot.autoconfigure.logging.Log4J2LoggingSystem
```

3. 创建一个简单的Controller类，用于测试日志输出。

```java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LogController {
    private static final Logger logger = LoggerFactory.getLogger(LogController.class);

4. 启动应用程序，并访问`http://localhost:8080/log`，查看控制台和日志文件中的日志输出结果。

</div>

参考链接：

- [Spring Boot日志记录](https://docs.spring.io/spring-boot/docs/current/reference/html/howto-logging.html)
- [log4j 2官方文档](https://logging.apache.org/log4j/2.x/)

【知识总结】使用log4j 2记录Spring Boot应用程序日志

【踩坑日志】SpringBoot项目启动提示This primary key of "id" is primitive !不建议如此请使用包装类 in Class:

【C】极域电子教室学生端解除控制

【开发技巧】@CrossOrigin注解解决跨域问题

这是好东西

【Fivk】文章归档

【C++】函数的占位参数

此内容被密码保护

【C】枚举

Sentinel 规则持久化

【Java】IDEA快捷键

【知识总结】使用log4j 2记录Spring Boot应用程序日志