SpringBoot的AOP在开发中的实例、公共字段利用AOP实现自动填充

1. 公共字段自动填充

若要实现下述步骤，需掌握以下知识

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

1.1 问题分析

在我们开发时需要设置创建时间、创建人、修改时间、修改人等字段，比如编辑员工或者编辑分类时需要设置修改时间、修改人等字段。这些字段属于公共字段，也就是也就是在我们的系统中很多表中都会有这些字段，如下：

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

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和修改人idemployee.setCreateUser(BaseContext.getCurrentId());//目前写个假数据，后期修改employee.setUpdateUser(BaseContext.getCurrentId());///employeeMapper.insert(employee);}

编辑员工方法：

	/* 编辑员工信息 @param employeeDTO*/public void update(EmployeeDTO employeeDTO) {//........................................///employee.setUpdateTime(LocalDateTime.now());employee.setUpdateUser(BaseContext.getCurrentId());///employeeMapper.update(employee);}

新增菜品分类方法：

	/* 新增分类* @param categoryDTO*/public void save(CategoryDTO categoryDTO) {//....................................////设置创建时间、修改时间、创建人、修改人category.setCreateTime(LocalDateTime.now());category.setUpdateTime(LocalDateTime.now());category.setCreateUser(BaseContext.getCurrentId());category.setUpdateUser(BaseContext.getCurrentId());///categoryMapper.insert(category);}

修改菜品分类方法：

	/* 修改分类* @param categoryDTO*/public void update(CategoryDTO categoryDTO) {//....................................////设置修改时间、修改人category.setUpdateTime(LocalDateTime.now());category.setUpdateUser(BaseContext.getCurrentId());//categoryMapper.update(category);}

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

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

1.2 实现思路

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

实现步骤：

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

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

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

1.3 代码开发

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

1.3.1 步骤一

自定义注解 AutoFill

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 INSERTOperationType value();
}

定义OperationType枚举

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

定义AutoFillConstant枚举

/* 公共字段自动填充相关常量*/
public class AutoFillConstant {/* 实体类中的方法名称*/public static final String SET_CREATE_TIME = "setCreateTime";public static final String SET_UPDATE_TIME = "setUpdateTime";public static final String SET_CREATE_USER = "setCreateUser";public static final String SET_UPDATE_USER = "setUpdateUser";
}

1.3.2 步骤二

自定义切面 AutoFillAspect

/* 自定义切面，实现公共字段自动填充处理逻辑*/
@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 方法

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(){}/* 定义前置通知,在当前方法中进行公共字段的填充赋值* @param joinPoint 就是spring中允许使用通知的地方*/@Before("autoFillPointCut()")public void autoFill(JoinPoint joinPoint){log.info("开始进行公共字段填充");//1.获取到当前被拦截方法上的数据操作类型//1.1获取方法签名MethodSignature signature = (MethodSignature) joinPoint.getSignature();//1.2获取方法上的自定义注解对象AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//1.3 获取自定义注解中的操作类型，insert 还是updateOperationType operationType = autoFill.value();//2.获取当前被拦截方法的参数---实体对象//2.1 获取参数Object[] args = joinPoint.getArgs();if(args==null || args.length==0){return;}//2.2 获取第一个参数，可能是实体类对象也有可能是其他对象Object entity = args[0];//3.3 定义属性赋值参数LocalDateTime now = LocalDateTime.now();Long userId = UserThreadLocalUtils.getCurrentId();//3.如果是新增，则为四个属性赋值if(operationType==OperationType.INSERT){try {//3.1 利用反射获取当前赋值的方法,也就是实体类中的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);/*  3.2 为获取的以上四个set方法进行赋值*  invoke(Object obj, Object... args)*/setCreateTime.invoke(entity,now);setCreateUser.invoke(entity,userId);setUpdateTime.invoke(entity,now);setUpdateUser.invoke(entity,userId);} catch (Exception e) {e.printStackTrace();}//4.如果是修改，则为两个属性赋值}else if(operationType==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(entity,now);setUpdateUser.invoke(entity,userId);} catch (Exception e) {e.printStackTrace();}}}
}

1.3.3 步骤三

在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. 自定义切面、确定好切入点
3. 利用JoinPoint获取方法的注解的值和参数值
4. 利用反射获取set方法并执行set方法
5. 在Mapper调用注解