使用SpringAOP实现公共字段填充功能
目录
- 概要
- 技术细节
- 效果展示
概要
在新增员工或者新增菜品分类时需要设置创建时间、创建人、修改时间、修改人等字段,在编辑员工或者编辑菜品分类时需要设置修改时间、修改人等字段。这些字段属于公共字段,也就是也就是在我们的系统中很多表中都会有这些字段,如下:
序号 | 字段名 | 含义 | 数据类型 |
---|---|---|---|
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。
我们使用AOP切面编程,实现功能增强,来完成公共字段自动填充功能。
技术细节
在实现公共字段自动填充,也就是在插入或者更新的时候为指定字段赋予指定的值,使用它的好处就是可以统一对这些字段进行处理,避免了重复代码。在上述的问题分析中,我们提到有四个公共字段,需要在新增/更新中进行赋值操作, 具体情况如下:
序号 | 字段名 | 含义 | 数据类型 | 操作类型 |
---|---|---|---|---|
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、反射
- 枚举类:
package com.sky.enumeration; /** * 数据库操作类型 */ public enum OperationTpythonype { /** * 更新操作 */ UPDATE, /** * 插入操作 */ INSERT }
- 自定义注解:
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(); }
- 自定义切面类:
- 公共字段填充,我们选择在连接点(方法)执行前就进行,所以用@Before
- 将连接点上的@AutoFill注解拦截下
- 利用注解的.value()获取到注解中的内容(数据库操作类型)
- 获取到该连接点的参数
- 准备好填充的内容
- 利用反射根据数据库操作类型进行填充
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.annotation.Annotation; import java.lang.reflect.Method; import java.time.LocalDateTime; @Aspect @Slf4j @Component 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("进行公共字段赋值"); //获取当前被拦截方法上的注解 AutoFIll autoFIll = ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(AutoFIll.class); //MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象 //AutoFIll autoFill = signature.getMethod().getAnnotation(AutoFIll.class); //获取数据库操作类型(INSERT,UPDATE) OperationType operationType = autoFIll.value(); //获取当前被拦截方法上的参数(实体对象) Object[] args = joinPoint.getArgs(); if (args == null || args.length == 0) { return; } Object entity = args[0]; //准备要填充的内容 LocalDateTime now = LocalDateTime.now(); Long id = BaseContext.getCurrentId(); //根据数据库操作类型进行赋值 if (operationType == OperationType.INSERT) { try { Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME, LocalDateTime.class); Method setCreateUser = entity.getClass().getDeclaredMjsethod(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, id); setUpdateTime.invoke(entity, now); setUpdateUser.invoke(entity, id); } catch (Exception e) { e.printStackTrace(); } } else if (operationType == operationType.UPDATE) { try { Method pythonsetUpdateTime = 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, id); } catch (Exception e) { e.printStackTrace(); } } } }
@AutoFIll(value = OperationType.INSERT) void insert(Dish dish);
效果展示
到此这篇关于使用SpringAOP实现公共字段填充功能的文章就介绍到这了,更多相关SpringAOP公共字段填充内容请搜索编程客栈(www.devze.com)以前的http://www.devze.com文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)!
精彩评论