公共字段自动填冲代码

package com.sky.aspect;

import com.sky.annotation.AutoFill;
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;

@Component
@Slf4j
@Aspect
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("开始进行公共字段的填充...");

        //1.获取到当前被拦截的方法上的数据库操作类型,也就是说是添加操作呢还是修改操作。
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象
        AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
        OperationType operationType = autoFill.value();//获得数据库操作类型


        //2.获取到当前被拦截的方法的参数----实体对象

        Object[] args = joinPoint.getArgs();//取回方法中的所有参数,那么我们默认把实体对象放在第一个位置。
        if(args == null || args.length == 0){
            return;
        }
        Object entity = args[0];//为什么用Object接收,因为实体对象不止一种类型。
        
        //3.准备赋值的数据---时间和当前登录的id(通过ThreadLocal获取id)

        LocalDateTime now = LocalDateTime.now();
        Long currentId = BaseContext.getCurrentId();//当前登录id

        //4.根据当前不同的操作类型,为对应的属性通过反射来赋值
        if(operationType == OperationType.INSERT){
            //为4个公共字段赋值
            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);

                //通过反射为对象属性赋值
                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("setUpdateTime", LocalDateTime.class);
                Method setUpdateUser = entity.getClass().getDeclaredMethod("setUpdateUser", Long.class);

                //通过反射为对象属性赋值

                setUpdateTime.invoke(entity,now);
                setUpdateUser.invoke(entity,currentId);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

    }

}

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

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

在 Mapper 的方法上加入 AutoFill 注解

### Spring Boot 中实现公共字段自动充 在Spring Boot项目中,为了简化代码并减少重复操作,可以采用面向切面编程(AOP)来实现在插入和更新数据库记录时对某些公共字段自动充。这确保了诸如`create_time`、`update_time`、`creator_id`等字段能够自动且一致地获得初始值或最新时间戳。 #### 添加 AOP 依赖 要启用AOP功能,在项目的`pom.xml`文件里加入如下依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> ``` 此依赖项允许定义切面逻辑用于拦截特定的方法调用[^1]。 #### 定义枚举类 `OperateType` 对于不同的业务场景可能需要区分是新增还是修改操作,因此可以通过自定义枚举类型来表示这些情况: ```java public enum OperateType { INSERT, UPDATE; } ``` 该枚举将帮助识别当前正在进行的操作以便于适当地设置相应的时间戳或其他属性。 #### 创建注解 @AutoFill 为了让开发者能够在Mapper接口的方法上标记哪些应该触发自动充行为,建议创建一个新的自定义注解: ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface AutoFill { OperateType value(); } ``` 这个简单的注解接收一个参数指定是要处理插入还是更新事件。 #### 编写 Aspect 切片 最后一步就是编写实际执行自动充工作的Aspect组件。这里假设有一个名为`BaseEntity`的基础实体基类包含了所有待充值的字段,则可以在切面前置通知内完成具体工作: ```java @Component @Aspect @Slf4j public class AutoFillAspect { @Pointcut("@annotation(com.example.demo.annotation.AutoFill)") public void autoFill() {} @Before("autoFill()") public void doAutoFill(JoinPoint joinPoint){ Object[] args = joinPoint.getArgs(); Arrays.stream(args).forEach(arg -> { if (arg instanceof BaseEntity) { BaseEntity baseEntity = (BaseEntity)arg; MethodSignature signature = (MethodSignature)joinPoint.getSignature(); Method method = signature.getMethod(); AutoFill annotation = method.getDeclaredAnnotation(AutoFill.class); OperateType operateType = annotation.value(); switch (operateType) { case INSERT: baseEntity.setCreateTime(new Date()); baseEntity.setUpdateTime(baseEntity.getCreateTime()); break; case UPDATE: baseEntity.setUpdateTime(new Date()); break; } } }); log.info("Automatically filled common fields."); } } ``` 上述代码片段展示了如何利用反射机制访问目标对象及其方法上的元数据,并据此调整实例变量的内容以反映最新的时间和状态变化。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值