新增菜品
1.1 需求分析与设计
1.1.1 产品原型
后台系统中可以管理菜品信息,通过 新增功能来添加一个新的菜品,在添加菜品时需要选择当前菜品所属的菜品分类,并且需要上传菜品图片。
新增菜品原型:
当填写完表单信息, 点击"保存"按钮后, 会提交该表单的数据到服务端, 在服务端中需要接受数据, 然后将数据保存至数据库中。
业务规则:
- 菜品名称必须是唯一的
- 菜品必须属于某个分类下,不能单独存在
- 新增菜品时可以根据情况选择菜品的口味
- 每个菜品必须对应一张图片
1.1.2 接口设计
根据上述原型图先粗粒度设计接口,共包含3个接口。
接口设计:
- 根据类型查询分类(已完成)
- 文件上传
- 新增菜品
接下来细粒度分析每个接口,明确每个接口的请求方式、请求路径、传入参数和返回值。
1. 根据类型查询分类
2. 文件上传
3. 新增菜品
1.1.3 表设计
通过原型图进行分析:
新增菜品,其实就是将新增页面录入的菜品信息插入到dish表,如果添加了口味做法,还需要向dish_flavor表插入数据。所以在新增菜品时,涉及到两个表:
表名说明dish菜品表dish_flavor菜品口味表
1). 菜品表:dish
字段名数据类型说明****备注idbigint主键自增namevarchar(32)菜品名称唯一category_idbigint分类id逻辑外键pricedecimal(10,2)菜品价格imagevarchar(255)图片路径descriptionvarchar(255)菜品描述statusint售卖状态1起售 0停售create_timedatetime创建时间update_timedatetime最后修改时间create_userbigint创建人idupdate_userbigint最后修改人id
2). 菜品口味表:dish_flavor
字段名数据类型说明****备注idbigint主键自增dish_idbigint菜品id逻辑外键namevarchar(32)口味名称valuevarchar(255)口味值
2.2 代码开发
2.2.1 文件上传实现
因为在新增菜品时,需要上传菜品对应的图片(文件),包括后绪其它功能也会使用到文件上传,故要实现通用的文件上传接口。
文件上传,是指将本地图片、视频、音频等文件上传到服务器上,可以供其他用户浏览或下载的过程。文件上传在项目中应用非常广泛,我们经常发抖音、发朋友圈都用到了文件上传功能。
实现文件上传服务,需要有存储的支持,那么我们的解决方案将以下几种:
- 直接将图片保存到服务的硬盘(springmvc中的文件上传) 1. 优点:开发便捷,成本低2. 缺点:扩容困难
- 使用分布式文件系统进行存储 1. 优点:容易实现扩容2. 缺点:开发复杂度稍大(有成熟的产品可以使用,比如:FastDFS,MinIO)
- 使用第三方的存储服务(例如OSS) 1. 优点:开发简单,拥有强大功能,免维护2. 缺点:付费
在本项目选用阿里云的OSS服务进行文件存储。
实现步骤:
1). 定义OSS相关配置
在sky-server模块
application-dev.yml
sky:alioss:endpoint: oss-cn-hangzhou.aliyuncs.com
access-key-id:**************************access-key-secret:*******************bucket-name: sky-take-out
application.yml
spring:profiles:active: dev #设置环境sky:alioss:endpoint: ${sky.alioss.endpoint}access-key-id: ${sky.alioss.access-key-id}access-key-secret: ${sky.alioss.access-key-secret}bucket-name: ${sky.alioss.bucket-name}
2). 读取OSS配置
在sky-common模块中,已定义
packagecom.sky.properties;importlombok.Data;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.stereotype.Component;@Component@ConfigurationProperties(prefix ="sky.alioss")@DatapublicclassAliOssProperties{privateString endpoint;privateString accessKeyId;privateString accessKeySecret;privateString bucketName;}
3). 生成OSS工具类对象
在sky-server模块
packagecom.sky.config;/**
* 配置类,用于创建AliOssUtil对象
*/@Configuration@Slf4jpublicclassOssConfiguration{@Bean@ConditionalOnMissingBeanpublicAliOssUtilaliOssUtil(AliOssProperties aliOssProperties){
log.info("开始创建阿里云文件上传工具类对象:{}",aliOssProperties);returnnewAliOssUtil(aliOssProperties.getEndpoint(),
aliOssProperties.getAccessKeyId(),
aliOssProperties.getAccessKeySecret(),
aliOssProperties.getBucketName());}}
其中,AliOssUtil.java已在sky-common模块中定义
packagecom.sky.utils;@Data@AllArgsConstructor@Slf4jpublicclassAliOssUtil{privateString endpoint;privateString accessKeyId;privateString accessKeySecret;privateString bucketName;/**
* 文件上传
*
* @param bytes
* @param objectName
* @return
*/publicStringupload(byte[] bytes,String objectName){// 创建OSSClient实例。OSS ossClient =newOSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);try{// 创建PutObject请求。
ossClient.putObject(bucketName, objectName,newByteArrayInputStream(bytes));}catch(OSSException oe){System.out.println("Caught an OSSException, which means your request made it to OSS, "+"but was rejected with an error response for some reason.");System.out.println("Error Message:"+ oe.getErrorMessage());System.out.println("Error Code:"+ oe.getErrorCode());System.out.println("Request ID:"+ oe.getRequestId());System.out.println("Host ID:"+ oe.getHostId());}catch(ClientException ce){System.out.println("Caught an ClientException, which means the client encountered "+"a serious internal problem while trying to communicate with OSS, "+"such as not being able to access the network.");System.out.println("Error Message:"+ ce.getMessage());}finally{if(ossClient !=null){
ossClient.shutdown();}}//文件访问路径规则 https://BucketName.Endpoint/ObjectNameStringBuilder stringBuilder =newStringBuilder("https://");
stringBuilder
.append(bucketName).append(".").append(endpoint).append("/").append(objectName);
log.info("文件上传到:{}", stringBuilder.toString());return stringBuilder.toString();}}
4). 定义文件上传接口
在sky-server模块中定义接口
packagecom.sky.controller.admin;/**
* 通用接口
*/@RestController@RequestMapping("/admin/common")@Api(tags ="通用接口")@Slf4jpublicclassCommonController{@AutowiredprivateAliOssUtil aliOssUtil;/**
* 文件上传
* @param file
* @return
*/@PostMapping("/upload")@ApiOperation("文件上传")publicResult<String>upload(MultipartFile file){
log.info("文件上传:{}",file);try{//原始文件名String originalFilename = file.getOriginalFilename();//截取原始文件名的后缀 dfdfdf.pngString extension = originalFilename.substring(originalFilename.lastIndexOf("."));//构造新文件名称String objectName =UUID.randomUUID().toString()+ extension;//文件的请求路径String filePath = aliOssUtil.upload(file.getBytes(), objectName);returnResult.success(filePath);}catch(IOException e){
log.error("文件上传失败:{}", e);}returnResult.error(MessageConstant.UPLOAD_FAILED);}}
2.2.2 新增菜品实现
1). 设计DTO类
在sky-pojo模块中
packagecom.sky.dto;@DatapublicclassDishDTOimplementsSerializable{privateLong id;//菜品名称privateString name;//菜品分类idprivateLong categoryId;//菜品价格privateBigDecimal price;//图片privateString image;//描述信息privateString description;//0 停售 1 起售privateInteger status;//口味privateList<DishFlavor> flavors =newArrayList<>();}
2). Controller层
进入到sky-server模块
packagecom.sky.controller.admin;/**
* 菜品管理
*/@RestController@RequestMapping("/admin/dish")@Api(tags ="菜品相关接口")@Slf4jpublicclassDishController{@AutowiredprivateDishService dishService;/**
* 新增菜品
*
* @param dishDTO
* @return
*/@PostMapping@ApiOperation("新增菜品")publicResultsave(@RequestBodyDishDTO dishDTO){
log.info("新增菜品:{}", dishDTO);
dishService.saveWithFlavor(dishDTO);//后绪步骤开发returnResult.success();}}
3). Service层接口
packagecom.sky.service;importcom.sky.dto.DishDTO;importcom.sky.entity.Dish;publicinterfaceDishService{/**
* 新增菜品和对应的口味
*
* @param dishDTO
*/publicvoidsaveWithFlavor(DishDTO dishDTO);}
4). Service层实现类
packagecom.sky.service.impl;@Service@Slf4jpublicclassDishServiceImplimplementsDishService{@AutowiredprivateDishMapper dishMapper;@AutowiredprivateDishFlavorMapper dishFlavorMapper;/**
* 新增菜品和对应的口味
*
* @param dishDTO
*/@TransactionalpublicvoidsaveWithFlavor(DishDTO dishDTO){Dish dish =newDish();BeanUtils.copyProperties(dishDTO, dish);//向菜品表插入1条数据
dishMapper.insert(dish);//后绪步骤实现//获取insert语句生成的主键值Long dishId = dish.getId();List<DishFlavor> flavors = dishDTO.getFlavors();if(flavors !=null&& flavors.size()>0){
flavors.forEach(dishFlavor ->{
dishFlavor.setDishId(dishId);});//向口味表插入n条数据
dishFlavorMapper.insertBatch(flavors);//后绪步骤实现}}}
5). Mapper层
DishMapper.java中添加
/**
* 插入菜品数据
*
* @param dish
*/@AutoFill(value =OperationType.INSERT)voidinsert(Dish dish);
在/resources/mapper中创建DishMapper.xml
<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPEmapperPUBLIC"-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mappernamespace="com.sky.mapper.DishMapper"><insertid="insert"useGeneratedKeys="true"keyProperty="id">
insert into dish (name, category_id, price, image, description, create_time, update_time, create_user,update_user, status)
values (#{name}, #{categoryId}, #{price}, #{image}, #{description}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser}, #{status})
</insert></mapper>
DishFlavorMapper.java
packagecom.sky.mapper;importcom.sky.entity.DishFlavor;importjava.util.List;@MapperpublicinterfaceDishFlavorMapper{/**
* 批量插入口味数据
* @param flavors
*/voidinsertBatch(List<DishFlavor> flavors);}
在/resources/mapper中创建DishFlavorMapper.xml
<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPEmapperPUBLIC"-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mappernamespace="com.sky.mapper.DishFlavorMapper"><insertid="insertBatch">
insert into dish_flavor (dish_id, name, value) VALUES
<foreachcollection="flavors"item="df"separator=",">
(#{df.dishId},#{df.name},#{df.value})
</foreach></insert></mapper>
2.3 功能测试
进入到菜品管理—>新建菜品
由于没有实现菜品查询功能,所以保存后,暂且在表中查看添加的数据。
dish表:
dish_flavor表:
测试成功。
后记
👉👉💕💕美好的一天,到此结束,下次继续努力!欲知后续,请看下回分解,写作不易,感谢大家的支持!! 🌹🌹🌹
版权归原作者 失重外太空. 所有, 如有侵权,请联系我们删除。