基于SpringBoot+Redis的前后端分离外卖项目-苍穹外卖(五)

￡神魔★判官ぃ 2024-04-17 10:08 37阅读 0赞

#### 公共字段自动填充 ####

*   *   *  1.1 问题分析
         *  1.2 实现思路
         *  1.3 代码开发
         *   *  1.3.1 步骤一
             *  1.3.2 步骤二
             *  1.3.3 步骤三
         *  1.4 功能测试

#### 1.1 问题分析 ####

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

<table> 
 <thead> 
  <tr> 
   <th><strong>序号</strong></th> 
   <th><strong>字段名</strong></th> 
   <th><strong>含义</strong></th> 
   <th><strong>数据类型</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>create_time</td> 
   <td>创建时间</td> 
   <td>datetime</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>create_user</td> 
   <td>创建人id</td> 
   <td>bigint</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>update_time</td> 
   <td>修改时间</td> 
   <td>datetime</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>update_user</td> 
   <td>修改人id</td> 
   <td>bigint</td> 
  </tr> 
 </tbody> 
</table>

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

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

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

在项目中处理这些字段都是在每一个业务方法中进行赋值操作,如下:

**新增员工方法：**

/**
         * 新增员工
         *
         * @param employeeDTO
         */
        public void save(EmployeeDTO employeeDTO) {
        
            //.......................
    		//
            //设置当前记录的创建时间和修改时间
            employee.setCreateTime(LocalDateTime.now());
            employee.setUpdateTime(LocalDateTime.now());
    
            //设置当前记录创建人id和修改人id
            employee.setCreateUser(BaseContext.getCurrentId());//目前写个假数据，后期修改
            employee.setUpdateUser(BaseContext.getCurrentId());
    		///
            employeeMapper.insert(employee);
        }

**编辑员工方法：**

/**
         * 编辑员工信息
         *
         * @param employeeDTO
         */
        public void update(EmployeeDTO employeeDTO) {
        
           //........................................
    	   ///
            employee.setUpdateTime(LocalDateTime.now());
            employee.setUpdateUser(BaseContext.getCurrentId());
           ///
    
            employeeMapper.update(employee);
        }

**新增菜品分类方法：**

/**
         * 新增分类
         * @param categoryDTO
         */
        public void save(CategoryDTO categoryDTO) {
        
           //....................................
           //
            //设置创建时间、修改时间、创建人、修改人
            category.setCreateTime(LocalDateTime.now());
            category.setUpdateTime(LocalDateTime.now());
            category.setCreateUser(BaseContext.getCurrentId());
            category.setUpdateUser(BaseContext.getCurrentId());
            ///
    
            categoryMapper.insert(category);
        }

**修改菜品分类方法：**

/**
         * 修改分类
         * @param categoryDTO
         */
        public void update(CategoryDTO categoryDTO) {
        
            //....................................
            
    		//
            //设置修改时间、修改人
            category.setUpdateTime(LocalDateTime.now());
            category.setUpdateUser(BaseContext.getCurrentId());
            //
    
            categoryMapper.update(category);
        }

如果都按照上述的操作方式来处理这些公共字段, 需要在每一个业务方法中进行操作, 编码相对冗余、繁琐，那能不能对于这些公共字段在某个地方统一处理，来简化开发呢？

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

#### 1.2 实现思路 ####

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

<table> 
 <thead> 
  <tr> 
   <th><strong>序号</strong></th> 
   <th><strong>字段名</strong></th> 
   <th><strong>含义</strong></th> 
   <th><strong>数据类型</strong></th> 
   <th><strong>操作类型</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>create_time</td> 
   <td>创建时间</td> 
   <td>datetime</td> 
   <td>insert</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>create_user</td> 
   <td>创建人id</td> 
   <td>bigint</td> 
   <td>insert</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>update_time</td> 
   <td>修改时间</td> 
   <td>datetime</td> 
   <td>insert、update</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>update_user</td> 
   <td>修改人id</td> 
   <td>bigint</td> 
   <td>insert、update</td> 
  </tr> 
 </tbody> 
</table>

**实现步骤：**

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

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

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

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

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

#### 1.3 代码开发 ####

##### 1.3.1 步骤一 #####

**自定义注解 AutoFill**

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

package com.sky.annotation;
    
    
    /**
     * 自定义注解，用于标识某个方法需要进行功能字段自动填充处理
     */
    @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
    }

##### 1.3.2 步骤二 #####

**自定义切面 AutoFillAspect**

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

package com.sky.aspect;
    
    /**
     * 自定义切面，实现公共字段自动填充处理逻辑
     */
    @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){
        
            /重要
            //可先进行调试，是否能进入该方法 提前在mapper方法添加AutoFill注解
            log.info("开始进行公共字段自动填充...");
    
        }
    }

**完善自定义切面 AutoFillAspect 的 autoFill 方法**

package com.sky.aspect;
    
    import .......
    
    /**
     * 自定义切面，实现公共字段自动填充处理逻辑
     */
    @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 entity = args[0];
    
            //准备赋值的数据
            LocalDateTime now = LocalDateTime.now();
            Long currentId = BaseContext.getCurrentId();
    
            //根据当前不同的操作类型，为对应的属性通过反射来赋值
            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 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();
                }
            }
        }
    }

##### 1.3.3 步骤三 #####

**在Mapper接口的方法上加入 AutoFill 注解**

以**CategoryMapper**为例，分别在新增和修改方法添加@AutoFill()注解，也需要**EmployeeMapper**做相同操作

package com.sky.mapper;
    
    @Mapper
    public interface CategoryMapper {
        
        /**
         * 插入数据
         * @param category
         */
        @Insert("insert into category(type, name, sort, status, create_time, update_time, create_user, update_user)" +
                " VALUES" +
                " (#{type}, #{name}, #{sort}, #{status}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser})")
        @AutoFill(value = OperationType.INSERT)
        void insert(Category category);
        /**
         * 根据id修改分类
         * @param category
         */
        @AutoFill(value = OperationType.UPDATE)
        void update(Category category);
    
    }

**同时**，将业务层为公共字段赋值的代码注释掉。

1). 将员工管理的新增和编辑方法中的公共字段赋值的代码注释。

2). 将菜品分类管理的新增和修改方法中的公共字段赋值的代码注释。

#### 1.4 功能测试 ####

以**新增菜品分类**为例，进行测试

**启动项目和Nginx**

![在这里插入图片描述][b98ddc1009654855bf7b88e9372a5711.png]

**查看控制台**

通过观察控制台输出的SQL来确定公共字段填充是否完成  
![在这里插入图片描述][e5a4c83881324b4293dfe2faa10d6b50.png]

**查看表**

category表中数据  
![在这里插入图片描述][dacf93873c694463bbdb930dbd2dbc87.png]

其中create\_time,update\_time,create\_user,update\_user字段都已完成自动填充。

由于使用admin(id=1)用户登录进行菜品添加操作,故create\_user,update\_user都为1.

**后记  
????美好的一天，到此结束，下次继续努力！欲知后续，请看下回分解，写作不易，感谢大家的支持！！ ???**

[b98ddc1009654855bf7b88e9372a5711.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/52cb0104f1f94b7ea7fd0ad4fc1dcb88.png
[e5a4c83881324b4293dfe2faa10d6b50.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/d619f260327f4cf7ae35699ccfcaa2aa.png
[dacf93873c694463bbdb930dbd2dbc87.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/5462b2c3b3d140bf9f33064d7686c506.png