【苍穹外卖】实现公共字段的自动填充-思路分析

实现公共字段的自动填充

需求

​ 数据库的设计表的过程中，可能会存在多张表有相同的字段，如某条记录的创建时间、创建人id，在service层中对这些字段填充的方式都是一样的（相当于重复代码），这时候会想，有没有一种方式可以自动实现，不需要在该类方法中都添加这些重复代码？
​ 可以通过注解+反射来实现，即在需要填充这些字段的方法上打上我们自定义的注解，然后通过反射的方式获取这些方法的信息，比如传入该方法的参数等，对其公共字段直接赋值。

//设置创建时间
category.setCreateTime(LocalDateTime.now());
//设置更新时间
category.setUpdateTime(LocalDateTime.now());
//设置创建人id
category.setCreateUser(BaseContext.getCurrentId());
//设置修改人id
category.setUpdateUser(BaseContext.getCurrentId());

技术点

• AOP:spring中面相切面编程的思想，切面其实就是一个代理类（在原有类的基础上实现代码增强）。
• 注解：自定义简单的注解用于标识需要填充公共字段的方法。
• 枚举：用于限制注解中能够写入的属性值
• 反射：反向获取类的信息

怎么实现

1. 定义切面类
   在一个普通类上添加注解@Aspect(标识为切面类),@Component(添加为spring组件)

2. 定义注解，用于标识mapper层中方法是update还是insert方法

   @Target(value = ElementType.METHOD)     //限制只能用在方法上面
   @Retention(RetentionPolicy.RUNTIME)     //设置注解的生命周期
   public @interface AutoFill {
   
       /**
        * 数据操作的类型（也是自定义的）
        * @return
        */
       OperationType value();
   
   }
   

3. 编写切入点表达式，用于匹配mapper层添加自定义注解的插入和更新的方法（可编写到一个普通方法上，后续让通知方法直接复用）

   /**
    * 定义切入点表达式
    */
   @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill))")
   public void autoFillPointCut(){};
   

4. 编写通知

   /**
    * 定义前置通知
    */
   @Before("autoFillPointCut()")
   public void autoFill(JoinPoint joinPoint){
       log.info("开始执行自动填充字段：");
       log.info("method name:{}", joinPoint.getSignature());
   
       //获取方法签名对象
       MethodSignature signature = (MethodSignature) joinPoint.getSignature();
   
       //获取添加AutoFill注解里面的值,即方法操作的类型
       AutoFill annotation = signature.getMethod().getAnnotation(AutoFill.class);
       OperationType type = annotation.value();
   
   
       //获取方法中的参数,默认第一个参数就是实体对象
       Object[] args = joinPoint.getArgs();
       Object entity = args[0];
   
       //安全校验
       if (args == null || args.length == 0){
           //直接结束方法调用
           return;
       }
   
   
       //准备好赋值的变量
       LocalDateTime now = LocalDateTime.now();
       Long currentId = BaseContext.getCurrentId();
   
   
       //给公共字段赋值
       if (type == OperationType.INSERT){
           try {
               //获取set方法
               Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME, LocalDateTime.class);
               Method setCreateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_USER, Long.class);
               Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
               Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);
   
               //给四个公共字段赋值,注意指明是给哪一个方法对象赋值
               setCreateTime.invoke(entity, now);
               setCreateUser.invoke(entity, currentId);
               setUpdateTime.invoke(entity, now);
               setUpdateUser.invoke(entity, currentId);
           } catch (Exception e) {
               e.printStackTrace();
           }
       } else if (type == OperationType.UPDATE){
           try {
               Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
               Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);
   
               //给两个公共字段赋值
               setUpdateTime.invoke(now);
               setUpdateUser.invoke(currentId);
           } catch (Exception e) {
               e.printStackTrace();
           }
   
   
       }
   

   由于我们需要在mapper的插入或者更新方法执行之前给这些公共字段赋值，所以用到的是前置通知

5. 在mapper层中的方法添加我们自定义的注解

实现细节说明

• JoinPoint类的使用
  直接在通知方法的参数列表上添加该类对象即可（框架会帮我们注入）
• JoinPoint类的作用
  此类主要是储存了连接点的信息（连接点就是逻辑层面的位置，也就是我们对一个方法进行增强的时候，在这个方法的哪一个执行周期进行增强，如方法执行前的位置、方法出现异常的位置、方法执行后的位置等），信息包括通过切人点表达式拦截到的方法的方法名、方法参数和返回参数类型等（其实也就是方法签名）。
• 实现大体思路
  1. 先通过JoinPoint类获取方法签名对象，通过这个对象来获取拦截到的方法上的信息，如方法参数（方法参数可能有多个，注意约定好需要赋值的参数的位置），以及该方法上注解的信息（上述例子就是获取@AutoFill注解中的value值）。
  2. 获取到方法参数之后，通过JoinPoint类对象获取参数中的实例对象（例子中的entity），通过该实例对象，使用反射获取该实例的class对象获取方法对象（setter和getter）
  3. 调用方法对象进行对公共字段进行赋值即可