Spring AOP实现接口请求记录到数据库的示例代码

下面我将为你详细讲解如何使用Spring AOP实现接口请求记录到数据库的示例代码。

1. 确定日志记录的实体类

首先，我们需要确定日志记录所对应的实体类，以便将数据存入数据库中。假设我们使用的是MySQL数据库，那么我们需要创建一个表来存储日志记录数据，例如：

CREATE TABLE `request_log` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `request_url` varchar(255) NOT NULL COMMENT '请求URL',
  `request_method` varchar(10) NOT NULL COMMENT '请求方法（GET、POST、PUT、DELETE等）',
  `request_ip` varchar(20) NOT NULL COMMENT '请求IP',
  `request_params` text NOT NULL COMMENT '请求参数',
  `request_time` datetime NOT NULL COMMENT '请求时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='接口请求记录';

同时，我们还需要定义对应的实体类 RequestLog，它与数据库表 request_log 对应：

@Data
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "request_log")
public class RequestLog {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String requestUrl;
    private String requestMethod;
    private String requestIp;
    private String requestParams;
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    private Date requestTime;
}

2. 定义切面

接下来，我们需要定义一个切面来切入我们的请求方法。首先，我们需要使用@Aspect注解来标识这是一个切面：

@Aspect
@Component
public class RequestLogAspect {
    // ...
}

然后，我们需要定义一个切入点，用于匹配所有的控制器方法：

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

接着，我们需要定义一个环绕通知，来实现日志记录的逻辑：

@Around("logPointcut()")
public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
    // 获取请求信息
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attributes.getRequest();
    String url = request.getRequestURI();
    String method = request.getMethod();
    String ip = request.getRemoteAddr();
    String params = getRequestParams(joinPoint);

    // 记录日志
    RequestLog log = new RequestLog();
    log.setRequestUrl(url);
    log.setRequestMethod(method);
    log.setRequestIp(ip);
    log.setRequestParams(params);
    log.setRequestTime(new Date());
    logRepository.save(log);

    // 调用目标方法
    Object result = joinPoint.proceed();

    return result;
}

在以上代码中，我们使用ProceedingJoinPoint来获取目标方法的参数，进而获取请求参数；使用RequestContextHolder获取当前请求的HttpServletRequest对象，进而获取请求的URL和请求的IP地址。然后，我们将这些信息封装成RequestLog对象，并保存到数据库中。

同时，我们还要定义一个辅助方法，用于获取请求的参数：

private String getRequestParams(ProceedingJoinPoint joinPoint) throws JsonProcessingException {
    Object[] args = joinPoint.getArgs();
    if (args == null || args.length == 0) {
        return "";
    }
    ObjectMapper mapper = new ObjectMapper();
    return mapper.writeValueAsString(args[0]);
}

该方法使用ObjectMapper将参数对象转换为JSON字符串，用于保存到数据库中。

3. 测试示例

以上是Spring AOP实现接口请求记录到数据库的示例代码，下面来两条测试示例：

示例一

@RestController
public class TestController {
    @GetMapping("/test")
    public String test(@RequestParam("param1") String param1, @RequestParam("param2") String param2) {
        return "param1=" + param1 + ", param2=" + param2;
    }
}

上述代码中，我们定义了一个接口 /test，接受两个参数，返回一个字符串。当我们访问该接口时，会自动记录请求信息到数据库中。

示例二

@RestController
public class TestController {
    @PostMapping("/test")
    public String test(@RequestBody User user) {
        return "Hello " + user.getName() + "!";
    }
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
}

上述代码中，我们定义了一个接口 /test，接受一个User对象，返回一个字符串。同样地，当我们访问该接口时，会自动记录请求信息到数据库中。

至此，Spring AOP实现接口请求记录到数据库的示例代码的完整攻略就讲解完毕了。