aop实现公共字段自动填充

已于 2024-10-11 10:55:50 修改
阅读量649 收藏 5
点赞数 12
文章标签： spring java mysql
于 2024-10-11 10:50:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_62818371/article/details/142845083
版权

简介：苍穹外卖p31-p34

遇到问题

问题分析

当进行Insert操作时，每次都需要对创建时间、创建者id、修改时间和修改者id进行赋值；当进行Update操作时，每次都需要对修改时间和修改者id进行复制；

缺点

代码冗余，易出错，可读性下降，测试变复杂，增加性能开销，维护成本增加

在这里插入图片描述

四种解决方法

为了减少冗余，建议采取以下措施：
1、封装操作逻辑：将重复的赋值逻辑抽象到一个方法中，确保每次插入和更新时都能调用这些方法。
2、使用 ORM 框架的生命周期回调：如前述，利用 ORM 框架的功能自动管理这些字段，避免手动赋值。
3、服务层管理：通过服务层统一管理业务逻辑，在插入和更新时设置相关字段。
4、AOP 或拦截器：使用切面编程来处理这些通用的赋值逻辑，避免在每个业务逻辑中重复代码。
在这里插入图片描述

AOP 或拦截器方法具体实现

一、创建在定义注解

在这里插入图片描述

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，DELETE
    OperationType value();
}

OperationType为枚举类：类型枚举

package com.sky.enumeration;

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

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

    /**
     * 插入操作
     */
    INSERT

}

二、创建切面类

在这里插入图片描述

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;

/**
 * 自定义切面，实现公共字段自动填充处理逻辑
 */
@Aspect//表明它是一个切面
@Component//这也是一个Bean，需要Spring管理
@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 entity = args[0];//获取当前被拦截方法的第一个参数，因为实体不是固定的，所以使用Object接收；约定：被拦截方法的第一个参数必须是实体类型的

        //准备赋值的数据
        LocalDateTime now = LocalDateTime.now();
        Long currentId = BaseContext.getCurrentId();//从ThreadLocal中获取当前用户的id（当前用户在登录时，拦截器类获取token令牌，解析并将当前用户id存进ThreadLocal中）

        //根据当前不同的操作类型，为对应的属性通过反射来赋值
        if (operationType == OperationType.INSERT){
            //为4个公共字段赋值
            try {
                //entity是Object类型，没有get,set方法，必须通过反射获得方法
                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");

                //通过反射为对象属性赋值
                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 {
                //entity是Object类型，没有get,set方法，必须通过反射获得方法
                Method setUpdateTime = entity.getClass().getDeclaredMethod("setUpdateTime", LocalDateTime.class);
                Method setUpdateUser = entity.getClass().getDeclaredMethod("setUpdateUser");

                //通过反射为对象属性赋值
                setUpdateTime.invoke(entity,now);
                setUpdateUser.invoke(entity,currentId);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

在这里插入图片描述

三、在需要进行拦截的方法上加上自定义注解AutoFill

    /**
     * 插入员工数据
     * @param employee
     */
    @Insert(value = "Insert into employee (name, username, password, phone, sex, id_number, create_time, update_time, create_user, update_user,status) " +
            "value " +
            "(#{name},#{username},#{password},#{phone},#{sex},#{idNumber},#{createTime},#{updateTime},#{createUser},#{updateUser},#{status})")
    @AutoFill(value = OperationType.INSERT)//在需要进行自动填充的方法中加入注解，并写明操作类型
    void addEmployee(Employee employee);

四种解决方法具体说明

为了减少冗余，可以采用以下措施，每种方法都可以提高代码的可维护性和可读性。以下是针对每个措施的具体说明：

1. 封装操作逻辑

实现步骤：

  • 创建一个工具类或服务类，专门负责处理创建时间、修改时间、创建者 ID 和修改者 ID 的赋值逻辑。
  • 定义一个方法，例如 setAuditFields(entity, isNew)，该方法接受要操作的实体和一个布尔值 isNew（表示是否为新创建的记录）。

示例代码：

public class AuditUtil {
    public static void setAuditFields(MyEntity entity, boolean isNew) {
        if (isNew) {
            entity.setCreatedTime(new Date());
            entity.setCreatedBy(currentUserId());
        }
        entity.setModifiedTime(new Date());
        entity.setModifiedBy(currentUserId());
    }
}

调用方式：
在插入或更新前调用该方法：

AuditUtil.setAuditFields(entity, true); // 对于插入
AuditUtil.setAuditFields(entity, false); // 对于更新

2. 使用 ORM 框架的生命周期回调

实现步骤：

  • 在实体类中使用 ORM 框架（如 Hibernate 或 JPA）的注解来标记生命周期回调方法。这些方法会在插入或更新实体时被自动调用。

示例代码：

@Entity
public class MyEntity {
    @Column(name = "created_time")
    private Date createdTime;

    @Column(name = "modified_time")
    private Date modifiedTime;

    @PrePersist
    public void prePersist() {
        this.createdTime = new Date();
        this.modifiedTime = new Date();
    }

    @PreUpdate
    public void preUpdate() {
        this.modifiedTime = new Date();
    }
}

3. 服务层管理

实现步骤：

  • 在服务层定义通用的方法，用于插入和更新操作。在这些方法中集中管理相关字段的赋值逻辑。

示例代码：

@Service
public class MyEntityService {
    public void save(MyEntity entity) {
        setAuditFields(entity, true);
        myEntityRepository.save(entity);
    }

    public void update(MyEntity entity) {
        setAuditFields(entity, false);
        myEntityRepository.save(entity);
    }

    private void setAuditFields(MyEntity entity, boolean isNew) {
        if (isNew) {
            entity.setCreatedTime(new Date());
            entity.setCreatedBy(currentUserId());
        }
        entity.setModifiedTime(new Date());
        entity.setModifiedBy(currentUserId());
    }
}

4. AOP 或拦截器

实现步骤：

  • 使用 AOP（面向切面编程）来创建一个切面，拦截所有需要的服务方法，在执行前后加入赋值逻辑。

示例代码：

@Aspect
@Component
public class AuditAspect {
    @Before("execution(* com.example.service.MyEntityService.save(..))")
    public void beforeSave(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        if (args[0] instanceof MyEntity) {
            MyEntity entity = (MyEntity) args[0];
            entity.setCreatedTime(new Date());
            entity.setCreatedBy(currentUserId());
        }
    }

    @Before("execution(* com.example.service.MyEntityService.update(..))")
    public void beforeUpdate(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        if (args[0] instanceof MyEntity) {
            MyEntity entity = (MyEntity) args[0];
            entity.setModifiedTime(new Date());
            entity.setModifiedBy(currentUserId());
        }
    }
}

总结

通过上述四种方法，可以有效地减少代码中的冗余，确保创建和修改时间、创建者 ID 和修改者 ID 等字段的一致性和正确性。这不仅提高了代码质量，还减少了未来维护和修改的成本。选择具体的实现方式可以根据项目的需求、团队的技术栈和约定进行调整。

当然可以更详细地讨论 AOP（面向切面编程）。以下是对 AOP 相关概念的深入解析，包括示例和应用场景。

AOP（面向切面编程）

对 AOP 相关概念的深入解析

1. 横切关注点

横切关注点可以理解为那些影响多个模块或组件的功能，而不直接属于任何单一模块。例如：

  • 日志记录：在不同的服务中可能都需要记录日志。
  • 安全性：访问控制、用户认证等通常需要跨多个模块处理。
  • 事务管理：在数据库操作中，涉及到多个方法时，需要确保事务的一致性。

2. 切面（Aspect）

切面是 AOP 的核心，它封装了与横切关注点相关的代码。切面包括两部分：

  • 切入点（Pointcut）：定义哪些连接点会被切面影响。
  • 通知（Advice）：定义在切入点触发时执行的逻辑。
示例
@Aspect
public class LoggingAspect {
    
    @Pointcut("execution(* com.example.service.*.*(..))")
    public void serviceLayer() {}

    @Before("serviceLayer()")
    public void logBefore(JoinPoint joinPoint) {
        System.out.println("Before method: " + joinPoint.getSignature());
    }
}

在这个示例中，serviceLayer() 定义了切入点，即所有 com.example.service 包下的方法，logBefore() 是前置通知，在方法执行前记录日志。

3. 连接点（Join Point）

连接点是程序执行过程中的某个特定位置。在 Spring AOP 中，连接点通常是方法调用。AOP 框架会在这些连接点插入切面逻辑。

4. 代理（Proxy）

AOP 实现通常依赖于代理模式。代理可以是：

  • 静态代理：在编译时生成代理类。
  • 动态代理：在运行时创建代理对象。
示例（动态代理）

使用 Spring AOP 时，框架会自动创建代理。例如，使用 JDK 动态代理或 CGLIB 代理来增强目标类的功能。

5. AOP 框架

Spring AOP
  • 集成在 Spring 框架中，适用于在 Spring 管理的 Bean 上使用 AOP。
  • 主要通过注解（如 @Aspect, @Before）或 XML 配置进行切面定义。
AspectJ
  • 更强大的 AOP 框架，支持编译时和运行时织入。
  • 提供了更复杂的切入点表达式和更全面的功能。

6. 使用场景

以下是一些常见的 AOP 使用场景：

  • 日志管理：统一处理系统的日志记录，避免在每个方法中重复代码。
  • 性能监控：监控方法的执行时间，以便进行性能优化。
  • 异常处理：集中管理业务逻辑中的异常处理，提供统一的错误响应。
  • 安全控制：在方法调用前验证用户权限，确保只有授权用户能够访问特定功能。
  • 事务管理：在数据库操作中管理事务的开始和提交，避免重复代码。

7. 优缺点

优点
  • 提高代码可重用性：将横切关注点提取到切面中，减少重复代码。
  • 增强模块化：使业务逻辑和横切关注点分开，便于管理和维护。
  • 提高可维护性：修改横切关注点的逻辑只需更新切面，而不是逐个查找和修改。
缺点
  • 学习曲线陡峭：初学者可能需要时间来理解 AOP 的概念和实现方式。
  • 调试困难：由于切面逻辑是动态插入的，可能导致调试时难以追踪问题。
  • 性能开销：在高频调用的场景下，AOP 可能引入一定的性能开销。

8. 结论

AOP 是一种有效的编程技术，通过将横切关注点从业务逻辑中分离出来，使得代码更加整洁和可维护。在现代软件开发中，特别是在微服务架构和企业应用中，AOP 得到了广泛应用。掌握 AOP 可以帮助开发者更好地组织代码，提高系统的可维护性和扩展性。

╰つ゛木槿
关注
Aop实现公共字段自动填充
qq_45525848的博客
04-03 1190
Aop实现公共字段自动填充
AOP如何实现公共字段自动填充
一起加油吧！
11-30 571
其中的create_time、update_time、create_username、update_username都是属于是表的公共字段，如果每次在进行插入或者更新操作时都要手动赋值是很繁琐的。通过AOP实现公共字段自动填充，只需给mapper层中的对应方法加上注解即可。
【SpringBoot】SpringAOP实现公共字段自动填充
Infinity的博客
07-20 397
Target 指定可以使用注解的类型@Retention 指定合适使用value指定注解值得类型// 操作类型 OperationType value();// 操作类型 OperationType value();// 操作类型 OperationType value();// 操作类型 OperationType value();// 操作类型 OperationType value();
AOP来实现公共字段自动填充
m0_64559011的博客
03-27 657
*** 数据库操作类型*//*** 更新操作*/UPDATE,/*** 插入操作*/INSERT。
AOP实现公共字段填充
一杯冰美式的博客
05-03 430
我们都是通过编码操作数据库，当我们完成某些业务时，会向数据库插入一条数据，或者修改数据库时，会有一些公共字段，例如（新增）修改时间或（新增）修改人。如果每次都手动去设置这些值是非常麻烦的。Spring Aop思想恰好可以用来解决这个问题。
使用SpringAOP实现公共字段填充
Very_a的博客
08-05 992
在实现公共字段自动填充，也就是在插入或者更新的时候为指定字段赋予指定的值，使用它的好处就是可以统一对这些字段进行处理，避免了重复代码。1). 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser设置为当前登录用户ID。2). 自定义切面类 AutoFillAspect，统一拦截加入了 AutoFill 注解的方法，通过反射为公共字段赋值。时需要设置修改时间、修改人等字段。时需要设置创建时间、创建人、修改时间、修改人等字段，在。
实现公共字段自动填充
庭前云落的博客
07-06 496
*** 自定义注解，用于标识某个方法需要进行功能字段自动填充处理//数据库操作类型：UPDATE INSERT OperationType value();/*** 数据库操作类型/*** 更新操作* 插入操作/**/*** 切入点} /*** 前置通知，在通知中进行公共字段的赋值log . info("开始进行公共字段自动填充...");
AOP切面公共字段自动填充
weixin_73253843的博客
08-06 769
在Spring框架中，AOP可以应用于各种场景，如事务管理、缓存、日志、权限控制等，可以大大简化程序设计和代码维护工作，同时Spring框架还提供了各种AOP相关的注解和工具类，使得AOP的使用变得更加简单和方便
公共字段自动填充aop
TenSonLee的博客
09-30 1784
在项目开发中，我们的数据库设计往往会包括创建人、创建时间、修改人、修改时间等公共字段，这些公共字段有助于帮助我们知道是谁对数据库记录进行了更改，但这带来的一个问题就是在进行数据库插入或修改的时候，这些字段需要手动设置，这会给我们带来很大不便，这里我简单讲一下采用aop方式进行公共字段填充，因为项目集成了tk.mybatis，很多单表的操作并没有显示指定接口，所以采用在service层方法进行切入来...
【Spring】AOP实现公共字段填充
专注于Java领域开发 关注我 带你玩转Java
12-02 1116
只知道SpringAOP概念？不妨看看项目中AOP怎么使用
Spring Boot进阶(03)：【实战教程】MyBatis-Plus秒级实现字段自动填充，让你的代码更优雅！
**My Coding Family**
04-03 9984
如何使用MyBatis-Plus提供的@TableField注解实现字段自动填充？这你若不会，还不点进来瞅瞅！或许就捡到宝啦。
AOP面向切面编程——实现公共字段填充
qq_59708493的博客
12-03 208
进入到sky-server模块，创建com.sky.annotation包。1). 自定义注解 AutoFill，用于标识需要进行公共字段自动填充的方法 2). 自定义切面类 AutoFillAspect，统一拦截加入了 AutoFill 注解的方法，通过反射为公共字段赋值 3). 在 Mapper 的方法上加入 AutoFill 注解 若要实现上述步骤，需掌握以下知识(之前课程内容都学过) **技术点：**枚举、注解、AOP、反射
Java的AOP修改参数、Mybatis拦截器实现自动填充
Java_LingFeng的博客
10-31 1412
Spring核心是 IOC 和 AOP 。 所谓IoC，对于spring框架来说，就是由spring来负责控制对象的生命周期和对象间的关系。 至于更详细的说明，或者去深入理解Spring这两大核心，不是此篇文章的目的，暂不细说了。 我们在Spring项目中，我们需要将Bean交给Spring容器，也就是IOC管理，这样你才可以使用注解来进行依赖注入。
Spring MVC的运行流程详解
J老熊
10-03 1078
Spring MVC作为一个广泛使用的框架，提供了灵活且强大的MVC架构支持。尤其在业务系统中，Spring MVC能够有效地处理大量并发请求，提供良好的用户体验。本文将详细讲解Spring MVC的运行流程，以电商交易系统为案例，帮助读者深入理解其工作原理。
美发店管理革新：SpringBoot系统的应用
最新发布
2401_85743969的博客
10-10 773
同时，一个大型的计算机网站系统，必须有一个正确的设计指导思想，通过合理选择数据结构、网络结构、操作系统以及开发环境，构成一个完善的网络体系结构，才能充分发挥计算机信息管理的优势。随着计算机技术的发展以及计算机网络的逐渐普及，互联网成为人们查找信息的重要场所，二十一世纪是信息的时代，所以信息的管理显得特别重要。随着互联网技术的快速发展，网络时代的到来，网络信息也将会改变当今社会。2.高可靠性：一个实用的网站同时必须是可靠的，本设计通过合理而先进的网络设计以及软、硬件的优化选型，可保证网站的可靠性与容错性。
netty之SpringBoot+Netty+Elasticsearch收集日志信息数据存储
CSDN_LiMingfly的博客
10-04 872
将大量的业务以及用户行为数据存储起来用于分析处理，但是由于数据量较大且需要具备可分析功能所以将数据存储到文件系统更为合理。尤其是一些互联网高并发级应用，往往数据库都采用分库分表设计，那么将这些分散的数据通过binlog汇总到一个统一的文件系统就显得非常有必要。#开发环境环境准备windows安装包 下载注意 es是以来java环境 所以需要安装jdk 支持1.7以上es-hander下载可视化操作插件@Id//姓名//年龄//级别//时间//电话//邮箱//地址。
毕业设计_基于springboot+layui+mybatisPlus的中小型仓库物流管理系统源码+SQL+教程+可运行】41004
pingguocu3的博客
10-04 964
毕业设计--课程设计--springboot--java 登录管理员账号：system 密码：123456 验证码输入：注意验证码字母要大写。启动项目后运行http://locahost:8080跳转到登录界面即可。后端：springboot、mybatis-plus、shiro。application.yml文件中的数据库连接信息。运行sql目录下的warehouse.sql文件。1.基础管理：商品管理、客户管理、供应商管理；2.物流管理：进货管理、发货管理、交付管理...
旅游管理系统开发新篇章：SpringBoot技术解析
2401_85812053的博客
10-07 602
通过实践让我获得了实践经验。在这次设计中我得到了老师和同学的指导和帮助，使我们认识到团队精神的重要性，因为一个人所学的知识不可能面面俱到的，只有通过合作，发挥自己的优点，体现团队精神，才能使工作做得更为出色。我们开发的是一套常州地方旅游管理系统，我们可以把常州地方旅游管理系统系统配置在远程的服务器上，在得到访问权限之后，只要能够上网就可以使用和访问该系统并进行相关的操作，这样的一种先进模式我们之后只需要对服务器上的程序进行维护即可保证程序的正常使用，大大的提高了工作效率，降低了维护的成本。
mybatis的aop自动填充
11-01
MyBatis Plus提供了一个自动填充的功能，可以通过AOP的方式实现。具体实现步骤如下： 1. 创建一个实现了MetaObjectHandler接口的类，该类中实现了insertFill和updateFill方法，用于填充需要自动填充的字段。 2. 在需要自动填充的实体类中，使用@TableField注解标注需要自动填充的字段，并设置fill属性为FieldFill.INSERT或FieldFill.UPDATE或FieldFill.INSERT_UPDATE。 3. 在MyBatis的配置文件中，配置自动填充插件，指定上一步中创建的实现了MetaObjectHandler接口的类。 通过以上步骤，就可以实现MyBatis Plus的自动填充功能了。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

╰つ゛木槿

你的鼓励将是我创作的最大动力

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

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

打赏作者

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

抵扣说明：

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

余额充值