当前位置：首页 > article >正文

Spring Boot和AOP将API输入输出数据存入数据库

article 2024/9/22 2:27:52

在Spring Boot应用中使用AOP（面向切面编程）来记录API的输入输出信息，并将其存储到数据库表中是一个常见的需求。这可以通过以下几个步骤实现：

1. 添加依赖

首先确保你的项目中包含Spring AOP的支持。如果你使用的是Maven，那么你的pom.xml文件应该已经包含了对Spring Boot Starter AOP的依赖：

xml

深色版本

1<dependency>
2    <groupId>org.springframework.boot</groupId>
3    <artifactId>spring-boot-starter-aop</artifactId>
4</dependency>

2. 创建实体类和Repository

为了存储API调用的信息，你需要创建一个实体类（例如ApiLog）以及对应的JpaRepository。

ApiLog.java

java

深色版本

1import javax.persistence.Entity;
2import javax.persistence.GeneratedValue;
3import javax.persistence.GenerationType;
4import javax.persistence.Id;
5
6@Entity
7public class ApiLog {
8    @Id
9    @GeneratedValue(strategy = GenerationType.AUTO)
10    private Long id;
11    private String endpoint;
12    private String method;
13    private String requestPayload;
14    private String responsePayload;
15    // Getters and Setters
16}

ApiLogRepository.java

java

深色版本

1import org.springframework.data.jpa.repository.JpaRepository;
2
3public interface ApiLogRepository extends JpaRepository<ApiLog, Long> {
4}

3. 创建切面类

接下来需要定义一个切面类来处理拦截逻辑。

LoggingAspect.java

java

深色版本

1import org.aspectj.lang.JoinPoint;
2import org.aspectj.lang.annotation.AfterReturning;
3import org.aspectj.lang.annotation.Aspect;
4import org.aspectj.lang.annotation.Before;
5import org.springframework.beans.factory.annotation.Autowired;
6import org.springframework.stereotype.Component;
7import org.springframework.web.context.request.RequestContextHolder;
8import org.springframework.web.context.request.ServletRequestAttributes;
9
10import javax.servlet.http.HttpServletRequest;
11import java.util.Map;
12
13@Aspect
14@Component
15public class LoggingAspect {
16
17    @Autowired
18    private ApiLogRepository apiLogRepository;
19
20    @Before("execution(* com.yourpackage.controller..*.*(..))")
21    public void logRequest(JoinPoint joinPoint) {
22        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
23        HttpServletRequest request = attributes.getRequest();
24
25        ApiLog apiLog = new ApiLog();
26        apiLog.setEndpoint(request.getRequestURI());
27        apiLog.setMethod(request.getMethod());
28        // 这里可以获取请求参数并设置到apiLog对象中
29        // apiLog.setRequestPayload(...);
30    }
31
32    @AfterReturning(pointcut = "execution(* com.yourpackage.controller..*.*(..))", returning = "response")
33    public void logResponse(JoinPoint joinPoint, Object response) {
34        ApiLog apiLog = new ApiLog();
35        // 假设我们已经在@Before中设置了endpoint和method
36        // 这里可以获取响应数据并设置到apiLog对象中
37        // apiLog.setResponsePayload(response.toString());
38        apiLogRepository.save(apiLog);
39    }
40}