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

Myth丶恋晨 2024-04-17 10:08 63阅读 0赞

#### 新增菜品 ####

*   *  1.1 需求分析与设计
     *   *  1.1.1 产品原型
         *  1.1.2 接口设计
         *  1.1.3 表设计
     *  2.2 代码开发
     *   *  2.2.1 文件上传实现
         *  2.2.2 新增菜品实现
     *  2.3 功能测试

### 1.1 需求分析与设计 ###

#### 1.1.1 产品原型 ####

后台系统中可以管理菜品信息，通过 **新增功能**来添加一个新的菜品，在添加菜品时需要选择当前菜品所属的菜品分类，并且需要上传菜品图片。

**新增菜品原型：**

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

当填写完表单信息, 点击"保存"按钮后, 会提交该表单的数据到服务端, 在服务端中需要接受数据, 然后将数据保存至数据库中。

**业务规则：**

*  菜品名称必须是唯一的
 *  菜品必须属于某个分类下，不能单独存在
 *  新增菜品时可以根据情况选择菜品的口味
 *  每个菜品必须对应一张图片

#### 1.1.2 接口设计 ####

根据上述原型图先**粗粒度**设计接口，共包含3个接口。

**接口设计：**

*  根据类型查询分类（已完成）
 *  文件上传
 *  新增菜品

接下来**细粒度**分析每个接口，明确每个接口的请求方式、请求路径、传入参数和返回值。

**1. 根据类型查询分类**

![在这里插入图片描述][b24946273c6b44e691ff6a082f0f85af.png]  
![在这里插入图片描述][661cddd0aed7496d8807c91fcd3ee13e.png]

**2. 文件上传**

![在这里插入图片描述][f321fd181060494f822bea8ac1f5bb71.png]  
![在这里插入图片描述][17411eaff3ac4e4b89cdfd7a00377228.png]

**3. 新增菜品**

![在这里插入图片描述][5e5be8c5b0be40afbff5ec2807768c17.png]  
![在这里插入图片描述][b9affb5c97ad4719a97eee14c8812bac.png]  
![在这里插入图片描述][7e06081d04a34448a7457b066967fcd5.png]

#### 1.1.3 表设计 ####

通过原型图进行分析：

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

新增菜品，其实就是将新增页面录入的菜品信息插入到dish表，如果添加了口味做法，还需要向dish\_flavor表插入数据。所以在新增菜品时，涉及到两个表：

<table> 
 <thead> 
  <tr> 
   <th>表名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>dish</td> 
   <td>菜品表</td> 
  </tr> 
  <tr> 
   <td>dish_flavor</td> 
   <td>菜品口味表</td> 
  </tr> 
 </tbody> 
</table>

**1). 菜品表:dish**

<table> 
 <thead> 
  <tr> 
   <th><strong>字段名</strong></th> 
   <th><strong>数据类型</strong></th> 
   <th><strong>说明</strong></th> 
   <th><strong>备注</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>varchar(32)</td> 
   <td>菜品名称</td> 
   <td>唯一</td> 
  </tr> 
  <tr> 
   <td>category_id</td> 
   <td>bigint</td> 
   <td>分类id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>price</td> 
   <td>decimal(10,2)</td> 
   <td>菜品价格</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>image</td> 
   <td>varchar(255)</td> 
   <td>图片路径</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>varchar(255)</td> 
   <td>菜品描述</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>status</td> 
   <td>int</td> 
   <td>售卖状态</td> 
   <td>1起售 0停售</td> 
  </tr> 
  <tr> 
   <td>create_time</td> 
   <td>datetime</td> 
   <td>创建时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>update_time</td> 
   <td>datetime</td> 
   <td>最后修改时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>create_user</td> 
   <td>bigint</td> 
   <td>创建人id</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>update_user</td> 
   <td>bigint</td> 
   <td>最后修改人id</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

**2). 菜品口味表:dish\_flavor**

### 2.2 代码开发 ###

#### 2.2.1 文件上传实现 ####

因为在新增菜品时，需要上传菜品对应的图片(文件)，包括后绪其它功能也会使用到文件上传，故要实现通用的文件上传接口。

文件上传，是指将本地图片、视频、音频等文件上传到服务器上，可以供其他用户浏览或下载的过程。文件上传在项目中应用非常广泛，我们经常发抖音、发朋友圈都用到了文件上传功能。

实现文件上传服务，需要有存储的支持，那么我们的解决方案将以下几种：

1.  直接将图片保存到服务的硬盘（springmvc中的文件上传）
    
    1.  优点：开发便捷，成本低
    2.  缺点：扩容困难
2.  使用分布式文件系统进行存储
    
    1.  优点：容易实现扩容
    2.  缺点：开发复杂度稍大（有成熟的产品可以使用，比如：FastDFS,MinIO）
3.  使用第三方的存储服务（例如OSS）
    
    1.  优点：开发简单，拥有强大功能，免维护
    2.  缺点：付费

在本项目选用阿里云的OSS服务进行文件存储。  
![在这里插入图片描述][9af2a953c307424ead3fef47b59b741c.png]

**实现步骤：**

**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模块中，已定义

package com.sky.properties;
    
    import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @Component
    @ConfigurationProperties(prefix = "sky.alioss")
    @Data
    public class AliOssProperties {
        
    
        private String endpoint;
        private String accessKeyId;
        private String accessKeySecret;
        private String bucketName;
    
    }

**3). 生成OSS工具类对象**

在sky-server模块

package com.sky.config;
    
    
    /**
     * 配置类，用于创建AliOssUtil对象
     */
    @Configuration
    @Slf4j
    public class OssConfiguration {
        
    
        @Bean
        @ConditionalOnMissingBean
        public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){
        
            log.info("开始创建阿里云文件上传工具类对象：{}",aliOssProperties);
            return new AliOssUtil(aliOssProperties.getEndpoint(),
                    aliOssProperties.getAccessKeyId(),
                    aliOssProperties.getAccessKeySecret(),
                    aliOssProperties.getBucketName());
        }
    }

其中，AliOssUtil.java已在sky-common模块中定义

package com.sky.utils;
    
    @Data
    @AllArgsConstructor
    @Slf4j
    public class AliOssUtil {
        
    
        private String endpoint;
        private String accessKeyId;
        private String accessKeySecret;
        private String bucketName;
    
        /**
         * 文件上传
         *
         * @param bytes
         * @param objectName
         * @return
         */
        public String upload(byte[] bytes, String objectName) {
        
    
            // 创建OSSClient实例。
            OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
    
            try {
        
                // 创建PutObject请求。
                ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(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/ObjectName
            StringBuilder stringBuilder = new StringBuilder("https://");
            stringBuilder
                    .append(bucketName)
                    .append(".")
                    .append(endpoint)
                    .append("/")
                    .append(objectName);
    
            log.info("文件上传到:{}", stringBuilder.toString());
    
            return stringBuilder.toString();
        }
    }

**4). 定义文件上传接口**

在sky-server模块中定义接口

package com.sky.controller.admin;
    
    /**
     * 通用接口
     */
    @RestController
    @RequestMapping("/admin/common")
    @Api(tags = "通用接口")
    @Slf4j
    public class CommonController {
        
    
        @Autowired
        private AliOssUtil aliOssUtil;
    
        /**
         * 文件上传
         * @param file
         * @return
         */
        @PostMapping("/upload")
        @ApiOperation("文件上传")
        public Result<String> upload(MultipartFile file){
        
            log.info("文件上传：{}",file);
    
            try {
        
                //原始文件名
                String originalFilename = file.getOriginalFilename();
                //截取原始文件名的后缀   dfdfdf.png
                String extension = originalFilename.substring(originalFilename.lastIndexOf("."));
                //构造新文件名称
                String objectName = UUID.randomUUID().toString() + extension;
    
                //文件的请求路径
                String filePath = aliOssUtil.upload(file.getBytes(), objectName);
                return Result.success(filePath);
            } catch (IOException e) {
        
                log.error("文件上传失败：{}", e);
            }
    
            return Result.error(MessageConstant.UPLOAD_FAILED);
        }
    }

#### 2.2.2 新增菜品实现 ####

**1). 设计DTO类**

在sky-pojo模块中

package com.sky.dto;
    
    @Data
    public class DishDTO implements Serializable {
        
    
        private Long id;
        //菜品名称
        private String name;
        //菜品分类id
        private Long categoryId;
        //菜品价格
        private BigDecimal price;
        //图片
        private String image;
        //描述信息
        private String description;
        //0 停售 1 起售
        private Integer status;
        //口味
        private List<DishFlavor> flavors = new ArrayList<>();
    }

**2). Controller层**

进入到sky-server模块

package com.sky.controller.admin;
    
    /**
     * 菜品管理
     */
    @RestController
    @RequestMapping("/admin/dish")
    @Api(tags = "菜品相关接口")
    @Slf4j
    public class DishController {
        
    
        @Autowired
        private DishService dishService;
    
        /**
         * 新增菜品
         *
         * @param dishDTO
         * @return
         */
        @PostMapping
        @ApiOperation("新增菜品")
        public Result save(@RequestBody DishDTO dishDTO) {
        
            log.info("新增菜品：{}", dishDTO);
            dishService.saveWithFlavor(dishDTO);//后绪步骤开发
            return Result.success();
        }
    }

**3). Service层接口**

package com.sky.service;
    
    import com.sky.dto.DishDTO;
    import com.sky.entity.Dish;
    
    public interface DishService {
        
    
        /**
         * 新增菜品和对应的口味
         *
         * @param dishDTO
         */
        public void saveWithFlavor(DishDTO dishDTO);
    
    }

**4). Service层实现类**

package com.sky.service.impl;
    
    
    @Service
    @Slf4j
    public class DishServiceImpl implements DishService {
        
    
        @Autowired
        private DishMapper dishMapper;
        @Autowired
        private DishFlavorMapper dishFlavorMapper;
    
        /**
         * 新增菜品和对应的口味
         *
         * @param dishDTO
         */
        @Transactional
        public void saveWithFlavor(DishDTO dishDTO) {
        
    
            Dish dish = new Dish();
            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)
        void insert(Dish dish);

在/resources/mapper中创建DishMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.sky.mapper.DishMapper">
    
        <insert id="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

package com.sky.mapper;
    
    import com.sky.entity.DishFlavor;
    import java.util.List;
    
    @Mapper
    public interface DishFlavorMapper {
        
        /**
         * 批量插入口味数据
         * @param flavors
         */
        void insertBatch(List<DishFlavor> flavors);
    
    }

在/resources/mapper中创建DishFlavorMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.sky.mapper.DishFlavorMapper">
        <insert id="insertBatch">
            insert into dish_flavor (dish_id, name, value) VALUES
            <foreach collection="flavors" item="df" separator=",">
                (#{df.dishId},#{df.name},#{df.value})
            </foreach>
        </insert>
    </mapper>

### 2.3 功能测试 ###

进入到菜品管理—>新建菜品

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

由于没有实现菜品查询功能，所以保存后，暂且在表中查看添加的数据。

dish表：

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

dish\_flavor表：  
![在这里插入图片描述][65336b316c1f4a0b86f83cb5201efcb0.png]

测试成功。

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

[83acd68a74b74a40973e251f5a8f0382.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/b2dac160db4f4f1ba03af85f285bf19e.png
[b24946273c6b44e691ff6a082f0f85af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/69f002b503a24dc6aadba9da572a36e5.png
[661cddd0aed7496d8807c91fcd3ee13e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/99350531febe43f08e45951aa459c132.png
[f321fd181060494f822bea8ac1f5bb71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/e7e4426453d04c609a35d7d7dac775b4.png
[17411eaff3ac4e4b89cdfd7a00377228.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/f55793d696054bf7af3ddbbfd9d96d2e.png
[5e5be8c5b0be40afbff5ec2807768c17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/ce3cf04f3df4480a83f3951bf17b3205.png
[b9affb5c97ad4719a97eee14c8812bac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/e8339812e8a546e0b11e71cf6c8724c5.png
[7e06081d04a34448a7457b066967fcd5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/88d9a1fc26dc4510abaf7289a4e32a29.png
[cab0caf605d041009c843bd6fec59fbe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/a86b0d6a9655497a8c422a193ddb5d1e.png
[9af2a953c307424ead3fef47b59b741c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/4edf2be8e9be4e9f828f2a54a33287bb.png
[e2e9b2d0be6449c6981dce49dd88dda8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/fa2a62c2445d45eebab41719554bd5ea.png
[7fac15d8f9404d919eccae483745c13b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/c628d5e3330640b782902fbeb31429d7.png
[65336b316c1f4a0b86f83cb5201efcb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/8b8db04fb48e4db29d4c349eff45cadb.png