自定义注解和切面类，使用枚举和反射，实现公共字段填充

1.问题分析

在上一章节我们已经完成了后台系统的员工管理功能 和菜品分类功能 的开发，在新增员工 或者新增菜品分类 时需要设置创建时间、创建人、修改时间、修改人等字段，在编辑员工 或者编辑菜品分类时需要设置修改时间、修改人等字段。这些字段属于公共字段，也就是也就是在我们的系统中很多表中都会有这些字段，如下：

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

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

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

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

目前,在我们的项目中处理这些字段都是在每一个业务方法中进行赋值操作,如下:

新增员工方法：

    /**
     * 新增员工
     *
     * @param employeeDTO
     */
    public void save(EmployeeDTO employeeDTO) {
        //.......................
        //////////////////////////////////////////
        //设置当前记录的创建时间和修改时间
        employee.setCreateTime(LocalDateTime.now());
        employee.setUpdateTime(LocalDateTime.now());
​
        //设置当前记录创建人id和修改人id
        employee.setCreateUser(BaseContext.getCurrentId());
        employee.setUpdateUser(BaseContext.getCurrentId());
        ///////////////////////////////////////////////
        employeeMapper.insert(employee);
    }

如果都按照上述的操作方式来处理这些公共字段, 需要在每一个业务方法中进行操作, 编码相对冗余、繁琐，那能不能对于这些公共字段在某个地方统一处理，来简化开发呢？

答案是可以的，我们使用AOP切面编程，实现功能增强，来完成公共字段自动填充功能。

2.实现思路

在实现公共字段自动填充，也就是在插入或者更新的时候为指定字段赋予指定的值，使用它的好处就是可以统一对这些字段进行处理，避免了重复代码。在上述的问题分析中，我们提到有四个公共字段，需要在新增/更新中进行赋值操作, 具体情况如下:

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

实现步骤：

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

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

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

若要实现上述步骤，需掌握以下知识(之前课程内容都学过)

**技术点：**枚举、注解、AOP、反射

3.实现代码

按照上一小节分析的实现步骤依次实现，共三步。

1.步骤一:自定义注解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;
​
/**
 * 自定义注解AutoFill，用于标识某个方法需要进行功能字段自动填充处理
 */
@Target(ElementType.METHOD) //指定该注解只能加在方法上
@Retention(RetentionPolicy.RUNTIME) //注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；
public @interface AutoFill {
    //数据库操作类型：UPDATE INSERT
    OperationType value();
}

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

package com.sky.enumeration;
​
/**
 * 数据库操作类型
 */
//定义了一个名为OperationType的枚举类型，用于表示数据库操作的类型。
public enum OperationType {
​
    /**
     * 更新操作
     */
    UPDATE,
​
    /**
     * 插入操作
     */
    INSERT
}

2.步骤二:自定义切面类AutoFillAspect

/**
 * 自定义切面，实现公共字段自动填充处理逻辑
 */
@Aspect //把当前类标识为一个切面供容器读取
@Component //也是个bean,要交给Spring容器管理  
@Slf4j //引入日志记录器
public class AutoFillAspect {
    /**
     * 切入点
     */
    //@Pointcut()里面写切点表达式:拦截mapper包里的加入了@AutoFill注解的方法(即切点)
    @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
    public void autoFillPointCut(){}//切入点定义依托一个不具有实际意义的方法进行，即无参数、无返回值、方法体无实际逻辑。

    /**
     * 前置通知，在通知中进行公共字段的赋值
     */
    //使用了@Before注解来指定在哪个切入点方法执行之前执行该前置通知。
    @Before("autoFillPointCut()")//在被拦截的方法后面执行下面代码
    public void autoFill(JoinPoint joinPoint){
        log.info("开始进行公共字段自动填充...");

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

        //获取到当前被拦截的方法的参数--实体对象,eg: void update(Category category);
        Object[] args = joinPoint.getArgs();
        if(args == null || args.length == 0){//当前代码无参数
            return;
        }
        Object entity = args[0];//首位参数才是我们想要获取的对象，用Object接收

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

        //根据当前不同的操作类型，为对应的属性通过反射来赋值
        if(operationType == OperationType.INSERT){
            //为4个公共字段赋值
            try {
                //反射
                
                //首先通过entity.getClass()获取实体类的Class对象，然后调用getDeclaredMethod方法来获取该类中名为AutoFillConstant.SET_CREATE_TIME(即"setCreateTime")的方法，接受一个LocalDateTime类型的参数的方法的Method方法对象setCreateTime。
                Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME, LocalDateTime.class);
                //通过反射为对象属性赋值
                //使用invoke方法来调用setCreateTime方法，并传入两个参数：一个是实体类实例entity，另一个是当前时间now,相当于entity.setCreateTime(now)
                //使用invoke方法调用entity的"getInt"方法，传入参数now。invoke方法会返回调用结果
                setCreateTime.invoke(entity,now);
                
                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);         
                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();
            }
        }
    }
}

3.步骤三:加上注解@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);
}