spring boot 异步日志log4j2

原创

mob64ca12d8c182 2024-10-29 05:17:05 ©著作权

文章标签 spring 日志记录 java 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d8c182的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何在 Spring Boot 中实现异步日志 Log4j2

在现代应用开发中，日志记录是不可或缺的一部分。使用 Log4j2 来实现异步日志可以显著提高系统的性能。本文将一步步引导你在 Spring Boot 项目中实现异步日志记录。

流程步骤

步骤	说明
1	添加依赖
2	配置 Log4j2
3	创建日志记录类
4	在服务中使用日志记录
5	运行项目并测试

步骤详解

1. 添加依赖

首先，在你的 pom.xml 中添加 Log4j2 和相应的依赖。

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

说明: 上述依赖会引入 Log4j2 及其依赖。

2. 配置 Log4j2

在项目的 src/main/resources 目录下创建一个 log4j2.xml 文件，并添加以下配置。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1} - %m%n"/>
        </Console>
        <File name="FileLogger" fileName="logs/app.log" append="true">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1} - %m%n"/>
        </File>
    </Appenders>
    
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="FileLogger"/>
        </Root>
        <Logger name="com.example" level="debug" additivity="false">
            <AppenderRef ref="FileLogger"/>
        </Logger>
    </Loggers>
</Configuration>

说明: 这个配置定义了输出到控制台和文件的格式及日志级别。

3. 创建日志记录类

在你的项目中创建一个日志记录器的类，例如 MyLogger.java，并添加以下代码。

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;

@Component
public class MyLogger {
    
    private static final Logger logger = LogManager.getLogger(MyLogger.class);

    @Async // 标记为异步方法
    public void logInfo(String message) {
        logger.info(message);
    }
}

说明: 通过使用 @Async 注解，这个方法将以异步方式执行，减少对主线程的阻塞。

4. 在服务中使用日志记录

接下来，在你需要记录日志的服务类中注入 MyLogger。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Autowired
    private MyLogger myLogger;

    public void performTask() {
        // 执行某个任务
        myLogger.logInfo("任务开始执行..."); // 异步记录日志
        // 其他业务逻辑
        myLogger.logInfo("任务执行完成.");
    }
}

说明: 在 MyService 中调用 logInfo 方法将记录异步日志。

5. 运行项目并测试

确保你的 Spring Boot 应用程序主类上有 @EnableAsync 注解来启用异步支持。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;

@SpringBootApplication
@EnableAsync // 启用异步支持
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}