苍穹外卖——项目搭建

水深无声 2024-04-21 08:10 101阅读 0赞

## 一、项目介绍以及环境搭建 ##

### 1.苍穹外卖项目介绍 ###

#### 1.1项目介绍 ####

本项目（苍穹外卖）是专门为餐饮企业（餐厅、饭店）定制的一款软件产品，包括 系统管理后台 和 小程序端应用 两部分。其中系统管理后台主要提供给餐饮企业内部员工使用，可以对餐厅的分类、菜品、套餐、订单、员工等进行管理维护，对餐厅的各类数据进行统计，同时也可进行来单语音播报功能。小程序端主要提供给消费者使用，可以在线浏览菜品、添加购物车、下单、支付、催单等。  
![image.png][]  
接下来，通过功能架构图来展示**管理端**和**用户端**的具体业务功能模块。  
![image.png][image.png 1]  
**1). 管理端功能**  
员工登录/退出 , 员工信息管理 , 分类管理 , 菜品管理 , 套餐管理 , 菜品口味管理 , 订单管理 ，数据统计，来单提醒。  
**2). 用户端功能**  
微信登录 , 收件人地址管理 , 用户历史订单查询 , 菜品规格查询 , 购物车功能 , 下单 , 支付、分类及菜品浏览。

#### 1.2产品原型 ####

**产品原型**，用于展示项目的业务功能，一般由产品经理进行设计。  
**注意事项：** 产品原型主要用于展示项目的功能，并不是最终的页面效果。  
在课程资料的产品原型文件夹下,提供了两份产品原型。  
![image.png][image.png 2]  
**管理端原型图：**  
![image.png][image.png 3]  
**用户端原型图：**  
![image.png][image.png 4]  
**1). 管理端**  
餐饮企业内部员工使用。 主要功能有:

<table> 
 <thead> 
  <tr> 
   <th><strong>模块</strong></th> 
   <th><strong>描述</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>登录/退出</td> 
   <td>内部员工必须登录后,才可以访问系统管理后台</td> 
  </tr> 
  <tr> 
   <td>员工管理</td> 
   <td>管理员可以在系统后台对员工信息进行管理，包含查询、新增、编辑、禁用等功能</td> 
  </tr> 
  <tr> 
   <td>分类管理</td> 
   <td>主要对当前餐厅经营的 菜品分类 或 套餐分类 进行管理维护， 包含查询、新增、修改、删除等功能</td> 
  </tr> 
  <tr> 
   <td>菜品管理</td> 
   <td>主要维护各个分类下的菜品信息，包含查询、新增、修改、删除、启售、停售等功能</td> 
  </tr> 
  <tr> 
   <td>套餐管理</td> 
   <td>主要维护当前餐厅中的套餐信息，包含查询、新增、修改、删除、启售、停售等功能</td> 
  </tr> 
  <tr> 
   <td>订单管理</td> 
   <td>主要维护用户在移动端下的订单信息，包含查询、取消、派送、完成，以及订单报表下载等功能</td> 
  </tr> 
  <tr> 
   <td>数据统计</td> 
   <td>主要完成对餐厅的各类数据统计，如营业额、用户数量、订单等</td> 
  </tr> 
 </tbody> 
</table>

**2). 用户端**  
移动端应用主要提供给消费者使用。主要功能有:

<table> 
 <thead> 
  <tr> 
   <th><strong>模块</strong></th> 
   <th><strong>描述</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>登录/退出</td> 
   <td>用户需要通过微信授权后登录使用小程序进行点餐</td> 
  </tr> 
  <tr> 
   <td>点餐-菜单</td> 
   <td>在点餐界面需要展示出菜品分类/套餐分类, 并根据当前选择的分类加载其中的菜品信息, 供用户查询选择</td> 
  </tr> 
  <tr> 
   <td>点餐-购物车</td> 
   <td>用户选中的菜品就会加入用户的购物车, 主要包含 查询购物车、加入购物车、删除购物车、清空购物车等功能</td> 
  </tr> 
  <tr> 
   <td>订单支付</td> 
   <td>用户选完菜品/套餐后, 可以对购物车菜品进行结算支付, 这时就需要进行订单的支付</td> 
  </tr> 
  <tr> 
   <td>个人信息</td> 
   <td>在个人中心页面中会展示当前用户的基本信息, 用户可以管理收货地址, 也可以查询历史订单数据</td> 
  </tr> 
 </tbody> 
</table>

#### 1.3 技术选型 ####

关于本项目的技术选型, 我们将会从 用户层、网关层、应用层、数据层 这几个方面进行介绍，主要用于展示项目中使用到的技术框架和中间件等。  
![image.png][image.png 5]  
**1). 用户层**  
本项目中在构建系统管理后台的前端页面，我们会用到H5、Vue.js、ElementUI、apache echarts(展示图表)等技术。而在构建移动端应用时，我们会使用到微信小程序。  
**2). 网关层**  
Nginx是一个服务器，主要用来作为Http服务器，部署静态资源，访问性能高。在Nginx中还有两个比较重要的作用： 反向代理和负载均衡， 在进行项目部署时，要实现Tomcat的负载均衡，就可以通过Nginx来实现。  
**3). 应用层**  
SpringBoot： 快速构建Spring项目, 采用 “约定优于配置” 的思想, 简化Spring项目的配置开发。  
SpringMVC：SpringMVC是spring框架的一个模块，springmvc和spring无需通过中间整合层进行整合，可以无缝集成。  
Spring Task: 由Spring提供的定时任务框架。  
httpclient: 主要实现了对http请求的发送。  
Spring Cache: 由Spring提供的数据缓存框架  
JWT: 用于对应用程序上的用户进行身份验证的标记。  
阿里云OSS: 对象存储服务，在项目中主要存储文件，如图片等。  
Swagger： 可以自动的帮助开发人员生成接口文档，并对接口进行测试。  
POI: 封装了对Excel表格的常用操作。  
WebSocket: 一种通信网络协议，使客户端和服务器之间的数据交换更加简单，用于项目的来单、催单功能实现。  
**4). 数据层**  
MySQL： 关系型数据库, 本项目的核心业务数据都会采用MySQL进行存储。  
Redis： 基于key-value格式存储的内存数据库, 访问速度快, 经常使用它做缓存。  
Mybatis： 本项目持久层将会使用Mybatis开发。  
pagehelper: 分页插件。  
spring data redis: 简化java代码操作Redis的API。  
**5). 工具**  
git: 版本控制工具, 在团队协作中, 使用该工具对项目中的代码进行管理。  
maven: 项目构建工具。  
junit：单元测试工具，开发人员功能实现完毕后，需要通过junit对功能进行单元测试。  
postman: 接口测工具，模拟用户发起的各类HTTP请求，获取对应的响应结果。

### 2.开发环境搭建 ###

![image.png][image.png 6]  
开发环境搭建主要包含**前端环境**和**后端环境**两部分。作为服务端开发工程师， 我们课程学习的重心应该放在后端的业务代码上， 前端的页面我们只需要导入资料中的nginx， 前端页面的代码我们只需要能看懂即可。

#### 2.1 前端环境搭建 ####

**1). 前端工程基于 nginx**  
从资料中找到前端运行环境的nginx，移动到**非中文目录**下。  
![image.png][image.png 7]  
**sky**目录中存放了管理端的前端资源，具体如下：

![image.png][image.png 8]  
**2). 启动nginx，访问测试**  
双击 nginx.exe 即可启动 nginx 服务，访问端口号为 80  
[http://localhost:80][http_localhost_80]  
![image.png][image.png 9]  
但是为了比较端口冲突，我们可以把端口进行修改  
![image.png][image.png 10]

#### 2.2后端环境搭建 ####

##### 2.2.1 熟悉项目结构 #####

后端工程基于 maven 进行项目构建，并且进行分模块开发。  
**1). 从资料中找到后端初始工程：**  
![image.png][image.png 11]  
**2). 用 IDEA 打开初始工程，了解项目的整体结构：**  
![image.png][image.png 12]  
对工程的每个模块作用说明：

<table> 
 <thead> 
  <tr> 
   <th><strong>序号</strong></th> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>sky-take-out</td> 
   <td>maven父工程，统一管理依赖版本，聚合其他子模块</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>sky-common</td> 
   <td>子模块，存放公共类，例如：工具类、常量类、异常类等</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>sky-pojo</td> 
   <td>子模块，存放实体类、VO、DTO等</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>sky-server</td> 
   <td>子模块，后端服务，存放配置文件、Controller、Service、Mapper等</td> 
  </tr> 
 </tbody> 
</table>

对项目整体结构了解后，接下来我们详细分析上述的每个子模块：

*  **sky-common:** 模块中存放的是一些公共类，可以供其他模块使用
 *  ![image.png][image.png 13]
 *  分析sky-common模块的每个包的作用：

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>constant</td> 
   <td>存放相关常量类</td> 
  </tr> 
  <tr> 
   <td>context</td> 
   <td>存放上下文类</td> 
  </tr> 
  <tr> 
   <td>enumeration</td> 
   <td>项目的枚举类存储</td> 
  </tr> 
  <tr> 
   <td>exception</td> 
   <td>存放自定义异常类</td> 
  </tr> 
  <tr> 
   <td>json</td> 
   <td>处理json转换的类</td> 
  </tr> 
  <tr> 
   <td>properties</td> 
   <td>存放SpringBoot相关的配置属性类</td> 
  </tr> 
  <tr> 
   <td>result</td> 
   <td>返回结果类的封装</td> 
  </tr> 
  <tr> 
   <td>utils</td> 
   <td>常用工具类</td> 
  </tr> 
 </tbody> 
</table>

*  **sky-pojo:** 模块中存放的是一些 entity、DTO、VO
 *  ![image.png][image.png 14]

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Entity</td> 
   <td>实体，通常和数据库中的表对应</td> 
  </tr> 
  <tr> 
   <td>DTO</td> 
   <td>数据传输对象，通常用于程序中各层之间传递数据</td> 
  </tr> 
  <tr> 
   <td>VO</td> 
   <td>视图对象，为前端展示数据提供的对象</td> 
  </tr> 
  <tr> 
   <td>POJO</td> 
   <td>普通Java对象，只有属性和对应的getter和setter</td> 
  </tr> 
 </tbody> 
</table>

*  ![image.png][image.png 15]
 *  **sky-server:** 模块中存放的是 配置文件、配置类、拦截器、controller、service、mapper、启动类等
 *  ![image.png][image.png 16]
 *  分析sky-server模块的每个包的作用：

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>config</td> 
   <td>存放配置类</td> 
  </tr> 
  <tr> 
   <td>controller</td> 
   <td>存放controller类</td> 
  </tr> 
  <tr> 
   <td>interceptor</td> 
   <td>存放拦截器类</td> 
  </tr> 
  <tr> 
   <td>mapper</td> 
   <td>存放mapper接口</td> 
  </tr> 
  <tr> 
   <td>service</td> 
   <td>存放service类</td> 
  </tr> 
  <tr> 
   <td>SkyApplication</td> 
   <td>启动类</td> 
  </tr> 
 </tbody> 
</table>

##### 2.2.2Git版本控制 #####

使用Git进行项目代码的版本控制，具体操作：  
**1). 创建Git本地仓库**  
![image.png][image.png 17]  
当Idea中出现：  
![image.png][image.png 18]  
说明本地仓库创建成功。  
**2). 创建Git远程仓库**  
访问[https://gitee.com/][https_gitee.com]，新建仓库  
![image.png][image.png 19]  
![image.png][image.png 20]**3). 将本地文件推送到Git远程仓库**

1.  **提交文件至本地仓库**忽略以下类型文件

![image.png][image.png 21]  
开始提交  
![image.png][image.png 22]  
![image.png][image.png 23]  
点击commit  
**2.添加Git远程仓库地址**  
复制远程地址：  
![image.png][image.png 24]  
选中工程右键  
![image.png][image.png 25]  
![image.png][image.png 26]  
**3.推送**  
![image.png][image.png 27]  
![image.png][image.png 28]  
成功推送至远程仓库  
![image.png][image.png 29]

##### 2.2.3导入数据库 #####

导入sky.sql文件

CREATE DATABASE  IF NOT EXISTS `sky_take_out` /*!40100 DEFAULT CHARACTER SET utf8 */ /*!80016 DEFAULT ENCRYPTION='N' */;
    USE `sky_take_out`;
    -- MySQL dump 10.13  Distrib 8.0.28, for Win64 (x86_64)
    --
    -- Host: localhost    Database: sky_take_out
    -- ------------------------------------------------------
    -- Server version	8.0.28
    
    /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
    /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
    /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
    /*!50503 SET NAMES utf8 */;
    /*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
    /*!40103 SET TIME_ZONE='+00:00' */;
    /*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
    /*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
    /*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
    /*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
    
    --
    -- Table structure for table `address_book`
    --
    
    DROP TABLE IF EXISTS `address_book`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `address_book` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `user_id` bigint NOT NULL COMMENT '用户id',
      `consignee` varchar(50) COLLATE utf8_bin DEFAULT NULL COMMENT '收货人',
      `sex` varchar(2) COLLATE utf8_bin DEFAULT NULL COMMENT '性别',
      `phone` varchar(11) COLLATE utf8_bin NOT NULL COMMENT '手机号',
      `province_code` varchar(12) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '省级区划编号',
      `province_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '省级名称',
      `city_code` varchar(12) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '市级区划编号',
      `city_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '市级名称',
      `district_code` varchar(12) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '区级区划编号',
      `district_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '区级名称',
      `detail` varchar(200) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '详细地址',
      `label` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '标签',
      `is_default` tinyint(1) NOT NULL DEFAULT '0' COMMENT '默认 0 否 1是',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='地址簿';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `category`
    --
    
    DROP TABLE IF EXISTS `category`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `category` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `type` int DEFAULT NULL COMMENT '类型   1 菜品分类 2 套餐分类',
      `name` varchar(32) COLLATE utf8_bin NOT NULL COMMENT '分类名称',
      `sort` int NOT NULL DEFAULT '0' COMMENT '顺序',
      `status` int DEFAULT NULL COMMENT '分类状态 0:禁用，1:启用',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `update_time` datetime DEFAULT NULL COMMENT '更新时间',
      `create_user` bigint DEFAULT NULL COMMENT '创建人',
      `update_user` bigint DEFAULT NULL COMMENT '修改人',
      PRIMARY KEY (`id`),
      UNIQUE KEY `idx_category_name` (`name`)
    ) ENGINE=InnoDB AUTO_INCREMENT=23 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='菜品及套餐分类';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Dumping data for table `category`
    --
    
    /*!40000 ALTER TABLE `category` DISABLE KEYS */;
    INSERT INTO `category` VALUES (11,1,'酒水饮料',10,1,'2022-06-09 22:09:18','2022-06-09 22:09:18',1,1);
    INSERT INTO `category` VALUES (12,1,'传统主食',9,1,'2022-06-09 22:09:32','2022-06-09 22:18:53',1,1);
    INSERT INTO `category` VALUES (13,2,'人气套餐',12,1,'2022-06-09 22:11:38','2022-06-10 11:04:40',1,1);
    INSERT INTO `category` VALUES (15,2,'商务套餐',13,1,'2022-06-09 22:14:10','2022-06-10 11:04:48',1,1);
    INSERT INTO `category` VALUES (16,1,'蜀味烤鱼',4,1,'2022-06-09 22:15:37','2022-08-31 14:27:25',1,1);
    INSERT INTO `category` VALUES (17,1,'蜀味牛蛙',5,1,'2022-06-09 22:16:14','2022-08-31 14:39:44',1,1);
    INSERT INTO `category` VALUES (18,1,'特色蒸菜',6,1,'2022-06-09 22:17:42','2022-06-09 22:17:42',1,1);
    INSERT INTO `category` VALUES (19,1,'新鲜时蔬',7,1,'2022-06-09 22:18:12','2022-06-09 22:18:28',1,1);
    INSERT INTO `category` VALUES (20,1,'水煮鱼',8,1,'2022-06-09 22:22:29','2022-06-09 22:23:45',1,1);
    INSERT INTO `category` VALUES (21,1,'汤类',11,1,'2022-06-10 10:51:47','2022-06-10 10:51:47',1,1);
    /*!40000 ALTER TABLE `category` ENABLE KEYS */;
    
    --
    -- Table structure for table `dish`
    --
    
    DROP TABLE IF EXISTS `dish`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `dish` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `name` varchar(32) COLLATE utf8_bin NOT NULL COMMENT '菜品名称',
      `category_id` bigint NOT NULL COMMENT '菜品分类id',
      `price` decimal(10,2) DEFAULT NULL COMMENT '菜品价格',
      `image` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '图片',
      `description` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '描述信息',
      `status` int DEFAULT '1' COMMENT '0 停售 1 起售',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `update_time` datetime DEFAULT NULL COMMENT '更新时间',
      `create_user` bigint DEFAULT NULL COMMENT '创建人',
      `update_user` bigint DEFAULT NULL COMMENT '修改人',
      PRIMARY KEY (`id`),
      UNIQUE KEY `idx_dish_name` (`name`)
    ) ENGINE=InnoDB AUTO_INCREMENT=70 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='菜品';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Dumping data for table `dish`
    --
    
    /*!40000 ALTER TABLE `dish` DISABLE KEYS */;
    INSERT INTO `dish` VALUES (46,'王老吉',11,6.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/41bfcacf-7ad4-4927-8b26-df366553a94c.png','',1,'2022-06-09 22:40:47','2022-06-09 22:40:47',1,1);
    INSERT INTO `dish` VALUES (47,'北冰洋',11,4.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/4451d4be-89a2-4939-9c69-3a87151cb979.png','还是小时候的味道',1,'2022-06-10 09:18:49','2022-06-10 09:18:49',1,1);
    INSERT INTO `dish` VALUES (48,'雪花啤酒',11,4.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/bf8cbfc1-04d2-40e8-9826-061ee41ab87c.png','',1,'2022-06-10 09:22:54','2022-06-10 09:22:54',1,1);
    INSERT INTO `dish` VALUES (49,'米饭',12,2.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/76752350-2121-44d2-b477-10791c23a8ec.png','精选五常大米',1,'2022-06-10 09:30:17','2022-06-10 09:30:17',1,1);
    INSERT INTO `dish` VALUES (50,'馒头',12,1.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/475cc599-8661-4899-8f9e-121dd8ef7d02.png','优质面粉',1,'2022-06-10 09:34:28','2022-06-10 09:34:28',1,1);
    INSERT INTO `dish` VALUES (51,'老坛酸菜鱼',20,56.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/4a9cefba-6a74-467e-9fde-6e687ea725d7.png','原料：汤，草鱼，酸菜',1,'2022-06-10 09:40:51','2022-06-10 09:40:51',1,1);
    INSERT INTO `dish` VALUES (52,'经典酸菜鮰鱼',20,66.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/5260ff39-986c-4a97-8850-2ec8c7583efc.png','原料：酸菜，江团，鮰鱼',1,'2022-06-10 09:46:02','2022-06-10 09:46:02',1,1);
    INSERT INTO `dish` VALUES (53,'蜀味水煮草鱼',20,38.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/a6953d5a-4c18-4b30-9319-4926ee77261f.png','原料：草鱼，汤',1,'2022-06-10 09:48:37','2022-06-10 09:48:37',1,1);
    INSERT INTO `dish` VALUES (54,'清炒小油菜',19,18.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/3613d38e-5614-41c2-90ed-ff175bf50716.png','原料：小油菜',1,'2022-06-10 09:51:46','2022-06-10 09:51:46',1,1);
    INSERT INTO `dish` VALUES (55,'蒜蓉娃娃菜',19,18.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/4879ed66-3860-4b28-ba14-306ac025fdec.png','原料：蒜，娃娃菜',1,'2022-06-10 09:53:37','2022-06-10 09:53:37',1,1);
    INSERT INTO `dish` VALUES (56,'清炒西兰花',19,18.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/e9ec4ba4-4b22-4fc8-9be0-4946e6aeb937.png','原料：西兰花',1,'2022-06-10 09:55:44','2022-06-10 09:55:44',1,1);
    INSERT INTO `dish` VALUES (57,'炝炒圆白菜',19,18.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/22f59feb-0d44-430e-a6cd-6a49f27453ca.png','原料：圆白菜',1,'2022-06-10 09:58:35','2022-06-10 09:58:35',1,1);
    INSERT INTO `dish` VALUES (58,'清蒸鲈鱼',18,98.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/c18b5c67-3b71-466c-a75a-e63c6449f21c.png','原料：鲈鱼',1,'2022-06-10 10:12:28','2022-06-10 10:12:28',1,1);
    INSERT INTO `dish` VALUES (59,'东坡肘子',18,138.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/a80a4b8c-c93e-4f43-ac8a-856b0d5cc451.png','原料：猪肘棒',1,'2022-06-10 10:24:03','2022-06-10 10:24:03',1,1);
    INSERT INTO `dish` VALUES (60,'梅菜扣肉',18,58.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/6080b118-e30a-4577-aab4-45042e3f88be.png','原料：猪肉，梅菜',1,'2022-06-10 10:26:03','2022-06-10 10:26:03',1,1);
    INSERT INTO `dish` VALUES (61,'剁椒鱼头',18,66.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/13da832f-ef2c-484d-8370-5934a1045a06.png','原料：鲢鱼，剁椒',1,'2022-06-10 10:28:54','2022-06-10 10:28:54',1,1);
    INSERT INTO `dish` VALUES (62,'金汤酸菜牛蛙',17,88.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/7694a5d8-7938-4e9d-8b9e-2075983a2e38.png','原料：鲜活牛蛙，酸菜',1,'2022-06-10 10:33:05','2022-06-10 10:33:05',1,1);
    INSERT INTO `dish` VALUES (63,'香锅牛蛙',17,88.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/f5ac8455-4793-450c-97ba-173795c34626.png','配料：鲜活牛蛙，莲藕，青笋',1,'2022-06-10 10:35:40','2022-06-10 10:35:40',1,1);
    INSERT INTO `dish` VALUES (64,'馋嘴牛蛙',17,88.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/7a55b845-1f2b-41fa-9486-76d187ee9ee1.png','配料：鲜活牛蛙，丝瓜，黄豆芽',1,'2022-06-10 10:37:52','2022-06-10 10:37:52',1,1);
    INSERT INTO `dish` VALUES (65,'草鱼2斤',16,68.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/b544d3ba-a1ae-4d20-a860-81cb5dec9e03.png','原料：草鱼，黄豆芽，莲藕',1,'2022-06-10 10:41:08','2022-06-10 10:41:08',1,1);
    INSERT INTO `dish` VALUES (66,'江团鱼2斤',16,119.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/a101a1e9-8f8b-47b2-afa4-1abd47ea0a87.png','配料：江团鱼，黄豆芽，莲藕',1,'2022-06-10 10:42:42','2022-06-10 10:42:42',1,1);
    INSERT INTO `dish` VALUES (67,'鮰鱼2斤',16,72.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/8cfcc576-4b66-4a09-ac68-ad5b273c2590.png','原料：鮰鱼，黄豆芽，莲藕',1,'2022-06-10 10:43:56','2022-06-10 10:43:56',1,1);
    INSERT INTO `dish` VALUES (68,'鸡蛋汤',21,4.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/c09a0ee8-9d19-428d-81b9-746221824113.png','配料：鸡蛋，紫菜',1,'2022-06-10 10:54:25','2022-06-10 10:54:25',1,1);
    INSERT INTO `dish` VALUES (69,'平菇豆腐汤',21,6.00,'https://sky-itcast.oss-cn-beijing.aliyuncs.com/16d0a3d6-2253-4cfc-9b49-bf7bd9eb2ad2.png','配料：豆腐，平菇',1,'2022-06-10 10:55:02','2022-06-10 10:55:02',1,1);
    /*!40000 ALTER TABLE `dish` ENABLE KEYS */;
    
    --
    -- Table structure for table `dish_flavor`
    --
    
    DROP TABLE IF EXISTS `dish_flavor`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `dish_flavor` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `dish_id` bigint NOT NULL COMMENT '菜品',
      `name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '口味名称',
      `value` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '口味数据list',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=104 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='菜品口味关系表';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Dumping data for table `dish_flavor`
    --
    
    /*!40000 ALTER TABLE `dish_flavor` DISABLE KEYS */;
    INSERT INTO `dish_flavor` VALUES (40,10,'甜味','[\"无糖\",\"少糖\",\"半糖\",\"多糖\",\"全糖\"]');
    INSERT INTO `dish_flavor` VALUES (41,7,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (42,7,'温度','[\"热饮\",\"常温\",\"去冰\",\"少冰\",\"多冰\"]');
    INSERT INTO `dish_flavor` VALUES (45,6,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (46,6,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (47,5,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (48,5,'甜味','[\"无糖\",\"少糖\",\"半糖\",\"多糖\",\"全糖\"]');
    INSERT INTO `dish_flavor` VALUES (49,2,'甜味','[\"无糖\",\"少糖\",\"半糖\",\"多糖\",\"全糖\"]');
    INSERT INTO `dish_flavor` VALUES (50,4,'甜味','[\"无糖\",\"少糖\",\"半糖\",\"多糖\",\"全糖\"]');
    INSERT INTO `dish_flavor` VALUES (51,3,'甜味','[\"无糖\",\"少糖\",\"半糖\",\"多糖\",\"全糖\"]');
    INSERT INTO `dish_flavor` VALUES (52,3,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (86,52,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (87,52,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (88,51,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (89,51,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (92,53,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (93,53,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (94,54,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\"]');
    INSERT INTO `dish_flavor` VALUES (95,56,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (96,57,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (97,60,'忌口','[\"不要葱\",\"不要蒜\",\"不要香菜\",\"不要辣\"]');
    INSERT INTO `dish_flavor` VALUES (101,66,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (102,67,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    INSERT INTO `dish_flavor` VALUES (103,65,'辣度','[\"不辣\",\"微辣\",\"中辣\",\"重辣\"]');
    /*!40000 ALTER TABLE `dish_flavor` ENABLE KEYS */;
    
    --
    -- Table structure for table `employee`
    --
    
    DROP TABLE IF EXISTS `employee`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `employee` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `name` varchar(32) COLLATE utf8_bin NOT NULL COMMENT '姓名',
      `username` varchar(32) COLLATE utf8_bin NOT NULL COMMENT '用户名',
      `password` varchar(64) COLLATE utf8_bin NOT NULL COMMENT '密码',
      `phone` varchar(11) COLLATE utf8_bin NOT NULL COMMENT '手机号',
      `sex` varchar(2) COLLATE utf8_bin NOT NULL COMMENT '性别',
      `id_number` varchar(18) COLLATE utf8_bin NOT NULL COMMENT '身份证号',
      `status` int NOT NULL DEFAULT '1' COMMENT '状态 0:禁用，1:启用',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `update_time` datetime DEFAULT NULL COMMENT '更新时间',
      `create_user` bigint DEFAULT NULL COMMENT '创建人',
      `update_user` bigint DEFAULT NULL COMMENT '修改人',
      PRIMARY KEY (`id`),
      UNIQUE KEY `idx_username` (`username`)
    ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='员工信息';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Dumping data for table `employee`
    --
    
    /*!40000 ALTER TABLE `employee` DISABLE KEYS */;
    INSERT INTO `employee` VALUES (1,'管理员','admin','123456','13812312312','1','110101199001010047',1,'2022-02-15 15:51:20','2022-02-17 09:16:20',10,1);
    /*!40000 ALTER TABLE `employee` ENABLE KEYS */;
    
    --
    -- Table structure for table `order_detail`
    --
    
    DROP TABLE IF EXISTS `order_detail`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `order_detail` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '名字',
      `image` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '图片',
      `order_id` bigint NOT NULL COMMENT '订单id',
      `dish_id` bigint DEFAULT NULL COMMENT '菜品id',
      `setmeal_id` bigint DEFAULT NULL COMMENT '套餐id',
      `dish_flavor` varchar(50) COLLATE utf8_bin DEFAULT NULL COMMENT '口味',
      `number` int NOT NULL DEFAULT '1' COMMENT '数量',
      `amount` decimal(10,2) NOT NULL COMMENT '金额',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='订单明细表';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `orders`
    --
    
    DROP TABLE IF EXISTS `orders`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `orders` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `number` varchar(50) COLLATE utf8_bin DEFAULT NULL COMMENT '订单号',
      `status` int NOT NULL DEFAULT '1' COMMENT '订单状态 1待付款 2待接单 3已接单 4派送中 5已完成 6已取消 7退款',
      `user_id` bigint NOT NULL COMMENT '下单用户',
      `address_book_id` bigint NOT NULL COMMENT '地址id',
      `order_time` datetime NOT NULL COMMENT '下单时间',
      `checkout_time` datetime DEFAULT NULL COMMENT '结账时间',
      `pay_method` int NOT NULL DEFAULT '1' COMMENT '支付方式 1微信,2支付宝',
      `pay_status` tinyint NOT NULL DEFAULT '0' COMMENT '支付状态 0未支付 1已支付 2退款',
      `amount` decimal(10,2) NOT NULL COMMENT '实收金额',
      `remark` varchar(100) COLLATE utf8_bin DEFAULT NULL COMMENT '备注',
      `phone` varchar(11) COLLATE utf8_bin DEFAULT NULL COMMENT '手机号',
      `address` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '地址',
      `user_name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '用户名称',
      `consignee` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '收货人',
      `cancel_reason` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '订单取消原因',
      `rejection_reason` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '订单拒绝原因',
      `cancel_time` datetime DEFAULT NULL COMMENT '订单取消时间',
      `estimated_delivery_time` datetime DEFAULT NULL COMMENT '预计送达时间',
      `delivery_status` tinyint(1) NOT NULL DEFAULT '1' COMMENT '配送状态  1立即送出  0选择具体时间',
      `delivery_time` datetime DEFAULT NULL COMMENT '送达时间',
      `pack_amount` int DEFAULT NULL COMMENT '打包费',
      `tableware_number` int DEFAULT NULL COMMENT '餐具数量',
      `tableware_status` tinyint(1) NOT NULL DEFAULT '1' COMMENT '餐具数量状态  1按餐量提供  0选择具体数量',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='订单表';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `setmeal`
    --
    
    DROP TABLE IF EXISTS `setmeal`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `setmeal` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `category_id` bigint NOT NULL COMMENT '菜品分类id',
      `name` varchar(32) COLLATE utf8_bin NOT NULL COMMENT '套餐名称',
      `price` decimal(10,2) NOT NULL COMMENT '套餐价格',
      `status` int DEFAULT '1' COMMENT '售卖状态 0:停售 1:起售',
      `description` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '描述信息',
      `image` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '图片',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      `update_time` datetime DEFAULT NULL COMMENT '更新时间',
      `create_user` bigint DEFAULT NULL COMMENT '创建人',
      `update_user` bigint DEFAULT NULL COMMENT '修改人',
      PRIMARY KEY (`id`),
      UNIQUE KEY `idx_setmeal_name` (`name`)
    ) ENGINE=InnoDB AUTO_INCREMENT=32 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='套餐';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `setmeal_dish`
    --
    
    DROP TABLE IF EXISTS `setmeal_dish`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `setmeal_dish` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `setmeal_id` bigint DEFAULT NULL COMMENT '套餐id',
      `dish_id` bigint DEFAULT NULL COMMENT '菜品id',
      `name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '菜品名称 （冗余字段）',
      `price` decimal(10,2) DEFAULT NULL COMMENT '菜品单价（冗余字段）',
      `copies` int DEFAULT NULL COMMENT '菜品份数',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=47 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='套餐菜品关系';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `shopping_cart`
    --
    
    DROP TABLE IF EXISTS `shopping_cart`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `shopping_cart` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '商品名称',
      `image` varchar(255) COLLATE utf8_bin DEFAULT NULL COMMENT '图片',
      `user_id` bigint NOT NULL COMMENT '主键',
      `dish_id` bigint DEFAULT NULL COMMENT '菜品id',
      `setmeal_id` bigint DEFAULT NULL COMMENT '套餐id',
      `dish_flavor` varchar(50) COLLATE utf8_bin DEFAULT NULL COMMENT '口味',
      `number` int NOT NULL DEFAULT '1' COMMENT '数量',
      `amount` decimal(10,2) NOT NULL COMMENT '金额',
      `create_time` datetime DEFAULT NULL COMMENT '创建时间',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=9 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='购物车';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    --
    -- Table structure for table `user`
    --
    
    DROP TABLE IF EXISTS `user`;
    /*!40101 SET @saved_cs_client     = @@character_set_client */;
    /*!50503 SET character_set_client = utf8mb4 */;
    CREATE TABLE `user` (
      `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
      `openid` varchar(45) COLLATE utf8_bin DEFAULT NULL COMMENT '微信用户唯一标识',
      `name` varchar(32) COLLATE utf8_bin DEFAULT NULL COMMENT '姓名',
      `phone` varchar(11) COLLATE utf8_bin DEFAULT NULL COMMENT '手机号',
      `sex` varchar(2) COLLATE utf8_bin DEFAULT NULL COMMENT '性别',
      `id_number` varchar(18) COLLATE utf8_bin DEFAULT NULL COMMENT '身份证号',
      `avatar` varchar(500) COLLATE utf8_bin DEFAULT NULL COMMENT '头像',
      `create_time` datetime DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin COMMENT='用户信息';
    /*!40101 SET character_set_client = @saved_cs_client */;
    
    
    /*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
    
    /*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
    /*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
    /*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
    /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
    /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
    /*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
    /*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
    
    -- Dump completed on 2022-09-06 15:07:08

![image.png][image.png 30]

##### 2.2.4数据库设计文档 #####

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>数据表名</th> 
   <th>中文名称</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>employee</td> 
   <td>员工表</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>category</td> 
   <td>分类表</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>dish</td> 
   <td>菜品表</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>dish_flavor</td> 
   <td>菜品口味表</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>setmeal</td> 
   <td>套餐表</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>setmeal_dish</td> 
   <td>套餐菜品关系表</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>user</td> 
   <td>用户表</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td>address_book</td> 
   <td>地址表</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td>shopping_cart</td> 
   <td>购物车表</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td>orders</td> 
   <td>订单表</td> 
  </tr> 
  <tr> 
   <td>11</td> 
   <td>order_detail</td> 
   <td>订单明细表</td> 
  </tr> 
 </tbody> 
</table>

###### 1. employee ######

employee表为员工表，用于存储商家内部的员工信息。具体表结构如下：

###### 2. category ######

category表为分类表，用于存储商品的分类信息。具体表结构如下：

###### 3. dish ######

dish表为菜品表，用于存储菜品的信息。具体表结构如下：

###### 4. dish\_flavor ######

dish\_flavor表为菜品口味表，用于存储菜品的口味信息。具体表结构如下：

<table> 
 <thead> 
  <tr> 
   <th>字段名</th> 
   <th>数据类型</th> 
   <th>说明</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>dish_id</td> 
   <td>bigint</td> 
   <td>菜品id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>varchar(32)</td> 
   <td>口味名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>varchar(255)</td> 
   <td>口味值</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

###### 5. setmeal ######

setmeal表为套餐表，用于存储套餐的信息。具体表结构如下：

###### 6. setmeal\_dish ######

setmeal\_dish表为套餐菜品关系表，用于存储套餐和菜品的关联关系。具体表结构如下：

<table> 
 <thead> 
  <tr> 
   <th>字段名</th> 
   <th>数据类型</th> 
   <th>说明</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>setmeal_id</td> 
   <td>bigint</td> 
   <td>套餐id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>dish_id</td> 
   <td>bigint</td> 
   <td>菜品id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>varchar(32)</td> 
   <td>菜品名称</td> 
   <td>冗余字段</td> 
  </tr> 
  <tr> 
   <td>price</td> 
   <td>decimal(10,2)</td> 
   <td>菜品单价</td> 
   <td>冗余字段</td> 
  </tr> 
  <tr> 
   <td>copies</td> 
   <td>int</td> 
   <td>菜品份数</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

###### 7. user ######

user表为用户表，用于存储C端用户的信息。具体表结构如下：

###### 8. address\_book ######

address\_book表为地址表，用于存储C端用户的收货地址信息。具体表结构如下：

<table> 
 <thead> 
  <tr> 
   <th>字段名</th> 
   <th>数据类型</th> 
   <th>说明</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>user_id</td> 
   <td>bigint</td> 
   <td>用户id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>consignee</td> 
   <td>varchar(50)</td> 
   <td>收货人</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>sex</td> 
   <td>varchar(2)</td> 
   <td>性别</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>phone</td> 
   <td>varchar(11)</td> 
   <td>手机号</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>province_code</td> 
   <td>varchar(12)</td> 
   <td>省份编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>province_name</td> 
   <td>varchar(32)</td> 
   <td>省份名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>city_code</td> 
   <td>varchar(12)</td> 
   <td>城市编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>city_name</td> 
   <td>varchar(32)</td> 
   <td>城市名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>district_code</td> 
   <td>varchar(12)</td> 
   <td>区县编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>district_name</td> 
   <td>varchar(32)</td> 
   <td>区县名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>detail</td> 
   <td>varchar(200)</td> 
   <td>详细地址信息</td> 
   <td>具体到门牌号</td> 
  </tr> 
  <tr> 
   <td>label</td> 
   <td>varchar(100)</td> 
   <td>标签</td> 
   <td>公司、家、学校</td> 
  </tr> 
  <tr> 
   <td>is_default</td> 
   <td>tinyint(1)</td> 
   <td>是否默认地址</td> 
   <td>1是 0否</td> 
  </tr> 
 </tbody> 
</table>

###### 9. shopping\_cart ######

shopping\_cart表为购物车表，用于存储C端用户的购物车信息。具体表结构如下：

###### 10. orders ######

orders表为订单表，用于存储C端用户的订单数据。具体表结构如下：

<table> 
 <thead> 
  <tr> 
   <th>字段名</th> 
   <th>数据类型</th> 
   <th>说明</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>number</td> 
   <td>varchar(50)</td> 
   <td>订单号</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>status</td> 
   <td>int</td> 
   <td>订单状态</td> 
   <td>1待付款 2待接单 3已接单 4派送中 5已完成 6已取消</td> 
  </tr> 
  <tr> 
   <td>user_id</td> 
   <td>bigint</td> 
   <td>用户id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>address_book_id</td> 
   <td>bigint</td> 
   <td>地址id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>order_time</td> 
   <td>datetime</td> 
   <td>下单时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>checkout_time</td> 
   <td>datetime</td> 
   <td>付款时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>pay_method</td> 
   <td>int</td> 
   <td>支付方式</td> 
   <td>1微信支付 2支付宝支付</td> 
  </tr> 
  <tr> 
   <td>pay_status</td> 
   <td>tinyint</td> 
   <td>支付状态</td> 
   <td>0未支付 1已支付 2退款</td> 
  </tr> 
  <tr> 
   <td>amount</td> 
   <td>decimal(10,2)</td> 
   <td>订单金额</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>remark</td> 
   <td>varchar(100)</td> 
   <td>备注信息</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>phone</td> 
   <td>varchar(11)</td> 
   <td>手机号</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>address</td> 
   <td>varchar(255)</td> 
   <td>详细地址信息</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>user_name</td> 
   <td>varchar(32)</td> 
   <td>用户姓名</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>consignee</td> 
   <td>varchar(32)</td> 
   <td>收货人</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>cancel_reason</td> 
   <td>varchar(255)</td> 
   <td>订单取消原因</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>rejection_reason</td> 
   <td>varchar(255)</td> 
   <td>拒单原因</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>cancel_time</td> 
   <td>datetime</td> 
   <td>订单取消时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>estimated_delivery_time</td> 
   <td>datetime</td> 
   <td>预计送达时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>delivery_status</td> 
   <td>tinyint</td> 
   <td>配送状态</td> 
   <td>1立即送出 &nbsp;0选择具体时间</td> 
  </tr> 
  <tr> 
   <td>delivery_time</td> 
   <td>datetime</td> 
   <td>送达时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>pack_amount</td> 
   <td>int</td> 
   <td>打包费</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>tableware_number</td> 
   <td>int</td> 
   <td>餐具数量</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>tableware_status</td> 
   <td>tinyint</td> 
   <td>餐具数量状态</td> 
   <td>1按餐量提供 &nbsp;0选择具体数量</td> 
  </tr> 
 </tbody> 
</table>

###### 11. order\_detail ######

order\_detail表为订单明细表，用于存储C端用户的订单明细数据。具体表结构如下：

#### 2.3前后端联调 ####

![image.png][image.png 31]  
进行项目启动的时候，出现以下错误

ERROR org.springframework.boot.SpringApplication - Application run failed

后面发现是因为文件编码的原因，需要把文件编码都改成UTF-8  
**1.Controller层**  
在sky-server模块中，com.sky.controller.admin.EmployeeController

/**
          * 登录
          *
          * @param employeeLoginDTO
          * @return
          */
    @PostMapping("/login")
    public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) {
        
        log.info("员工登录：{}", employeeLoginDTO);
        //调用service方法查询数据库
        Employee employee = employeeService.login(employeeLoginDTO);
    
        //登录成功后，生成jwt令牌
        Map<String, Object> claims = new HashMap<>();
        claims.put(JwtClaimsConstant.EMP_ID, employee.getId());
        String token = JwtUtil.createJWT(
            jwtProperties.getAdminSecretKey(),
            jwtProperties.getAdminTtl(),
            claims);
    
        EmployeeLoginVO employeeLoginVO = EmployeeLoginVO.builder()
        .id(employee.getId())
        .userName(employee.getUsername())
        .name(employee.getName())
        .token(token)
        .build();
    
        return Result.success(employeeLoginVO);
    }

**2.Service层**  
在sky-server模块中，com.sky.service.impl.EmployeeServiceImpl

/**
          * 员工登录
          *
          * @param employeeLoginDTO
          * @return
          */
    public Employee login(EmployeeLoginDTO employeeLoginDTO) {
        
    String username = employeeLoginDTO.getUsername();
    String password = employeeLoginDTO.getPassword();
    
    //1、根据用户名查询数据库中的数据
    Employee employee = employeeMapper.getByUsername(username);
    
    //2、处理各种异常情况（用户名不存在、密码不对、账号被锁定）
    if (employee == null) {
        
        //账号不存在
        throw new AccountNotFoundException(MessageConstant.ACCOUNT_NOT_FOUND);
    }
    
    //密码比对
    if (!password.equals(employee.getPassword())) {
        
        //密码错误
        throw new PasswordErrorException(MessageConstant.PASSWORD_ERROR);
    }
    
    if (employee.getStatus() == StatusConstant.DISABLE) {
        
        //账号被锁定
        throw new AccountLockedException(MessageConstant.ACCOUNT_LOCKED);
    }
    
    //3、返回实体对象
    return employee;
    }

**3.Mapper层**  
在sky-server模块中，com.sky.mapper.EmployeeMapper

package com.sky.mapper;
    
    import com.sky.entity.Employee;
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Select;
    
    @Mapper
    public interface EmployeeMapper {
        
    
        /**
          * 根据用户名查询员工
          * @param username
          * @return
          */
        @Select("select * from employee where username = #{username}")
        Employee getByUsername(String username);
    
    }

注：可以通过断点调试跟踪后端程序的执行过程

#### 2.4NGINX ####

##### 2.4.1正向代理 #####

![image.png][image.png 32]

##### 2.4.2反向代理和负载均衡 #####

![image.png][image.png 33]  
对登录功能测试完毕后，接下来，我们思考一个问题：**前端发送的请求，是如何请求到后端服务的？**  
前端请求地址：[http://localhost/api/employee/login][http_localhost_api_employee_login]  
后端接口地址：[http://localhost:8080/admin/employee/login][http_localhost_8080_admin_employee_login]  
![image.png][image.png 34]  
很明显，两个地址不一致，那是如何请求到后端服务的呢？  
![image.png][image.png 35]  
**1). nginx反向代理**  
**nginx 反向代理**，就是将前端发送的动态请求由 nginx 转发到后端服务器  
那为什么不直接通过浏览器直接请求后台服务端，需要通过nginx反向代理呢？  
**nginx 反向代理的好处：**

*  提高访问速度因为nginx本身可以进行缓存，如果访问的同一接口，并且做了数据缓存，nginx就直接可把数据返回，不需要真正地访问服务端，从而提高访问速度。
 *  进行负载均衡所谓负载均衡,就是把大量的请求按照我们指定的方式均衡的分配给集群中的每台服务器。
 *  保证后端服务安全因为一般后台服务地址不会暴露，所以使用浏览器不能直接访问，可以把nginx作为请求访问的入口，请求到达nginx后转发到具体的服务中，从而保证后端服务的安全。

**nginx 反向代理的配置方式：**

server{
         listen 80;
         server_name localhost;
         
         location /api/{
             proxy_pass http://localhost:8080/admin/; #反向代理
         }
     }

![image.png][image.png 36]  
\*\*proxy\_pass：\*\*该指令是用来设置代理服务器的地址，可以是主机名称，IP地址加端口号等形式。  
如上代码的含义是：监听80端口号， 然后当我们访问 [http://localhost:80/api/…/][http_localhost_80_api]…这样的接口的时候，它会通过 location /api/ \{\} 这样的反向代理到 [http://localhost:8080/admin/][http_localhost_8080_admin]上来。  
接下来，进到nginx-1.20.2\\conf，打开nginx配置

# 反向代理,处理管理端发送的请求
     location /api/ {
         proxy_pass   http://localhost:8080/admin/;
         #proxy_pass   http://webservers/admin/;
     }

![image.png][image.png 37]  
当在访问[http://localhost/api/employee/login][http_localhost_api_employee_login]，nginx接收到请求后转到[http://localhost:8080/admin/][http_localhost_8080_admin]，故最终的请求地址为[http://localhost:8080/admin/employee/login][http_localhost_8080_admin_employee_login]，和后台服务的访问地址一致。  
**2). nginx 负载均衡**  
当如果服务以集群的方式进行部署时，那nginx在转发请求到服务器时就需要做相应的负载均衡。其实，负载均衡从本质上来说也是基于反向代理来实现的，最终都是转发请求。(nginx按照一定的规则去代理服务器就叫负载均衡)  
**nginx 负载均衡的配置方式：**  
![image.png][image.png 38]

upstream webservers{
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
     }
     server{
         listen 80;
         server_name localhost;
         
         location /api/{
             proxy_pass http://webservers/admin;#负载均衡
         }
     }

\*\*upstream：\*\*如果代理服务器是一组服务器的话，我们可以使用upstream指令配置后端服务器组。  
如上代码的含义是：监听80端口号， 然后当我们访问 [http://localhost:80/api/…/][http_localhost_80_api]…这样的接口的时候，它会通过 location /api/ \{\} 这样的反向代理到 [http://webservers/admin][http_webservers_admin]，根据webservers名称找到一组服务器，根据设置的负载均衡策略(默认是轮询)转发到具体的服务器。  
\*\*注：\*\*upstream后面的名称可自定义，但要上下保持一致。  
**nginx 负载均衡策略：**

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>轮询</td> 
   <td>默认方式</td> 
  </tr> 
  <tr> 
   <td>weight</td> 
   <td>权重方式，默认为1，权重越高，被分配的客户端请求就越多</td> 
  </tr> 
  <tr> 
   <td>ip_hash</td> 
   <td>依据ip分配方式，这样每个访客可以固定访问一个后端服务</td> 
  </tr> 
  <tr> 
   <td>least_conn</td> 
   <td>依据最少连接方式，把请求优先分配给连接数少的后端服务</td> 
  </tr> 
  <tr> 
   <td>url_hash</td> 
   <td>依据url分配方式，这样相同的url会被分配到同一个后端服务</td> 
  </tr> 
  <tr> 
   <td>fair</td> 
   <td>依据响应时间方式，响应时间短的服务将会被优先分配</td> 
  </tr> 
 </tbody> 
</table>

具体配置方式：  
**轮询：**  
![image.png][image.png 39]

upstream webservers{
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
     }

**weight:**  
![image.png][image.png 40]

upstream webservers{
         server 192.168.100.128:8080 weight=90;
         server 192.168.100.129:8080 weight=10;
     }

**ip\_hash:**  
:::info  
**IP Hash分配的原理**

**IP哈希（IP Hash）的分配原理是将客户端的IP地址作为输入，通过哈希函数计算一个值，然后使用这个值来决定将请求分配给哪台后端服务器。以下是IP哈希的基本分配原理：**

*  **客户端IP地址提取：当一个请求到达负载均衡器（如Nginx），它会提取请求的客户端IP地址。**
 *  **哈希计算：使用哈希函数，将客户端IP地址转化为一个固定范围的哈希值。这个哈希值通常是一个整数。**
 *  **哈希值映射到后端服务器：将哈希值映射到可用的后端服务器。通常，哈希值与后端服务器的数量相除并取余数，以确定将请求路由到哪台服务器。**
 *  **例如，如果有3台后端服务器，哈希值为12，则计算：12 % 3 = 0，那么请求将路由到第一台后端服务器。**
 *  **请求路由：根据计算的结果，请求被路由到特定的后端服务器，然后由该服务器来处理请求。**
 *  **会话保持：对于会话保持，相同客户端IP地址的后续请求将继续被路由到同一台后端服务器，以保持用户的会话状态。**

--------------------

:::  
![image.png][image.png 41]

upstream webservers{
         ip_hash;
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
     }

**least\_conn:**

upstream webservers{
         least_conn;
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
     }

**url\_hash:**  
URL哈希的分配原理是将请求的URL作为输入，通过哈希函数计算一个值，然后使用这个值来决定将请求分配给哪台后端服务器。  
![image.png][image.png 42]

upstream webservers{
         hash &request_uri;
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
     }

**fair:**

upstream webservers{
         server 192.168.100.128:8080;
         server 192.168.100.129:8080;
         fair;
     }

#### 2.5完善登录功能(对密码进行加密) ####

\*\*问题：\*\*员工表中的密码是明文存储，安全性太低。  
![image.png][image.png 43]  
**解决思路：**

1.  将密码加密后存储，提高安全性
2.  登录的用户输入账号密码的时候，后端使用MD5加密方式对明文密码加密，然后和数据库的密文进行比对

**实现步骤：**

1.  修改数据库中明文密码，改为MD5加密后的密文打开employee表，修改密码
2.  ![image.png][image.png 44]
3.  修改Java代码，前端提交的密码进行MD5加密后再跟数据库中密码比对

打开EmployeeServiceImpl.java，修改比对密码

package com.sky.service.impl;
    
    import com.sky.constant.MessageConstant;
    import com.sky.constant.StatusConstant;
    import com.sky.dto.EmployeeLoginDTO;
    import com.sky.entity.Employee;
    import com.sky.exception.AccountLockedException;
    import com.sky.exception.AccountNotFoundException;
    import com.sky.exception.PasswordErrorException;
    import com.sky.mapper.EmployeeMapper;
    import com.sky.service.EmployeeService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    import org.springframework.util.DigestUtils;
    
    @Service
    public class EmployeeServiceImpl implements EmployeeService {
        
    
        @Autowired
        private EmployeeMapper employeeMapper;
    
        /**
         * 员工登录
         *
         * @param employeeLoginDTO
         * @return
         */
        public Employee login(EmployeeLoginDTO employeeLoginDTO) {
        
            String username = employeeLoginDTO.getUsername();
            String password = employeeLoginDTO.getPassword();
    
            //1、根据用户名查询数据库中的数据
            Employee employee = employeeMapper.getByUsername(username);
    
            //2、处理各种异常情况（用户名不存在、密码不对、账号被锁定）
            if (employee == null) {
        
                //账号不存在
                throw new AccountNotFoundException(MessageConstant.ACCOUNT_NOT_FOUND);
            }
    
            //密码比对
            // TODO 后期需要进行md5加密，然后再进行比对
            password=DigestUtils.md5DigestAsHex(password.getBytes());
            if (!password.equals(employee.getPassword())) {
        
                //密码错误
                throw new PasswordErrorException(MessageConstant.PASSWORD_ERROR);
            }
    
            if (employee.getStatus() == StatusConstant.DISABLE) {
        
                //账号被锁定
                throw new AccountLockedException(MessageConstant.ACCOUNT_LOCKED);
            }
    
            //3、返回实体对象
            return employee;
        }
    
    }

### 3.导入接口文档 ###

接下来，就要进入到项目的业务开发了，而我们的开发方式就是基本当前企业主流的前后端分离开发方式，那么这种方式就要求我们之前需要先将接口定义好，这样前后端人员才能并行开发，所以，这个章节就需要将接口文档导入到管理平台，为我们后面业务开发做好准备。其实，在真实的企业开发中，接口设计过程其实是一个非常漫长的过程，可能需要多次开会讨论调整，甚至在开发的过程中才会发现某些接口定义还需要再调整，这种情况其实是非常常见的，但是由于项目时间原因，所以选择一次性导入所有的接口，在开发业务功能过程当中，也会带着大家一起来分析一下对应的接口是怎么确定下来的，为什么要这样定义，从而培养同学们的接口设计能力。

#### 3.1 前后端分离开发流程 ####

第一步：定义接口，确定接口的路径、请求方式、传入参数、返回参数。  
第二步：前端开发人员和后端开发人员并行开发，同时，也可自测。  
第三步：前后端人员进行连调测试。  
第四步：提交给测试人员进行最终测试。  
![image.png][image.png 45]

#### 3.2 操作步骤 ####

将课程资料中提供的项目接口导入YApi。访问地址：[http://yapi.smart-xwork.cn/][http_yapi.smart-xwork.cn]  
**1). 从资料中找到项目接口文件**  
![image.png][image.png 46]  
**2). 导入到YApi平台**  
在YApi平台创建出两个项目  
![image.png][image.png 47]  
选择苍穹外卖-管理端接口.json导入  
![image.png][image.png 48]  
导入成功  
![image.png][image.png 49]  
另一个用户端json文件也执行相同操作。

### 4.Swagger ###

#### 4.1 介绍 ####

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务([https://swagger.io/][https_swagger.io])。 它的主要作用是：

1.  使得前后端分离开发更加方便，有利于团队协作
2.  接口的文档在线自动生成，降低后端开发人员编写接口文档的负担
3.  功能测试 Spring已经将Swagger纳入自身的标准，建立了Spring-swagger项目，现在叫Springfox。通过在项目中引入Springfox ，即可非常简单快捷的使用Swagger。

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!  
目前，一般都使用knife4j框架。

#### 5.2 使用步骤 ####

1.  导入 knife4j 的maven坐标在pom.xml中添加依赖

<dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
    </dependency>

1.  在配置类中加入 knife4j 相关配置WebMvcConfiguration.java

/**
          * 通过knife4j生成接口文档
          * @return
     */
    @Bean
    public Docket docket() {
        
        ApiInfo apiInfo = new ApiInfoBuilder()
        .title("苍穹外卖项目接口文档")
        .version("2.0")
        .description("苍穹外卖项目接口文档")
        .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo)
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
        .paths(PathSelectors.any())
        .build();
        return docket;
    }

1.  设置静态资源映射，否则接口文档页面无法访问WebMvcConfiguration.java

/**
          * 设置静态资源映射
          * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

1.  访问测试接口文档访问路径为 **http://ip:port/doc.html** —> [http://localhost:8080/doc.html][http_localhost_8080_doc.html]
2.  ![image.png][image.png 50]接口测试:测试登录功能
3.  ![image.png][image.png 51]

\*\*思考：\*\*通过 Swagger 就可以生成接口文档，那么我们就不需要 Yapi 了？  
1、Yapi 是设计阶段使用的工具，管理和维护接口  
2、Swagger 在开发阶段使用的框架，帮助后端开发人员做后端的接口测试

#### 5.3 常用注解 ####

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：

<table> 
 <thead> 
  <tr> 
   <th><strong>注解</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Api</td> 
   <td>用在类上，例如Controller，表示对类的说明</td> 
  </tr> 
  <tr> 
   <td>@ApiModel</td> 
   <td>用在类上，例如entity、DTO、VO</td> 
  </tr> 
  <tr> 
   <td>@ApiModelProperty</td> 
   <td>用在属性上，描述属性信息</td> 
  </tr> 
  <tr> 
   <td>@ApiOperation</td> 
   <td>用在方法上，例如Controller的方法，说明方法的用途、作用</td> 
  </tr> 
 </tbody> 
</table>

接下来，使用上述注解，生成可读性更好的接口文档  
在sky-pojo模块中  
EmployeeLoginDTO.java

package com.sky.dto;
    
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.Data;
    
    import java.io.Serializable;
    
    @Data
    @ApiModel(description = "员工登录时传递的数据模型")
    public class EmployeeLoginDTO implements Serializable {
        
    
        @ApiModelProperty("用户名")
        private String username;
    
        @ApiModelProperty("密码")
        private String password;
    
    }

EmployeeLoginVo.java

package com.sky.vo;
    
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    import java.io.Serializable;
    
    @Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    @ApiModel(description = "员工登录返回的数据格式")
    public class EmployeeLoginVO implements Serializable {
        
    
        @ApiModelProperty("主键值")
        private Long id;
    
        @ApiModelProperty("用户名")
        private String userName;
    
        @ApiModelProperty("姓名")
        private String name;
    
        @ApiModelProperty("jwt令牌")
        private String token;
    
    }

在sky-server模块中  
EmployeeController.java

package com.sky.controller.admin;
    
    import com.sky.constant.JwtClaimsConstant;
    import com.sky.dto.EmployeeLoginDTO;
    import com.sky.entity.Employee;
    import com.sky.properties.JwtProperties;
    import com.sky.result.Result;
    import com.sky.service.EmployeeService;
    import com.sky.utils.JwtUtil;
    import com.sky.vo.EmployeeLoginVO;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
      * 员工管理
      */
    @RestController
    @RequestMapping("/admin/employee")
    @Slf4j
    @Api(tags = "员工相关接口")
    public class EmployeeController {
        
    
        @Autowired
        private EmployeeService employeeService;
        @Autowired
        private JwtProperties jwtProperties;
    
        /**
          * 登录
          *
          * @param employeeLoginDTO
          * @return
          */
        @PostMapping("/login")
        @ApiOperation(value = "员工登录")
        public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO)    {
        
            //..............
    
    
        }
    
        /**
          * 退出
          *
          * @return
          */
        @PostMapping("/logout")
        @ApiOperation("员工退出")
        public Result<String> logout() {
        
            return Result.success();
        }
    
    }

启动服务：访问[http://localhost:8080/doc.html][http_localhost_8080_doc.html]  
![image.png][image.png 52]

[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/b2a619e36e78464cb7432b1731f12bec.png
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/48e50a77889b464b8ad273c987399e3b.png
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/de1709c931284148b24e1bd2d7083875.png
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/bf11db28b30e45fead9916cedf7545a1.png
[image.png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/d7ee18d0053d411284db6d8219c7d7d3.png
[image.png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/accff07289ef4c6eb887252ef949ecd8.png
[image.png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/0da0f2a762b44897bddfd353579ed9bd.png
[image.png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/dbfd629bc99c44d4b5d92c8c21095263.png
[image.png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/0fa9c2ebd3f44604a12c614717defb15.png
[http_localhost_80]: http://localhost:80
[image.png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3b29ebd11b2543fb9bcca6ff554558ae.png
[image.png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/ca04e1f6438c4eaa8f7fb2597365d6bf.png
[image.png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/7a2e7840ad6a4e62abb9cd2b2cca13c1.png
[image.png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/58164f7264d14ee9bd920f2bb790227d.png
[image.png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/df568978bd09412091f1b96992a537a0.png
[image.png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/e03aa9002dd54fdd88ca7a9e9b8522b1.png
[image.png 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/bcaa50f975a447a2a9ac8a996394188a.png
[image.png 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/433ffcf77be7428e85c168133018b3d5.png
[image.png 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/50df04be2ced44f2a0b8249584cfe446.png
[image.png 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/b7687bd0601c4f45a9269676b74eedae.png
[https_gitee.com]: https://gitee.com/
[image.png 19]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/4bd9ac13ea4c4315a74c5aad73d2f2a3.png
[image.png 20]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/47e84933abdb41f086c44c13d5711ad4.png
[image.png 21]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/951377d33be849c48bc7e242672eb30a.png
[image.png 22]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/9cb62d2cb4aa47c08bce69b486d59174.png
[image.png 23]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/2a315011d6894d0bba0769974db6196d.png
[image.png 24]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/6b0b39588cfa4ec7b7ea3b3f8d9e2022.png
[image.png 25]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/a781f42039924fecbbf727c7f61abc2c.png
[image.png 26]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/d954dd8b04bf4bed8916b9229b91ecd0.png
[image.png 27]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3c64f105fa8e4ae3948d85e7748c8921.png
[image.png 28]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/29316e43eca84c1ab808884df50f602a.png
[image.png 29]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/93aa7ee009e643f1bcf4e321b60f79e0.png
[image.png 30]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/07cfdf3031814d10b9d87c91b4170c96.png
[image.png 31]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/705297b450564a9db78fc3054be67862.png
[image.png 32]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/6fa4f0f111c64bb1ae4208d3df0114aa.png
[image.png 33]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/311b4732979f440ca984d8e72def01fc.png
[http_localhost_api_employee_login]: http://localhost/api/employee/login
[http_localhost_8080_admin_employee_login]: http://localhost:8080/admin/employee/login
[image.png 34]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/d38366dcfbb445c499bdc01438bef953.png
[image.png 35]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/07ae2660ce784c28ad0fa30e80871f7d.png
[image.png 36]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/26542fdbe5414fdab7a39128d7086af1.png
[http_localhost_80_api]: http://localhost:80/api/../
[http_localhost_8080_admin]: http://localhost:8080/admin/
[image.png 37]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/c10d146c648c4487a93ecceb5db14dfc.png
[image.png 38]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3d9f511058a543d893216b7cda84592d.png
[http_webservers_admin]: http://webservers/admin
[image.png 39]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/93978fa58e294322a80c9a03dcc960a9.png
[image.png 40]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/ed3820b31f014df8b02fc8b05d3abf6e.png
[image.png 41]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/f38e8a21429f494aab20559a96a1b946.png
[image.png 42]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/bc08a0b697f147d1b1e0884909718ba3.png
[image.png 43]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/2342f075323e4760b4728fc8a207ec9a.png
[image.png 44]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/fb3cc642e78c4a7ead41bdedaa0a8348.png
[image.png 45]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/e7b3ad86fb4043fe8cbd5c9511815da3.png
[http_yapi.smart-xwork.cn]: http://yapi.smart-xwork.cn/
[image.png 46]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/34a4095b55cf40b7b77343b2a1b12ba8.png
[image.png 47]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/91a9a196647149e790059692715bafac.png
[image.png 48]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8d0c7f86f529494896c335d75bd96d6e.png
[image.png 49]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/cd970d8ae12c45f38763acf62f442f3c.png
[https_swagger.io]: https://swagger.io/
[http_localhost_8080_doc.html]: http://localhost:8080/doc.html
[image.png 50]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/18aacfd7e47b466481705900742e960a.png
[image.png 51]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/57a0ca5ce19e404bb3beae5456c460c1.png
[image.png 52]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/f0dd3eb56a254a20b05a056575bdcc21.png