【spring】AOP、反射实现公共字段的自动填充,减少代码重复

概要

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

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

实现步骤

  1. 自定义注解 AutoFill,用于标识需要进行公共字段自动填充的方法
  2. 自定义切面类 AutoFillAspect,统一拦截加入了 AutoFill 注解的方法,通过反射为公共字段赋值
  3. 在 Mapper 的方法上加入 AutoFill 注解

技术点

枚举、注解、AOP、反射

代码实现

第一步:
在父模块下建一个annotation包
在这里插入图片描述

在AutoFill里面编写Java代码

/**
 * 自定义注解,用于标识某个方法需要进行功能字段自动填充处理
 */
@Target(ElementType.METHOD)//指定当前注解AutoFill会加在什么位置 是方法上
@Retention(RetentionPolicy.RUNTIME)//固定写法
public @interface AutoFill {
    //指定属性 数据库操作类型:UPDATE INSERT
    OperationType value();
}

其中OperationType已在别的common模块中定义

package com.sky.enumeration;

/**
 * 数据库操作类型
 */
public enum OperationType {

    /**
     * 更新操作
     */
    UPDATE,

    /**
     * 插入操作
     */
    INSERT
}

第二步:
自定义切面 AutoFillAspect

在父模块,创建aspect包
在这里插入图片描述在这里插入图片描述
给mapper里面的插入或修改的方法加上@AutoFill注解
在这里插入图片描述
在这里插入图片描述
之后再进行AutoFillAspect类里面编写前置通知(执行insert或update之前)给公共字段赋值

AutoFillAspect完整代码如下:

/**
 * 自定义切面,实现公共字段自动填充处理逻辑
 */
@Aspect  //切面注解
@Component  //交给bean管理的配置类
@Slf4j   //记录日志
public class AutoFillAspect {

    /**
     * 切入点
     */
    //扫描mapper下的所有类所有方法还要满足方法中加入了AutoFill的注解(插入和修改的方法,查询和删除是不需要的)
    @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();//获得数据库操作类型  是insert还是update类型


        //2.获取到当前被拦截的方法的参数--实体对象   因为是要为实体对象的公共属性赋值比如为实体的创建时间赋值
        Object[] args = joinPoint.getArgs();//获取方法上所有的参数
        if (args == null || args.length == 0) {//没有参数的情况
            return;
        }
        Object entity = args[0];//实体对象作为第一个参数的约定

        //3.准备赋值的数据:   时间和当前登录用户的id
        LocalDateTime now = LocalDateTime.now();//时间
        Long currentId = BaseContext.getCurrentId();//当前登录用户的id

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

                //通过反射为对象属性赋值
                setCreateTime.invoke(entity, now);
                setCreateUser.invoke(entity,currentId);
                setUpdateTime.invoke(entity,now);
                setUpdateUser.invoke(entity,currentId);
            } catch (Exception ex) {
                log.error("公共字段自动填充失败:{}", ex.getMessage());
            }

        }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 ex) {
                log.error("公共字段自动填充失败:{}", ex.getMessage());
            }
        }
    }
}

第三步:删掉之前impl包里面的公共属性赋值的代码,因为已经用上边的切面形式赋值了
在这里插入图片描述

测试

通过观察控制台输出的SQL来确定公共字段填充是否完成
在这里插入图片描述
话不多说,成功完成该功能!

<think>好的,我现在需要帮助用户了解如何使用AOP实现自动填充公共字段。根据用户提供的引用内容,我需要整合这些信息,给出一个清晰的步骤和示例代码。 首先,用户提到了自定义注解@AutoFill,用于标识方法需要自动填充,同时引用了操作类型(INSERT或UPDATE)。这一步应该是定义注解,让AOP能够识别哪些方法需要处理。 接下来,用户提到AOP切面需要在特定的切入点前后执行逻辑,比如填充创建时间、更新时间等字段。根据引用中的信息,可能需要获取方法上的@AutoFill注解,确定操作类型,然后反射设置对应的字段值。 然后,用户引用了mybatis-plus的自动填充功能,但指出需要自己编写SQL时无法使用。因此,用户希望通过AOP实现类似功能,不依赖特定框架的SQL方法。这需要切面在方法执行前或后拦截,并通过反射修改参数对象的字段。 此外,用户需要示例代码。根据引用中的代码片段,应该包括自定义注解的定义、切面类的编写(使用@Aspect和@Component),以及在Mapper接口方法上使用注解的示例。 还需要考虑公共字段填充逻辑,比如insert操作填充createTime和updateTime,update操作填充updateTime。这里可能要用到反射来设置字段值,同时处理可能出现的异常。 最后,要确保回答结构清晰,分步骤说明,并给出代码示例。可能还需要提醒用户注意事务管理和性能影响,以及如何处理继承BaseEntity的实体类。 现在,我需要将这些步骤整理成一个连贯的流程,并确保代码示例正确,符合用户提供的引用内容。同时,检查是否有遗漏的细节,比如注解的Target和Retention设置,切面中的切入点表达式是否正确,以及反射修改字段的权限问题(比如private字段需要setAccessible)。 可能还需要提到使用@Around还是@Before建议,根据用户引用的内容,可能在方法执行前修改参数,所以使用@Around并在proceed之前处理参数。此外,需要确保实体类有对应的字段和setter方法,或者通过反射直接设置字段,即使它们是私有的。 总结步骤:1. 定义注解;2. 创建切面类,拦截注解方法;3. 在切面中根据操作类型填充字段;4. 在Mapper方法上使用注解。同时提供示例代码和注意事项。</think>### 使用AOP实现公共字段自动填充的实践指南 #### 一、核心实现原理 通过自定义注解标记需要自动填充的方法,利用AOP拦截目标方法,通过反射机制动态修改参数对象的公共字段值。这种方法与数据库操作框架解耦,适用于手动编写SQL语句的场景[^3]。 #### 二、具体实现步骤 1. **定义自定义注解** 用于标识需要自动填充数据库操作类型: ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface AutoFill { OperationType value(); // 定义操作类型枚举 } public enum OperationType { INSERT, UPDATE } ``` 2. **创建AOP切面类** ```java @Aspect @Component public class AutoFillAspect { @Around("@annotation(autoFill)") public Object autoFillFields(ProceedingJoinPoint joinPoint, AutoFill autoFill) throws Throwable { // 获取方法参数中的实体对象 Object[] args = joinPoint.getArgs(); for (Object arg : args) { if (arg instanceof BaseEntity) { // 假设所有实体类继承BaseEntity BaseEntity entity = (BaseEntity) arg; OperationType operationType = autoFill.value(); LocalDateTime now = LocalDateTime.now(); // 根据操作类型填充字段 if (operationType == OperationType.INSERT) { entity.setCreateTime(now); entity.setUpdateTime(now); } else if (operationType == OperationType.UPDATE) { entity.setUpdateTime(now); } } } return joinPoint.proceed(args); } } ``` 3. **实体类基类定义** ```java public class BaseEntity { private LocalDateTime createTime; private LocalDateTime updateTime; // getter/setter省略 } ``` 4. **Mapper接口使用示例** ```java @Mapper public interface EmployeeMapper { @AutoFill(OperationType.UPDATE) void update(Employee employee); // 自动填充更新时间[^4] } ``` #### 三、关键优化点 1. **反射优化**:使用`java.beans.PropertyDescriptor`代替直接反射,提高字段访问效率 2. **线程安全**:对时间获取操作使用`ThreadLocal`确保线程安全 3. **操作人填充**:结合SecurityContext获取当前用户信息填充`updateUser`字段 #### 四、注意事项 1. 实体类需要继承公共基类或实现特定接口 2. 需要开启AOP支持:在Spring Boot启动类添加`@EnableAspectJAutoProxy` 3. 字段访问权限:若字段为`private`,需调用setter方法或设置`field.setAccessible(true)`
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

@¥文竹¥

你的鼓励是我最大的动力!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值