SpringBoot AOP 轻松收集请求参数，审计无忧

2023-11-24 17:09:10

使用 SpringBoot AOP 实现无痛请求审计

开启 AOP 的强大功能

SpringBoot 以其简洁易用而备受 Java 开发者的青睐。它提供了强大的 AOP 功能，允许我们在不修改原有代码的情况下为应用程序添加额外功能。在应用开发中，审计用户请求通常是必不可少的，它能帮助我们进行故障排除、合规检查等。传统上，我们需要手动在每个需要记录请求参数的地方添加代码，这不仅繁琐，而且容易出错。

AOP 赋能审计：省心又高效

借助 SpringBoot AOP，我们可以轻松实现请求参数的统一获取和审计日志记录。我们创建一个切面类，在这个类中定义一个围绕切入点的方法。当这个切入点的某个方法被调用时，我们的切面类就会被触发，从而在方法执行前后执行我们定义的操作。

实战：SpringBoot AOP 审计日志记录

1. 引入依赖：

在项目中引入 SpringBoot AOP 依赖：

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

2. 创建切面类：

创建一个 AuditAspect 类，用以记录请求参数：

@Aspect
@Component
public class AuditAspect {

    @Around("execution(* com.example.controller.*.*(..))")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取请求参数
        Object[] args = joinPoint.getArgs();
        // 记录请求参数
        log.info("请求参数：{}", Arrays.toString(args));
        // 执行原有方法
        Object result = joinPoint.proceed();
        // 记录响应结果
        log.info("响应结果：{}", result);
        return result;
    }
}

3. 启用切面：

在 SpringBoot 的配置文件中启用切面功能：

@Configuration
@EnableAspectJAutoProxy
public class SpringConfig {
    // 配置切面类
    @Bean
    public AuditAspect auditAspect() {
        return new AuditAspect();
    }
}

4. 测试审计功能：

现在，我们可以在控制器中模拟请求，查看是否能正确记录请求参数和响应结果：

@RestController
@RequestMapping("/demo")
public class DemoController {

    @PostMapping("/hello")
    public String hello(@RequestParam String name) {
        return "Hello, " + name + "!";
    }
}