ToB企服应用市场:ToB评测及商务社交产业平台

标题: 实现 公共字段主动填充【创建时间/创建人/修改id/修改id】 [打印本页]

---

作者: 络腮胡菲菲    时间: 2024-8-23 14:02
标题: 实现 公共字段主动填充【创建时间/创建人/修改id/修改id】
实现 公共字段主动填充【创建时间/创建人/修改id/修改id】

技术栈

• 枚举
  
• 自定义注解
  
• AOP
  
• 反射
  

实现思路

• 编写枚举，用于标识数据库操作类型
  
• 自定义注解AutoFill，用于标识须要进行公共字段主动填充的方法
  
• 将Mapper的方法名写成常量类，提高代码规范
  
• 自定义切面类AutoFillAspect，同一拦截加入了AutoFill注解的方法，通过反射为公共字段赋值
  
• 在Mapper的方法上加入AutoFill注解
  

代码实现

• 编写枚举，用于标识数据库操作类型
  1. public enum OperationType {
  3.     //更新操作
  4.     UPDATE,
  6.     //插入操作
  7.     INSERT
  9. }

  复制代码
• 自定义注解AutoFill，用于标识须要进行公共字段主动填充的方法
  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface AutoFill {
  5.     //数据库操作类型
  6.     OperationType value();
  7. }

  复制代码
• 将Mapper的方法名写成常量类，提高代码规范
  1. //公共字段自动填充相关常量
  2. public class AutoFillConstant {
  4.     //实体类中的方法名称
  5.     public static final String SET_CREATE_TIME = "setCreateTime";
  6.     public static final String SET_UPDATE_TIME = "setUpdateTime";
  7.     public static final String SET_CREATE_USER = "setCreateUser";
  8.     public static final String SET_UPDATE_USER = "setUpdateUser";
  9. }

  复制代码
• 自定义切面类AutoFillAspect
  1. /**
  2. * 自定义切面，实现公共字段自动填充
  3. */
  4. @Aspect
  5. @Component
  6. @Slf4j
  7. public class AutoFillAspect {
  9.     /**
  10.      * 切入点
  11.      */
  12.     @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
  13.     public void autoFillPointCut(){}
  15.     /**
  16.      * 前置通知，在通知中进行公共字段的赋值
  17.      */
  18.     @Before("autoFillPointCut()")
  19.     public void autoFill(JoinPoint joinPoint){
  20.         log.info("开始进行公共字段自动填充...");
  22.         //获取到当前被拦截的方法上的数据库操作类型
  23.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象
  24.         AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
  25.         OperationType operationType = autoFill.value();//获得数据库操作类型
  27.         //获取到被拦截的方法形参参数【实体对象】
  28.         Object[] args = joinPoint.getArgs();
  29.         //约定：如果需要实现自动填充功能 ，需要把实体参数 放在形参第一个参数
  30.         if (args == null || args.length == 0){
  31.             return;//防止空指针
  32.         }
  34.         Object entity = args[0];//拿到实体对象
  36.         //准备数据 实体对象的公共属性【时间和登录id】
  37.         LocalDateTime now = LocalDateTime.now();
  38.         Long currentId = BaseContext.getCurrentId();
  40.         //根据当前不同的操作类型 为对应的属性赋值【反射】
  41.         if (operationType == OperationType.INSERT){
  42.             //为4个公共字段赋值
  43.             try {
  44.                 Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME, LocalDateTime.class);//这里就是常量类，规范代码
  45.                 Method setCreateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_USER, Long.class);
  46.                 Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
  47.                 Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);
  49.                 //通过反射为对象属性赋值
  50.                 setCreateTime.invoke(entity,now);
  51.                 setCreateUser.invoke(entity,currentId);
  52.                 setUpdateTime.invoke(entity,now);
  53.                 setUpdateUser.invoke(entity,currentId);
  54.             } catch (Exception e) {
  55.                e.printStackTrace();
  56.             }
  57.         }else if (operationType == OperationType.UPDATE){
  58.             //为2个公共字段赋值
  59.             try {
  60.                 Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
  61.                 Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);
  63.                 //通过反射为对象属性赋值
  64.                 setUpdateTime.invoke(entity,now);
  65.                 setUpdateUser.invoke(entity,currentId);
  66.             } catch (Exception e) {
  67.                 e.printStackTrace();
  68.             }
  69.         }
  70.     }
  71. }

  复制代码
• 在Mapper的方法上加入AutoFill注解
  1. @AutoFill(value = OperationType.INSERT)
  2.     @Insert("insert into category(type, name, sort, status, create_time, update_time, create_user, update_user)" +
  3.             " VALUES" +
  4.             " (#{type}, #{name}, #{sort}, #{status}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser})")
  5.     void insert(Category category);

  复制代码

实现了表格公共字段主动填充后，在service层编写插入大概修改实体的时间就不须要重复设置 修改时间、修改id等

1.   //设置修改时间、修改人
2. //        category.setUpdateTime(LocalDateTime.now());
3. //        category.setUpdateUser(BaseContext.getCurrentId());这些不再需要重复设置

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4