公共字段自动填充

序号字段名含义数据类型
1create_time创建时间datetime
2create_user创建人idbigint
3update_time修改时间datetime
4update_user修改人idbigint

而针对于这些字段,我们的赋值方式为:

1). 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser设置为当前登录用户ID。

2). 在更新数据时, 将updateTime 设置为当前时间, updateUser设置为当前登录用户ID。


image.png


**实现步骤:**


1). 自定义注解 AutoFill,用于标识需要进行公共字段自动填充的方法


2). 自定义切面类 AutoFillAspect,统一拦截加入了 AutoFill 注解的方法,通过反射为公共字段赋值


3). 在 Mapper 的方法上加入 AutoFill 注解

自定义注解 AutoFill

进入到sky-server模块,创建com.sky.annotation包。

package com.sky.annotation;

import com.sky.enumeration.OperationType;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* 自定义注解,用于标识某个方法需要进行功能字段自动填充处理
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoFill {
   //数据库操作类型:UPDATE INSERT
   OperationType value();
}

其中OperationType已在sky-common模块中定义

package com.sky.enumeration;

/**
* 数据库操作类型
*/
public enum OperationType {

   /**
    * 更新操作
    */
   UPDATE,

   /**
    * 插入操作
    */
   INSERT
}


1.3.2 步骤二

自定义切面 AutoFillAspect

在sky-server模块,创建com.sky.aspect包。

package com.sky.aspect;

/**
* 自定义切面,实现公共字段自动填充处理逻辑
*/
@Aspect
@Component
@Slf4j
public class AutoFillAspect {

   /**
    * 切入点
    */
   @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
   public void autoFillPointCut(){}

   /**
    * 前置通知,在通知中进行公共字段的赋值
    */
   @Before("autoFillPointCut()")
   public void autoFill(JoinPoint joinPoint){
       /////////////////////重要////////////////////////////////////
       //可先进行调试,是否能进入该方法 提前在mapper方法添加AutoFill注解
       log.info("开始进行公共字段自动填充...");

   }
}

完善自定义切面 AutoFillAspect 的 autoFill 方法

package com.sky.aspect;

import com.sky.annotation.AutoFill;
import com.sky.constant.AutoFillConstant;
import com.sky.context.BaseContext;
import com.sky.enumeration.OperationType;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.time.LocalDateTime;

/**
* 自定义切面,实现公共字段自动填充处理逻辑
*/
@Aspect
@Component
@Slf4j
public class AutoFillAspect {

   /**
    * 切入点
    */
   @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
   public void autoFillPointCut(){}

   /**
    * 前置通知,在通知中进行公共字段的赋值
    */
   @Before("autoFillPointCut()")
   public void autoFill(JoinPoint joinPoint){
       log.info("开始进行公共字段自动填充...");

       //获取到当前被拦截的方法上的数据库操作类型
       MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象
       AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
       OperationType operationType = autoFill.value();//获得数据库操作类型

       //获取到当前被拦截的方法的参数--实体对象
       Object[] args = joinPoint.getArgs();
       if(args == null || args.length == 0){
           return;
       }

       Object entity = args[0];

       //准备赋值的数据
       LocalDateTime now = LocalDateTime.now();
       Long currentId = BaseContext.getCurrentId();

       //根据当前不同的操作类型,为对应的属性通过反射来赋值
       if(operationType == OperationType.INSERT){
           //为4个公共字段赋值
           try {
               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(operationType == OperationType.UPDATE){
           //为2个公共字段赋值
           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(entity,now);
               setUpdateUser.invoke(entity,currentId);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   }
}

步骤三

在Mapper接口的方法上加入 AutoFill 注解

CategoryMapper为例,分别在新增和修改方法添加@AutoFill()注解,也需要EmployeeMapper做相同操作

package com.sky.mapper;

@Mapper
public interface CategoryMapper {
   /**
    * 插入数据
    * @param category
    */
   @Insert("insert into category(type, name, sort, status, create_time, update_time, create_user, update_user)" +
           " VALUES" +
           " (#{type}, #{name}, #{sort}, #{status}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser})")
   @AutoFill(value = OperationType.INSERT)
   void insert(Category category);
   /**
    * 根据id修改分类
    * @param category
    */
   @AutoFill(value = OperationType.UPDATE)
   void update(Category category);

}

同时,将业务层为公共字段赋值的代码注释掉。

1). 将员工管理的新增和编辑方法中的公共字段赋值的代码注释。

2). 将菜品分类管理的新增和修改方法中的公共字段赋值的代码注释。




标签:

苍穹外卖(第一天)
暂无