Spring Boot入门(23)：【实战】通过AOP拦截Spring Boot日志并将其存入数据库

在Spring Boot应用中，通过AOP（面向切面编程）拦截日志并将其存入数据库是一个常见的需求，可以帮助开发者更好地监控应用的运行状态和问题排查。以下是实现这一功能的基本步骤：

1. 引入依赖

首先，确保你的pom.xml或build.gradle文件中包含了Spring Boot和数据访问相关的依赖。

对于Maven，添加如下依赖：

<dependencies>
    <!-- Spring Boot Starter AOP -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <!-- Spring Boot Starter Data JPA -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <!-- 选择一个数据库驱动，例如H2 -->
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!-- 其他依赖 -->
</dependencies>

2. 配置数据访问

创建一个实体类LogEntry来映射数据库中的日志记录。

import javax.persistence.*;
import java.time.LocalDateTime;

@Entity
public class LogEntry {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String message;

    private LocalDateTime timestamp;

    // 省略getter和setter方法
}

配置数据源和JPA。

# src/main/resources/application.yml
spring:
  datasource:
    url: jdbc:h2:mem:testdb
    driverClassName: org.h2.Driver
    username: sa
    password: password
  jpa:
    hibernate:
      ddl-auto: create-drop
    properties:
      hibernate:
        show_sql: true

3. 创建日志存储服务

创建一个服务类，用于将日志信息存储到数据库。

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class LogService {

    private final LogRepository logRepository;

    public LogService(LogRepository logRepository) {
        this.logRepository = logRepository;
    }

    @Transactional
    public void save(String message) {
        LogEntry logEntry = new LogEntry();
        logEntry.setMessage(message);
        logEntry.setTimestamp(LocalDateTime.now());
        logRepository.save(logEntry);
    }
}

4. 创建日志拦截器

使用AOP创建一个日志拦截器，该拦截器将日志信息传递给LogService。

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LogAspect {

    private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);

    @Autowired
    private LogService logService;

    @Pointcut("execution(* com.example.demo.*.*(..))")
    public void logAround() {}

    @Before("logAround()")
    public void before(JoinPoint joinPoint) {
        // 这里可以根据需要记录日志的具体内容
        String logMessage = "Method: " + joinPoint.getSignature().getName();
        logService.save(logMessage);
    }
}

5. 配置AOP

在Spring Boot的主配置类中启用AOP。

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.aop.AopAutoConfiguration;

@SpringBootApplication(exclude = AopAutoConfiguration.class)
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

6. 运行和验证

启动你的Spring Boot应用，并进行一些操作以生成日志。然后，检查数据库以确认日志已经被存储。

这个例子展示了如何使用Spring AOP拦截方法调用并将日志存储到数据库。你可以根据需要修改拦截器，以适应不同的日志记录需求。