SpringBoot公共字段自动填充（反射+AOP+自定义注解）

最新推荐文章于 2024-06-13 10:26:45 发布
最新推荐文章于 2024-06-13 10:26:45 发布
阅读量1.2k 收藏 12
点赞数 18
分类专栏： JavaWeb学习笔记 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42736179/article/details/137522206
版权

问题分析

在上一章节我们已经完成了后台系统的员工管理功能和菜品分类功能的开发，在新增员工或者新增菜品分类时需要设置创建时间、创建人、修改时间、修改人等字段，在编辑员工或者编辑菜品分类时需要设置修改时间、修改人等字段。这些字段属于公共字段，也就是也就是在我们的系统中很多表中都会有这些字段，如下：

序号字段名含义数据类型
1create_time创建时间datetime
2create_user创建人idbigint
3update_time修改时间datetime
4update_user修改人idbigint

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

1). 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser设置为当前登录用户ID。

2). 在更新数据时, 将updateTime 设置为当前时间, updateUser设置为当前登录用户ID。

目前,在我们的项目中处理这些字段都是在每一个业务方法中进行赋值操作，编码相对冗余、繁琐，那能不能对于这些公共字段在某个地方统一处理，来简化开发呢？

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

实现思路

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

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

实现步骤：

1). 自定义注解 AutoFill，用于标识需要进行公共字段自动填充的方法（mapper中涉及insert、update的方法，通过AutoFill注解标识这些需要AOP的方法）

2). 自定义切面类 AutoFillAspect，统一拦截加入了 AutoFill 注解的方法，通过反射为公共字段赋值（定义切入点【拦截什么请求】和通知【对拦截的请求做什么额外的代码补充与增强】）

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

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

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

 

代码开发

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

步骤一

自定义注解 AutoFill

进入到sky-server模块，创建com.sky.annotation包。

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

其中OperationType（枚举类型）已在sky-common模块中定义

package com.sky.enumeration;

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

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

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

步骤二

自定义切面 AutoFillAspect

在sky-server模块，创建com.sky.aspect包。

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.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(){}

    /**
     * 前置通知，在通知中进行公共字段的赋值
     */
    @Before("autoFillPointCut()")
    public void autoFill(JoinPoint joinPoint){
        log.info("开始进行公共字段自动填充...");

        //获取到当前被拦截的方法上的数据库操作类型
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象
        AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
        OperationType operationType = autoFill.value();//获得数据库操作类型

        //获取到当前被拦截的方法的参数--实体对象
        Object[] args = joinPoint.getArgs();
        if(args == null || args.length == 0){
            return;
        }
        //约定不管有多少参数，都把实体对象作为第一个参数
	   //一定要用Object封装，因为实体对象的类型可能会变
        Object entity = args[0];

        //准备赋值的数据
        LocalDateTime now = LocalDateTime.now();
        Long currentId = BaseContext.getCurrentId();

        //根据当前不同的操作类型，为对应的属性通过反射来赋值
        if(operationType == OperationType.INSERT){
            //为4个公共字段赋值
            
            try {
                //获取实体对象的set方法
                //entity.getClass().getDeclaredMethod(方法名，方法参数)
                //entity是Object类型，没有getset方法，必须通过反射获得方法
                //为什么是AutoFillConstant，而不是直接是"setCreateTime"：因为不想把代码写死，所以用常量类封装
                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 e) {
                e.printStackTrace();
            }
        }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 e) {
                e.printStackTrace();
            }
        }
    }
}

细节一：切入点定义

    /**
     * 切入点
     */
    @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
    public void autoFillPointCut(){}

* com.sky.mapper.*.*(..)从头到尾的解释是：任何修饰符、sky.mapper包、任意类、任意方法、（任意参数）

但是我们只需要update和insert类型，于是加上一句声明，只需要定义了AutoFill注解的方法

细节三：通知

/**
     * 前置通知，在通知中进行公共字段的赋值
     */
    @Before("autoFillPointCut()")
    public void autoFill(JoinPoint joinPoint){
        log.info("开始进行公共字段自动填充...");

        //获取到当前被拦截的方法上的数据库操作类型
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法签名对象
        AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
        OperationType operationType = autoFill.value();//获得数据库操作类型

        //获取到当前被拦截的方法的参数--实体对象
        Object[] args = joinPoint.getArgs();
        if(args == null || args.length == 0){
            return;
        }
        //约定不管有多少参数，都把实体对象作为第一个参数
	   //一定要用Object封装，因为实体对象的类型可能会变
        Object entity = args[0];

        //准备赋值的数据
        LocalDateTime now = LocalDateTime.now();
        Long currentId = BaseContext.getCurrentId();

        //根据当前不同的操作类型，为对应的属性通过反射来赋值
        if(operationType == OperationType.INSERT){
            //为4个公共字段赋值
            
            try {
                //获取实体对象的set方法
                //entity.getClass().getDeclaredMethod(方法名，方法参数)
                //entity是Object类型，没有getset方法，必须通过反射获得方法
                //为什么是AutoFillConstant，而不是直接是"setCreateTime"：因为不想把代码写死，所以用常量类封装
                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 e) {
                e.printStackTrace();
            }
        }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 e) {
                e.printStackTrace();
            }
        }

利用反射获取了对应类的set方法

TOKI不吃海鲜
关注
  • 18
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
springBoot+aop+自定义注解+本地线程实现统一接口日志及接口响应时长
02-01
内容概要：springboot+拦截器+aop+自定义注解+本地线程实现统一接口日志记录，记录下接口所在模块、接口描述、接口请求参数、接口返回参数、接口请求时间以及接口耗时用于接口优化，接口记录参数以及操作人防止使用...
SpringBoot第 9 讲：SpringBoot+AOP
10-10
aop_demo.zip
反射获得一个字段的属性值，和修改一个字段的属性值
alice_nn的博客
12-06 786
我们经常遇到一个集合中替换一个对象的一个字段值和另一个字段值。 比如替换一个集合中所有对象的uid为uname; 可以使用反射，制定原字段名和被替换的字段名 public static Object getFieldValueByObject (Object object , String targetFieldName) throws Exception { // 获取该对象的Class Cla...
SpringBoot+自定义注解+AOP实现对创建人修改人自动赋值
qq_28491989的博客
02-16 1001
SpringBoot+自定义注解+AOP实现对创建人修改人自动赋值
Java Spring 通过 AOP 实现方法参数的重新赋值、修改方法参数的取值
emmmm.....
10-23 3708
方式一：通过环绕通知实现 方式二：通过前置通知 + 反射实现
Sping Boot 自定义注解使用示例
weixin_42256765的博客
06-29 280
spring boot 自定义注解使用
SpringBoot之自定义注解及Java反射机制实现对实体类某些字段记录日志的功能
yuanjinshenglife的专栏
02-29 566
SpringBoot之自定义注解及Java反射机制实现对实体类某些字段记录日志的功能
SpringBoot公共字段自动填充（自定义注解、AOP、反射）
weixin_47521669的博客
05-24 412
SpringBoot公共字段自动填充（自定义注解、AOP、反射）
【SpringBoot】公共字段自动填充功能实现（枚举、自定义注解、AOP、反射）
小秀的博客
01-06 787
使用@interface语法来定义注解（Annotation）。注解的参数类似无参数方法，可以用default设定一个默认值，比如。元注解：有一些注解可以修饰其他注解，这些注解就称为元注解（meta annotation）。@Target使用@Target可以定义Annotation；；；；。@Retention元注解@Retention定义了Annotation；；。如果@Retention不存在，则该Annotation默认为CLASS。但是通常我们自定义的。
实现公共字段自动填充（自定义注解和aop面向切面编程）
qq_64376339的博客
02-13 1303
自定义注解是Java中的一种特殊类型，用于为代码添加元数据。通过使用自定义注解，您可以在编译时或运行时对代码进行操作和处理。1. 使用`@interface`关键字定义注解。2. 为注解添加元素（可选）。3. 使用元注解（如`@Retention`、`@Target`等）来指定注解的行为。// 定义一个名为MyAnnotation的自定义注解@Target(ElementType.METHOD) // 指定该注解只能用于方法上。
AOP+自定义注解+反射 实现自动填充字段
MaoSLv的博客
01-06 673
AOP+自定义注解+反射 实现自动填充字段
使用SpringBoot通过自定义注解+AOP+全局异常处理实现参数统一非空校验源码
01-06
使用SpringBoot通过自定义注解+AOP+全局异常处理实现参数统一非空校验
SpringBoot中的AOP+自定义注解（源代码）
03-10
SpringBoot 中的 Aop + 自定义注解 1. @AspectJ 1.1 `@AspectJ` 切面类 1.2 `@Pointcut` 创建切入点 1.3 通知 1.4 Spring AOP 和 AspectJ AOP 有什么区别？ 2. 在 SpringBoot 中使用 Aop 功能 2.0 创建一个...
基于springboot+mvc+freemarker+aop实现校友信息管理系统源码.zip
01-08
1、基于springboot+mvc+freemarker+aop实现校友信息管理系统源码.zip 2、该资源包括项目的全部源码，下载可以直接使用！ 3、本项目适合作为计算机、数学、电子信息等专业的课程设计、期末大作业和毕设项目，作为参考...
Spring boot注解学习
程序猿一只
06-09 899
spring boot 核心注解，加在Spring boot 主类之上，是@Configuration、@EnableAutoConfiguration、@ComponentScan 注解的集合。（1）@Configuration：允许以@Bean注解将对象托管给spring容器，即支持将@Bean注解的方法返回的对象控制反转。
Spring Boot中使用logback出现LOG_PATH_IS_UNDEFINED文件夹
最新发布
mhbsoft的博客
06-13 214
1.首先查看，application.properties 文件是否按格式编写。
spring boot jwt 实现用户登录完整java
qq_62383709的博客
06-04 553
保护所有受保护的接口增加jwt合法性逻辑 custom.interceptor.AuthenticationInterceptor。我们约定，前端登录后，后续请求都将JWT，放置于HTTP请求的Header中，其Header的key为。登录接口需要为登录成功的用户创建并返回JWT，本项目使用开源的JWT工具。创建JWT和工具类 common.utils.JwtUtil。用户登录的校验逻辑分为三个主要步骤，分别是。，配置如下，具体内容可参考。controller逻辑。编写mapper逻辑。
使用java+springboot+springaop+redistemplate+自定义注解，写一个分布式锁
03-21
可以使用 RedisTemplate 实现分布式锁，具体实现步骤如下： 1. 定义一个自定义注解，用于标识需要加锁的方法。 2. 在方法执行前获取锁，执行后释放锁。 3. 使用 RedisTemplate 操作 Redis，实现分布式锁。 下面是示例代码： ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface DistributedLock { String key(); long expire() default 30000; } @Component @Aspect public class DistributedLockAspect { @Autowired private RedisTemplate<String, String> redisTemplate; @Around("@annotation(distributedLock)") public Object doAround(ProceedingJoinPoint joinPoint, DistributedLock distributedLock) throws Throwable { String key = distributedLock.key(); long expire = distributedLock.expire(); // 获取锁 boolean locked = false; String lockKey = "lock:" + key; String lockValue = UUID.randomUUID().toString(); try { locked = redisTemplate.opsForValue().setIfAbsent(lockKey, lockValue, expire, TimeUnit.MILLISECONDS); if (!locked) { throw new RuntimeException("获取锁失败"); } // 执行方法 return joinPoint.proceed(); } finally { // 释放锁 if (locked) { String value = redisTemplate.opsForValue().get(lockKey); if (lockValue.equals(value)) { redisTemplate.delete(lockKey); } } } } } ``` 在需要加锁的方法上加上 @DistributedLock 注解，指定锁的 key 和过期时间即可。 例如： ```java @Service public class UserService { @Autowired private UserDao userDao; @DistributedLock(key = "user:update:${#userId}") public void updateUser(long userId, String name) { userDao.updateUser(userId, name); } } ``` 这样就可以实现分布式锁了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值