使用AOP优化Spring Boot Controller参数：自动填充常用字段的技巧

欢迎来到我的博客，代码的世界里，每一行都是一个故事

在这里插入图片描述

🎏：你只管努力，剩下的交给时间

🏠 ：小破站

使用AOP优化Spring Boot Controller参数：自动填充常用字段的技巧

- 前言
- 为什么使用AOP
- - 为什么使用AOP实现参数重写？
  - - 好处：
    - 坏处：
  - 其他实现方式及其比较
  - - 1. Controller基类方法
    - 2. 使用拦截器（Interceptor）
  - 总结
- 实现
- - 解释说明：

前言

在现代Web开发中，通过AOP实现参数重写是一种高效且优雅的方式。它不仅能帮助开发者简化重复性的代码编写，还能有效提升接口的安全性和可靠性。今天，我们将探索如何利用AOP技术，在Spring Boot项目中实现对Controller保存方法参数的智能填充，让你的API开发更加高效和愉快。

为什么使用AOP

理解为什么选择使用AOP（面向切面编程）来实现参数重写是很重要的，同时还可以考虑其他实现方式。下面我们来详细探讨一下这些方面：

为什么使用AOP实现参数重写？

好处：

解耦和增强可维护性：AOP可以将横切逻辑（如参数填充）从业务逻辑中分离出来，避免代码重复，提高代码的清晰度和可维护性。
集中管理和复用：通过AOP，可以集中管理和配置参数填充逻辑，使得多个Controller方法都能够共享同一段逻辑，减少重复开发。
方便扩展和修改：当需要修改或扩展参数填充逻辑时，只需调整AOP切面，而不必修改每个涉及到参数填充的Controller方法。

坏处：

引入复杂性：AOP的使用可能会增加代码的复杂性，特别是对于初学者来说，理解和调试AOP可能会有一定的学习曲线。
运行时性能开销：AOP通常在运行时动态生成代理对象或者织入代码，可能会对系统性能产生一定的影响，尤其是在大规模应用中。

其他实现方式及其比较

1. Controller基类方法

通过创建一个基类Controller，其中包含公共的参数填充逻辑，所有Controller继承这个基类，实现参数填充的共享。

好处：简单直接，无需引入AOP框架，易于理解和维护。
坏处：如果项目中有多种不同的参数填充逻辑，可能会导致基类代码过于复杂和臃肿。

2. 使用拦截器（Interceptor）

在Spring MVC中，可以通过实现HandlerInterceptor接口，重写preHandle方法，在请求进入Controller方法之前进行参数的预处理。

好处：与AOP类似，可以实现对请求的拦截和处理，但更加灵活，可以针对特定的请求路径或者方法进行处理。
坏处：拦截器主要用于对请求的预处理和后处理，不够直接地集中在参数填充的功能上，可能需要额外的配置和管理。

总结

选择使用AOP来实现参数重写，是为了提高代码的复用性、可维护性和灵活性。它能够有效地解耦业务逻辑和横切关注点（如参数填充），使得代码更加清晰和易于扩展。然而，AOP也不是万能的解决方案，需要权衡其引入的复杂性和可能的运行时开销。

除了AOP，还可以考虑使用Controller基类方法或者拦截器来实现类似的功能，具体选择取决于项目的需求和团队的技术栈。

实现

下面是一个改进的示例，演示如何使用反射来处理不同类型的实体对象：

@Aspect
@Component
public class ControllerAspect {

    @Autowired
    private UserService userService; // 假设需要从userService中获取当前用户信息

    @Around("execution(* com.example.controller.*Controller.save*(..))")
    public Object aroundSave(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取目标方法的参数
        Object[] args = joinPoint.getArgs();

        for (Object arg : args) {
            if (arg instanceof BaseEntity) {
                handleEntity((BaseEntity) arg);
            }
        }

        // 继续执行目标方法
        Object result = joinPoint.proceed();

        return result;
    }

    private void handleEntity(BaseEntity entity) {
        try {
            // 使用反射获取实体对象的类
            Class<?> clazz = entity.getClass();

            // 设置创建时间、修改时间、创建人、修改人等通用属性
            Field createTimeField = clazz.getDeclaredField("createTime");
            createTimeField.setAccessible(true);
            createTimeField.set(entity, LocalDateTime.now());

            Field updateTimeField = clazz.getDeclaredField("updateTime");
            updateTimeField.setAccessible(true);
            updateTimeField.set(entity, LocalDateTime.now());

            Field createUserField = clazz.getDeclaredField("createUser");
            createUserField.setAccessible(true);
            createUserField.set(entity, userService.getCurrentUser());

            Field updateUserField = clazz.getDeclaredField("updateUser");
            updateUserField.setAccessible(true);
            updateUserField.set(entity, userService.getCurrentUser());

            // 可以根据需要添加其他通用属性的处理
        } catch (NoSuchFieldException | IllegalAccessException e) {
            // 处理异常
            e.printStackTrace();
        }
    }
}

解释说明：

@Around("execution( com.example.controller.Controller.save(…))")*：
- @Around：表示在目标方法执行前后都会执行该切面逻辑。
- "execution(* com.example.controller.*Controller.save*(..))"：指定切入点表达式，匹配所有保存方法（如save、saveOrUpdate等）。
aroundSave方法：
- ProceedingJoinPoint joinPoint：继承自JoinPoint，可以控制目标方法的执行。
- Object[] args = joinPoint.getArgs()：获取目标方法的所有参数。
- 遍历参数数组，对每个参数进行类型判断。在示例中，假设所有的实体类都继承自BaseEntity，因此使用instanceof BaseEntity来判断。
handleEntity方法：
- BaseEntity entity：传入的实体对象，通过反射动态设置通用属性。
- 使用entity.getClass()获取实体对象的Class对象，然后使用反射操作这些属性。
- 获取并设置实体对象的创建时间、修改时间、创建人、修改人等通用属性。
- 可以根据实际需求，添加其他通用属性的处理。