菜品分类
- 1 菜品分类模块
- 1.1 需求分析与设计
- 1.1.1 产品原型
- 1.1.2 接口设计
- 1.1.3 表设计
- 1.3 代码实现
- 1.4 测试
- 分类分页查询
- 启用禁用分类
- 修改分类信息
- 新增菜品分类
- 删除菜品分类
- 2 公共字段自动填充
- 2.1 问题分析
- 2.2 实现思路
- 自定义注解AutoFill
- 自定义切面AutoFillAspect
- Mapper接口的方法上加入AutoFill注解
- 2.3 功能测试
1 菜品分类模块
1.1 需求分析与设计
1.1.1 产品原型
先来分析菜品分类相关功能。
**新增菜品分类：**当我们在后台系统中添加菜品时需要选择一个菜品分类，在移动端也会按照菜品分类来展示对应的菜品。
**菜品分类分页查询：**系统中的分类很多的时候，如果在一个页面中全部展示出来会显得比较乱，不便于查看，所以一般的系统中都会以分页的方式来展示列表数据。
**根据id删除菜品分类：**在分类管理列表页面，可以对某个分类进行删除操作。需要注意的是当分类关联了菜品或者套餐时，此分类不允许删除。
**修改菜品分类：**在分类管理列表页面点击修改按钮，弹出修改窗口，在修改窗口回显分类信息并进行修改，最后点击确定按钮完成修改操作。
**启用禁用菜品分类：**在分类管理列表页面，可以对某个分类进行启用或者禁用操作。
**分类类型查询：**当点击分类类型下拉框时，从数据库中查询所有的菜品分类数据进行展示。
1.1.2 接口设计
1.1.3 表设计
category表结构：
| 字段名 | 数据类型 | 说明 | 备注 |
|---|---|---|---|
| id | bigint | 主键 | 自增 |
| name | varchar(32) | 分类名称 | 唯一 |
| type | int | 分类类型 | 1菜品分类 2套餐分类 |
| sort | int | 排序字段 | 用于分类数据的排序 |
| status | int | 状态 | 1启用 0禁用 |
| create_time | datetime | 创建时间 | |
| update_time | datetime | 最后修改时间 | |
| create_user | bigint | 创建人id | |
| update_user | bigint | 最后修改人id |
1.3 代码实现
直接导入资料文件即可。
1.4 测试
建议使用前后端测试，十分方便，十分简单！在此不多展示了。
测试这六个功能比接口文档测试快多了！
以下就是借口文档测试，较麻烦，但我还是展示出来了！
分类分页查询
启用禁用分类
修改分类信息
新增菜品分类
删除菜品分类
2 公共字段自动填充
2.1 问题分析
后台系统的员工管理功能和菜品分类功能的开发，在新增员工或者新增菜品分类时需要设置创建时间、创建人、修改时间、修改人等字段，在编辑员工或者编辑菜品分类时需要设置修改时间、修改人等字段。这些字段属于公共字段，也就是也就是在我们的系统中很多表中都会有这些字段，如下：
| 序号 | 字段名 | 含义 | 数据类型 |
|---|---|---|---|
| 1 | create_time | 创建时间 | datetime |
| 2 | create_user | 创建人id | bigint |
| 3 | update_time | 修改时间 | datetime |
| 4 | update_user | 修改人id | bigint |
而针对于这些字段，我们的赋值方式为：
1). 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser设置为当前登录用户ID。
2). 在更新数据时, 将updateTime 设置为当前时间, updateUser设置为当前登录用户ID。
例如：
/*** 编辑员工信息** @param employeeDTO*/public void update(EmployeeDTO employeeDTO) {//........................................///employee.setUpdateTime(LocalDateTime.now());employee.setUpdateUser(BaseContext.getCurrentId());///employeeMapper.update(employee);}
/*** 修改分类* @param categoryDTO*/public void update(CategoryDTO categoryDTO) {//....................................////设置修改时间、修改人category.setUpdateTime(LocalDateTime.now());category.setUpdateUser(BaseContext.getCurrentId());//categoryMapper.update(category);}
2.2 实现思路
已知的公共字段
| 序号 | 字段名 | 含义 | 数据类型 | 操作类型 |
|---|---|---|---|---|
| 1 | create_time | 创建时间 | datetime | insert |
| 2 | create_user | 创建人id | bigint | insert |
| 3 | update_time | 修改时间 | datetime | insert、update |
| 4 | update_user | 修改人id | bigint | insert、update |
实现步骤：
-
自定义注解 AutoFill，用于标识需要进行公共字段自动填充的方法
-
自定义切面类 AutoFillAspect，统一拦截加入了 AutoFill 注解的方法，通过反射为公共字段赋值
-
在 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 INSERTOperationType value();
}
其中OperationType已在sky-common模块中定义
package com.sky.enumeration;/*** 数据库操作类型*/
public enum OperationType {/*** 更新操作*/UPDATE,/*** 插入操作*/INSERT
}
自定义切面AutoFillAspect
在sky-server模块，创建com.sky.aspect包。
- @Aspect: 标记该类为切面类。
- @Component: 将此类作为Spring的一个Bean管理，使其能够被自动扫描并注册到Spring容器中。
- @Slf4j: Lombok注解，自动生成日志对象。
- @Pointcut: 定义切点表达式，这里匹配的是所有在com.sky.mapper包下的接口中且带有@AutoFill注解的方法。
- @Before: 在切点方法执行前运行的通知，这里是进行公共字段的自动填充。
核心逻辑
- 获取方法签名和注解: 使用MethodSignature获取被拦截方法的详细信息，并从方法上获取@AutoFill注解来确定操作类型（插入或更新）。
- 参数处理: 从切点的参数列表中获取实体对象，假设实体对象是方法的第一个参数。
- 公共字段填充:
- 根据OperationType判断是插入还是更新操作。
- 对于插入操作，通过反射调用实体类的setter方法设置创建时间和用户的属性。
- 对于更新操作，则仅设置更新时间和用户。
- 使用LocalDateTime.now()获取当前时间，BaseContext.getCurrentId()获取当前用户ID。
- 异常处理: 在反射调用过程中，如果出现异常则打印堆栈信息，实际应用中可能需要更细致的异常处理策略。
注意事项
- 安全性: 确保BaseContext.getCurrentId()在多线程环境下能够安全地获取当前登录用户ID。
- 性能影响: 反射调用相比直接访问可能会有性能开销，特别是在高并发场景下，考虑是否可以优化或缓存反射得到的方法句柄。
- 注解使用: 确保业务逻辑中的Mapper接口方法正确使用了@AutoFill注解，并指定了正确的操作类型。
- 日志记录: 日志输出可以帮助追踪自动填充的过程，确保在生产环境中适当调整日志级别以避免信息泄露或磁盘空间占用过大。
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 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();}}}}
建议调试一遍，加深理解。
Mapper接口的方法上加入AutoFill注解
在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). 将菜品分类管理的新增和修改方法中的公共字段赋值的代码注释。
例如：
2.3 功能测试
添加测试分类，查看控制台，完成！
