实现公共字段自动填充 (苍穹外卖)

问题

有些字段，如 : create_time,create_user , update_time , update_user是公共的，每次赋值都要重新编写代码，会造成代码冗余 ；

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

实现 :

• 自定义注解AutoFill,用于表示需要进行公共自读那自动填充的方法

• 自定义切面类，统一拦截加入了AutoFill注解的方法，通过反射为公共字段赋值。

• 在Mapper的方法上加入AutoFill注解。

1.创建枚举类

在common下定义了需要加上注解的数据库操作类型 :

OperationType.java :

package com.sky.enumeration;
​
/**
 * 数据库操作类型
 */
public enum OperationType {
​
    /**
     * 更新操作
     */
    UPDATE,
​
    /**
     * 插入操作
     */
    INSERT
​
}

​

2.自定义注解AutoFill

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 {
    // 指定数据库操作类型
    OperationType value();
}

3.自定义拦截器

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.Signature;
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(); // 获取数据库操作类型
​
        // 获取当前被拦截的方法的参数 -- 实体对象(比如employee)
        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个公共字段赋值 -- 通过反射来进行赋值
            // 获取Set方法
            try {
//                Method setCreateTime = entity.getClass().getDeclaredMethod("setCreateTime" , LocalDateTime.class);
//                Method setCreateUser = entity.getClass().getDeclaredMethod("setCreateUser" , Long.class);
//                Method setUpdateTime = entity.getClass().getDeclaredMethod("setUpdateTime", LocalDateTime.class);
//                Method setUpdateUser = entity.getClass().getDeclaredMethod("setUpdateUser", Long.class);
​
                // 用定义好的常量实现
                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();
            }
        }
​
​
    }
}

​

注意 :

• 切面是 切入点 + 通知

4.在mapper对应方法上加上注解 :

@AutoFill(value = OperationType.INSERT)
    void insert(Employee employee);
@AutoFill(value = OperationType.UPDATE)
    void update(Employee employee);

CategoryMapper中一样 ;

5.在impl中将之前写的insert和update方法里对公共字段进行赋值的语句注释掉