苍穹外卖（一）最适合新手的Java练手项目Springboot+SSM项目《苍穹外卖》项目实战、笔记（超详细、新手）[持续更新]

分手后的思念是犯贱 2023-10-14 10:06 31阅读 0赞

[项目地址https://gitee.com/zhang-zakcomy/cang-qiong-take-out/  
][https_gitee.com_zhang-zakcomy_cang-qiong-take-out_]

## 一、环境搭建-Day01项目概述、环境搭建 ##

## 软件开发整体介绍 ##

### 软件开发流程 ###

![image.png][]

1.  需求分析

完成需求规格说明书、产品原型编写  
需求规格说明书， 一般来说就是使用 Word 文档来描述当前项目的各个组成部分，如：系统定义、应用环境、功能规格、性能需求等，都会在文档中描述。  
产品原型，一般是通过网页(html)的形式展示当前的页面展示什么样的数据, 页面的布局是什么样子的，点击某个菜单，打开什么页面，点击某个按钮，出现什么效果，都可以通过产品原型看到。

1.  设计

设计的内容包含 UI设计、数据库设计、接口设计。

1.  UI设计：用户界面的设计，主要设计项目的页面效果，小到一个按钮，大到一个页面布局，还有人机交互逻辑的体现。
2.  数据库设计：需要设计当前项目中涉及到哪些数据库，每一个数据库里面包含哪些表，这些表结构之间的关系是什么样的，表结构中包含哪些字段。
3.  接口设计：通过分析原型图，首先，粗粒度地分析每个页面有多少接口，然后，再细粒度地分析每个接口的传入参数，返回值参数，同时明确接口路径及请求方式。

> 接口，就相当于某种协议，在软件或项目设计中让不同的组件或模块之间更好地相互联系、协同工作

1.  编码：这个阶段主要是根据设计文档，实现软件的各个模块和功能，编写具体的代码。在这个阶段，需要注重代码的质量和可读性，同时需要遵循编码规范和标准，确保代码的可靠性和可维护性。
2.  测试：这个阶段主要是对编译好的程序进行测试，验证程序是否符合需求和设计要求，同时发现并修复可能存在的缺陷和漏洞。在这个阶段，需要制定详细的测试计划和测试用例，同时需要考虑到各种可能的场景和情况，确保程序的的质量和稳定性。
3.  上线运维：这个阶段主要是将程序部署到生产环境中，进行实际的运行和维护。在这个阶段，需要制定合理的部署计划和运行维护方案，同时需要实时监控程序的的状态和运行情况，及时发现并处理可能出现的问题和故障。

### 角色分工 ###

在对整个软件开发流程熟悉后， 我们还有必要了解一下在整个软件开发流程中涉及到的岗位角色，以及各个角色的职责分工。

<table> 
 <thead> 
  <tr> 
   <th><strong>岗位/角色</strong></th> 
   <th><strong>对应阶段</strong></th> 
   <th><strong>职责/分工</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>项目经理</td> 
   <td>全阶段</td> 
   <td>对整个项目负责，任务分配、把控进度</td> 
  </tr> 
  <tr> 
   <td>产品经理</td> 
   <td>需求分析</td> 
   <td>进行需求调研，输出需求调研文档、产品原型等</td> 
  </tr> 
  <tr> 
   <td>UI设计师</td> 
   <td>设计</td> 
   <td>根据产品原型输出界面效果图</td> 
  </tr> 
  <tr> 
   <td>架构师</td> 
   <td>设计</td> 
   <td>项目整体架构设计、技术选型等</td> 
  </tr> 
  <tr> 
   <td>开发工程师</td> 
   <td>编码</td> 
   <td>功能代码实现</td> 
  </tr> 
  <tr> 
   <td>测试工程师</td> 
   <td>测试</td> 
   <td>编写测试用例，输出测试报告</td> 
  </tr> 
  <tr> 
   <td>运维工程师</td> 
   <td>上线运维</td> 
   <td>软件环境搭建、项目上线</td> 
  </tr> 
 </tbody> 
</table>

在实际的项目中, 有一些项目组由于人员配置紧张, 可能并没有专门的架构师或测试人员, 这个时候可能需要有项目经理或者程序员兼任。

### 软件环境 ###

作为软件开发工程师，在编码的过程中就不可避免地会接触多种软件环境，我们主要来分析在工作中经常遇到的三套环境， 分别是: 开发环境、测试环境、生产环境。 接下来，我们分别介绍一下这三套环境的作用和特点。  
**1). 开发环境(development)**  
我们作为软件开发人员，在开发阶段使用的环境，就是开发环境，一般外部用户无法访问。  
比如，我们在开发中使用的MySQL数据库和其他的一些常用软件，我们可以安装在本地， 也可以安装在一台专门的服务器中， 这些应用软件仅仅在软件开发过程中使用， 项目测试、上线时，我们不会使用这套环境了，这个环境就是开发环境。  
**2). 测试环境(testing)**  
当软件开发工程师，将项目的功能模块开发完毕，并且单元测试通过后，就需要将项目部署到测试服务器上，让测试人员对项目进行测试。那这台测试服务器就是专门给测试人员使用的环境， 也就是测试环境，用于项目测试，一般外部用户无法访问。  
**3). 生产环境(production)**  
当项目开发完毕，并且由测试人员测试通过之后，就可以上线项目，将项目部署到线上环境，并正式对外提供服务，这个线上环境也称之为生产环境。

首先，会在开发环境中进行项目开发，往往开发环境大多数都是本地的电脑环境和局域网内的环境，当开发完毕后，然后会把项目部署到测试环境，测试环境一般是一台独立测试服务器的环境，项目测试通过后，最终把项目部署到生产环境，生产环境可以是机房或者云服务器等线上环境。

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

### 项目介绍 ###

本项目（苍穹外卖）是专门为餐饮企业（餐厅、饭店）定制的一款软件产品，包括 系统管理后台 和 小程序端应用 两部分。其中系统管理后台主要提供给餐饮企业内部员工使用，可以对餐厅的分类、菜品、套餐、订单、员工等进行管理维护，对餐厅的各类数据进行统计，同时也可进行来单语音播报功能。小程序端主要提供给消费者使用，可以在线浏览菜品、添加购物车、下单、支付、催单等。  
![image.png][image.png 1]

### 产品原型 ###

**产品原型**，用于展示项目的业务功能，一般由产品经理进行设计。  
**注意事项：** 产品原型主要用于展示项目的功能，并不是最终的页面效果。  
“资料”文件夹的产品原型文件夹下,提供了两份产品原型。  
![image.png][image.png 2]  
**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>模块</th> 
   <th>描述</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>

### 技术选型 ###

![image.png][image.png 3]  
**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请求，获取对应的响应结果。

## 开发环境搭建 ##

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

1.  前端工程基于nginx

在“资料”中：  
![image.png][image.png 4]  
将![image.png][image.png 5]放在一个目录地址没有中文的文件夹下，取名为“CangqiongTakeout”![image.png][image.png 6]

> 一定要将这个文件夹放在木有中文的目录下，否则启动不成功

1.  启动nginx，访问测试

双击`nginx.exe`qidong nginx服务，访问端口号为80  
[http://localhost:80][http_localhost_80]  
如果启动成功，界面如下：  
![image.png][image.png 7]

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

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

后端工程基于maven进行项目创建，并且进行分模块开发

1.  从“资料”中找到后端初始工程

![image.png][image.png 8]

1.  将初始工程复制到刚才创建的“CangqiongTakeout”目录下

![image.png][image.png 9]  
用IDEA打开初始工程，了解项目结构

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

如果项目没有生成`.iml`文件，则需要进行以下设置：

1.  在本项目下打开idea里面的终端

![image.png][image.png 10]

1.  .进入到对应模块,输入mvn idea:module 命令，回车
2.  BUILD SUCCESS后,看到对应模块下,生成了.iml文件

![image.png][image.png 11]

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

设置后之后，初始项目结构如下  
![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>

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

#### git版本控制 ####

使用Git进行项目代码的版本控制，具体操作：

1.  创建git仓库

![image.png][image.png 13]![image.png][image.png 14]  
当IDEA中出现![image.png][image.png 15]时创建成功

1.  创建git远程仓库

登录[链接gitee.com][gitee.com],新建仓库  
![image.png][image.png 16]![image.png][image.png 17]  
点击“创建”后如下图：  
![image.png][image.png 18]

1.  提交文件至本地仓库

![image.png][image.png 19]  
开始提交：  
点击此处![image.png][image.png 20]  
![image.png][image.png 21]![image.png][image.png 22]

1.  添加至git远程仓库

*  复制远程地址

![image.png][image.png 23]

*  点击此处![image.png][image.png 24]

![image.png][image.png 25]![image.png][image.png 26]  
推送完成  
刷新gitee页面:  
![image.png][image.png 27]

#### 数据库环境搭建 ####

![image.png][image.png 28]  
将数据库中`sky.sql`文件导入MySQL，间脚本代码复制到MySQL运行即可  
创建出11张表  
![image.png][image.png 29]  
![image.png][image.png 30]  
修改idea后端代码 的数据库 的配置信息

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

后端的初始工程中已经实现了**登录**功能，直接进行前后端联调测试即可

> 意思就是，在后端已经有了登录功能的代码了，前端也有了页面实现的代码了，现在需要将前后端联结起来

![image.png][image.png 31]

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

首先，先编译一下，能够保证项目能够正常运行  
![image.png][image.png 32]  
![image.png][image.png 33]  
登录一下：  
双击`nginx.exe`qidong nginx服务，访问端口号为80  
[http://localhost:80][http_localhost_80]

> 要保证前面数据库idea中将相关配置信息根据实际情况配制成自己数据库的信息

![image.png][image.png 34]  
点击登录：  
![image.png][image.png 35]

> 右上角的“错误”先不用管，后面会解决

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

对登录功能测试完毕后，接下来，思考一个问题：**前端发送的请求，是如何请求到后端服务的？**  
在使用Nginx作为反向代理的Java项目中，前端发送的请求会被Nginx接收并处理，然后转发给后端服务。以下是一些基本步骤：

1.  **客户端（前端）发送请求到Nginx服务器。**
2.  **Nginx服务器接收请求，并根据配置的规则进行处理。**
3.  **Nginx根据配置的规则将请求转发给后端服务。**
4.  **后端服务接收到请求并处理，然后返回响应。**
5.  **Nginx接收后端服务的响应，并将其返回给客户端。**

**在这个过程中，Nginx扮演了反向代理的角色，接收客户端的请求并转发给后端服务，同时也将后端服务的响应返回给客户端。通过Nginx，可以实现对请求的负载均衡、缓存、安全过滤等处理，提高系统的性能和安全性。**

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

> 当你在浏览器中输入一个网站地址并发送请求时，这个请求首先会被Nginx服务器接收。Nginx服务器会根据你发送的请求类型、请求头、参数等来进行处理，然后决定将请求转发给哪个后端服务。这个后端服务可以是应用程序服务器、数据库服务器或其他类型的服务。  
> 一旦后端服务接收到请求并处理完成，它会将响应返回给Nginx服务器。Nginx服务器再将这些响应返回给你所在的浏览器。在这个过程中，Nginx还可以对请求和响应进行一些处理，例如提供缓存功能、防止DDoS攻击、拦截恶意请求等，从而提高系统的性能和安全性。

在实际情况中，前端请求地址和后端接口地址通常是不一致的，这是因为前端通常只需要知道如何将请求发送到后端，而不需要知道后端的具体实现细节，包括端口、上下文路径等。

在nginx服务器中，可以通过配置反向代理来实现前后端请求的映射。具体来说，可以在nginx配置文件中添加以下配置：

location /api {
        proxy_pass http://localhost:8080/admin;
    }

这样，当有请求发送到nginx服务器的/api路径时，nginx会将请求转发到后端服务器的/admin路径。  
在SpringBoot项目中，也可以使用Spring Cloud Gateway等反向代理框架来实现前后端请求的映射。例如，可以配置Spring Cloud Gateway的路由规则，将/api/\_路由到后端服务器的/admin/\_路径。  
总之，无论使用nginx还是Spring Cloud Gateway等反向代理框架，都可以实现前后端请求的映射，使得前端请求能够正确地请求到后端服务。

## 导入接口文档 ##

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

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

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

### 操作步骤 ###

1.  找到“资料”中的接口文件

![image.png][image.png 36]

1.  导入到Yapi平台

登录Yapi  
![image.png][image.png 37]  
![image.png][image.png 38]![image.png][image.png 39]  
![image.png][image.png 40]  
两个操作步骤相同

## Swagger ##

### 介绍 ###

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框架。

### 使用步骤 ###

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][http_ip]:port/doc.html —> [http://localhost:8080/doc.html][http_localhost_8080_doc.html]

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

### 常用注解 ###

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

<table> 
 <thead> 
  <tr> 
   <th><strong>注解</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@Api </a></td> 
   <td>用在类上，例如Controller，表示对类的说明</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@ApiModel </a></td> 
   <td>用在类上，例如entity、DTO、VO</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@ApiModelProperty </a></td> 
   <td>用在属性上，描述属性信息</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@ApiOperation </a></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 43]

## 一点两点 ##

1.  这个项目最开始是直接导入的黑马程序员的所谓的“初始项目”
    
    1.  就是实现把框架、依赖、配置等都给你实现好了
2.  先跟着视频教程流程完成这个项目吧
    
    1.  有些地方可能不适合细嚼慢咽地理解，而是囫囵吞枣
    2.  可能等完成整个项目的时候，就自然而然地有些地方就理解了
    3.  可能有些地方完成这个项目之后也不明白，但是再完成这个项目后就理解了
3.  完成一个项目或一个项目中的某一阶段要停下来
    
    1.  看看之囫囵吞下去的东西现在能不能嚼的动

[https_gitee.com_zhang-zakcomy_cang-qiong-take-out_]: https://gitee.com/zhang-zakcomy/cang-qiong-take-out/
[image.png]: https://img-blog.csdnimg.cn/img_convert/e2ec737b087f29ac5ae881417b87bd8b.png#averageHue=#f6f6f6&clientId=u71958f01-02a8-4&from=paste&height=286&id=u645e161a&originHeight=358&originWidth=422&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=11630&status=done&style=none&taskId=u9b66a29a-966d-4229-8a9e-6b0ffcc2ab9&title=&width=337.6
[image.png 1]: https://img-blog.csdnimg.cn/img_convert/b762ad242815c3abc55aae09785e6d51.png#averageHue=#f5e900&clientId=u71958f01-02a8-4&from=paste&height=342&id=ub17c4b1f&originHeight=427&originWidth=604&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=29587&status=done&style=none&taskId=u8505831c-a7a4-43a8-848f-fb9bae64d0e&title=&width=483.2
[image.png 2]: https://img-blog.csdnimg.cn/img_convert/46b33b9f3009e5b07818482d827c3cef.png#averageHue=#efebe3&clientId=u71958f01-02a8-4&from=paste&height=70&id=uba0839b5&originHeight=87&originWidth=213&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=14369&status=done&style=none&taskId=u3b7c4c9c-1bc5-4420-bfe8-74bc0cc8952&title=&width=170.4
[image.png 3]: https://img-blog.csdnimg.cn/img_convert/69994296ae7790c0b426a01ddbc6293a.png#averageHue=#eaebd7&clientId=u71958f01-02a8-4&from=paste&height=308&id=u927a8275&originHeight=385&originWidth=1135&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=175899&status=done&style=none&taskId=ubb95fa6d-5dd3-4e23-83fd-3b74faeb6b5&title=&width=908
[image.png 4]: https://img-blog.csdnimg.cn/img_convert/689c1d213ea5f52377ac0484d68c06a3.png#averageHue=#f8f8f6&clientId=u71958f01-02a8-4&from=paste&height=470&id=ud73517dd&originHeight=588&originWidth=809&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=81382&status=done&style=none&taskId=u95dcae21-568c-4ce7-aa62-8a59f99eb9c&title=&width=647.2
[image.png 5]: https://img-blog.csdnimg.cn/img_convert/a22bcdeac9079045f1517af2e4f3b94a.png#averageHue=#b7f3ff&clientId=u71958f01-02a8-4&from=paste&height=32&id=u7618f28f&originHeight=40&originWidth=195&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=1478&status=done&style=none&taskId=ue43a587f-dde5-4a24-902d-cf47e6fc71c&title=&width=156
[image.png 6]: https://img-blog.csdnimg.cn/img_convert/90f2a254e6c3ca62589bc36bc6ed01da.png#averageHue=#faf9f7&clientId=u71958f01-02a8-4&from=paste&height=122&id=u8a0b3bd6&originHeight=152&originWidth=467&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=5880&status=done&style=none&taskId=u3b90be59-8f05-40e8-80aa-e9b753aa8a7&title=&width=373.6
[http_localhost_80]: http://localhost:80
[image.png 7]: https://img-blog.csdnimg.cn/img_convert/bd8183b78288540046ce97aa024c9803.png#averageHue=#c6b071&clientId=u71958f01-02a8-4&from=paste&height=309&id=u66d7967d&originHeight=661&originWidth=1353&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=927940&status=done&style=none&taskId=u871166ed-4ee7-474e-9bc4-d08f94c9681&title=&width=633.4000244140625
[image.png 8]: https://img-blog.csdnimg.cn/img_convert/6882eb822da67c22eb690b9f29dabcbd.png#averageHue=#fcfbfa&clientId=u71958f01-02a8-4&from=paste&height=394&id=uedb8554b&originHeight=493&originWidth=900&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=57736&status=done&style=none&taskId=ua073dc6b-b2a1-4a1a-b61c-85d62221dd2&title=&width=720
[image.png 9]: https://img-blog.csdnimg.cn/img_convert/924a2ae27385bd77f185dedd76005c84.png#averageHue=#faf9f8&clientId=u71958f01-02a8-4&from=paste&height=134&id=u78f97ad2&originHeight=168&originWidth=679&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=11765&status=done&style=none&taskId=ucbc3d1a2-6f5c-4b69-b5e8-eb16a197a01&title=&width=543.2
[image.png 10]: https://img-blog.csdnimg.cn/img_convert/3adf2d53adbfbedf7ddde7bc1bbd5d38.png#averageHue=#30343a&clientId=u71958f01-02a8-4&from=paste&height=376&id=u9e9a87f0&originHeight=590&originWidth=646&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=70167&status=done&style=none&taskId=u684ee0d3-eec4-4589-a5e9-62c01266fda&title=&width=411.8000183105469
[image.png 11]: https://img-blog.csdnimg.cn/img_convert/3b740c58fd0964b3d8e108e7913dcf0f.png#averageHue=#25272b&clientId=u71958f01-02a8-4&from=paste&height=237&id=u877bc3c4&originHeight=496&originWidth=766&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=51966&status=done&style=none&taskId=u22260095-8522-4e11-891e-b9c4d2f9053&title=&width=365.8000183105469
[image.png 12]: https://img-blog.csdnimg.cn/img_convert/b5d67e168a1c8c9677e497cbf1d646ef.png#averageHue=#2f333a&clientId=u71958f01-02a8-4&from=paste&height=278&id=u4677c4ee&originHeight=348&originWidth=470&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=18859&status=done&style=none&taskId=u07250b7b-d89f-40b1-aa39-af1f94460ce&title=&width=376
[image.png 13]: https://img-blog.csdnimg.cn/img_convert/c9e7343f69a0761b72b639a8f93722e2.png#averageHue=#30353b&clientId=u71958f01-02a8-4&from=paste&height=399&id=u6ebf4cd5&originHeight=365&originWidth=394&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=31430&status=done&style=none&taskId=uf1718773-b0a4-4be3-afab-3c767dc2e5f&title=&width=430.20001220703125
[image.png 14]: https://img-blog.csdnimg.cn/img_convert/379e0ac024488565b40e00eabdf43b8e.png#averageHue=#2e3238&clientId=u71958f01-02a8-4&from=paste&height=398&id=u3a9adc9b&originHeight=652&originWidth=529&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=37034&status=done&style=none&taskId=u8809559b-aadb-4ad7-ad14-b68df67f50e&title=&width=323.20001220703125
[image.png 15]: https://img-blog.csdnimg.cn/img_convert/a7a0cf56c3080502dfe392bd4a5cc755.png#averageHue=#2c2f33&clientId=u71958f01-02a8-4&from=paste&height=36&id=uf1c7f2b9&originHeight=45&originWidth=214&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=2065&status=done&style=none&taskId=ub3bfaaf2-0682-4406-adfe-e66d4416fc4&title=&width=171.2
[gitee.com]: https://gitee.com
[image.png 16]: https://img-blog.csdnimg.cn/img_convert/ffefe89629c99aee8d6ec182b1a23cef.png#averageHue=#79818d&clientId=u71958f01-02a8-4&from=paste&height=161&id=u63c9e8a7&originHeight=298&originWidth=528&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=21682&status=done&style=none&taskId=uae9b8a59-4ce5-47ef-aee6-01c548ed8c1&title=&width=285.3999938964844
[image.png 17]: https://img-blog.csdnimg.cn/img_convert/4e25c475ef2e027851cadcf1055bbe4c.png#averageHue=#fdfcfc&clientId=u71958f01-02a8-4&from=paste&height=381&id=uac33572e&originHeight=819&originWidth=1015&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=71787&status=done&style=none&taskId=ub538ab12-c119-48af-9c31-708cb0b6b2a&title=&width=472
[image.png 18]: https://img-blog.csdnimg.cn/img_convert/90fbc88ae0ebda500750e7f239f55889.png#averageHue=#d7d6d5&clientId=u71958f01-02a8-4&from=paste&height=411&id=uc79a5726&originHeight=724&originWidth=880&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=68342&status=done&style=none&taskId=uf06d9564-8b19-4b7c-b00f-aec0be7eb46&title=&width=499
[image.png 19]: https://img-blog.csdnimg.cn/img_convert/d9524b62f8e339b0c59361f49c099737.png#averageHue=#2c2e32&clientId=u71958f01-02a8-4&from=paste&height=243&id=ucf2149d0&originHeight=410&originWidth=769&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=50856&status=done&style=none&taskId=u53358486-b31b-4db4-b98f-d496bc8505b&title=&width=455.20001220703125
[image.png 20]: https://img-blog.csdnimg.cn/img_convert/50f9d26fbb9983fb3f932a481cd80c0f.png#averageHue=#2d3034&clientId=u71958f01-02a8-4&from=paste&height=26&id=u38795a67&originHeight=32&originWidth=190&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=1869&status=done&style=none&taskId=ue83665af-45bc-441e-825b-db2c5767d7b&title=&width=152
[image.png 21]: https://img-blog.csdnimg.cn/img_convert/ad62f217cc931561b6b6cdacd7cdef24.png#averageHue=#2d3035&clientId=u71958f01-02a8-4&from=paste&height=462&id=u5e84d07e&originHeight=877&originWidth=670&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=81446&status=done&style=none&taskId=u549dadea-5aa9-4169-a25d-205486328ad&title=&width=353
[image.png 22]: https://img-blog.csdnimg.cn/img_convert/f59d645b8b0617fbbae5a070064dfef1.png#averageHue=#2d2f33&clientId=u71958f01-02a8-4&from=paste&height=221&id=u9eba3c27&originHeight=276&originWidth=589&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=16138&status=done&style=none&taskId=u4efd9d67-ace2-4ff5-aace-d696794fbc7&title=&width=471.2
[image.png 23]: https://img-blog.csdnimg.cn/img_convert/8f1a47803c0fe650921971fea3fbea5d.png#averageHue=#fcfbf9&clientId=u71958f01-02a8-4&from=paste&height=177&id=uf7473f80&originHeight=221&originWidth=660&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=27742&status=done&style=none&taskId=uad1f06a2-8f84-4b0d-a0e1-d090851cddf&title=&width=528
[image.png 24]: https://img-blog.csdnimg.cn/img_convert/2a462326a5a3fcc9291aac8a885645cc.png#averageHue=#2f3337&clientId=u71958f01-02a8-4&from=paste&height=44&id=u77094521&originHeight=55&originWidth=150&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=1513&status=done&style=none&taskId=u8e96dfa3-e3a8-4f4c-91c7-44ceca056d3&title=&width=120
[image.png 25]: https://img-blog.csdnimg.cn/img_convert/8710115d2939a7d7f84ee84530cf9477.png#averageHue=#2c2f33&clientId=u71958f01-02a8-4&from=paste&height=370&id=uf4472ec4&originHeight=666&originWidth=984&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=49742&status=done&style=none&taskId=u3e8afead-0d0f-4488-8798-b462dd7fe9b&title=&width=547.2000122070312
[image.png 26]: https://img-blog.csdnimg.cn/img_convert/20afbf50f8f58fc98cdd76f7ca205175.png#averageHue=#2b2e33&clientId=u71958f01-02a8-4&from=paste&height=339&id=u2b5c46e9&originHeight=674&originWidth=1005&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=56034&status=done&style=none&taskId=uec6ae82f-4208-45e6-91ea-ee00785211b&title=&width=506
[image.png 27]: https://img-blog.csdnimg.cn/img_convert/d11faa294a4cec27c15e7f086f663b55.png#averageHue=#fcfaf9&clientId=u71958f01-02a8-4&from=paste&height=307&id=u12f5afcc&originHeight=512&originWidth=1138&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=55321&status=done&style=none&taskId=u4cd30aaa-fb5c-4d0c-babd-07a1ddebeae&title=&width=683.4000244140625
[image.png 28]: https://img-blog.csdnimg.cn/img_convert/a6800f965e5bf960c0a6858cd8d9d2ab.png#averageHue=#f4f3f2&clientId=u53a48681-2301-4&from=paste&height=155&id=u49080e5d&originHeight=194&originWidth=653&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=16839&status=done&style=none&taskId=ub3d22940-996f-489e-9593-fa043808abb&title=&width=522.4
[image.png 29]: https://img-blog.csdnimg.cn/img_convert/efea54b9ab0fd3a40ca79a46459b37b0.png#averageHue=#f8f7f6&clientId=u53a48681-2301-4&from=paste&height=225&id=u90f38c2d&originHeight=376&originWidth=1084&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=41655&status=done&style=none&taskId=u14fdbb28-88d0-4ef8-a82d-158c9422beb&title=&width=648.2000122070312
[image.png 30]: https://img-blog.csdnimg.cn/img_convert/ed378cae1b76babca85edb5bd7249293.png#averageHue=#26282d&clientId=u53a48681-2301-4&from=paste&height=390&id=u71694995&originHeight=487&originWidth=1121&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=55758&status=done&style=none&taskId=ued40327a-20f8-4c1d-8ff0-5b49b2aa78a&title=&width=896.8
[image.png 31]: https://img-blog.csdnimg.cn/img_convert/f1d416badd2186bc7f8630c47e981b35.png#averageHue=#dbe110&clientId=u53a48681-2301-4&from=paste&height=231&id=u8e715ab2&originHeight=417&originWidth=1791&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=42842&status=done&style=none&taskId=u692fa9cb-3b5e-486e-a012-f58fa4c1ed8&title=&width=990
[image.png 32]: https://img-blog.csdnimg.cn/img_convert/d9f5121d815635cab3befea9150ae052.png#averageHue=#292b2f&clientId=u53a48681-2301-4&from=paste&height=253&id=u52c60ee8&originHeight=623&originWidth=1617&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=110138&status=done&style=none&taskId=ue2b198da-087e-4e88-8733-f20cc2ea746&title=&width=656
[image.png 33]: https://img-blog.csdnimg.cn/img_convert/09d3f4345678bf0ba770c4adca0c56e8.png#averageHue=#26282b&clientId=u53a48681-2301-4&from=paste&height=264&id=u3fd78d81&originHeight=493&originWidth=1209&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=79886&status=done&style=none&taskId=ub30b2123-41f0-44fa-a20d-f4503676e62&title=&width=646.2000122070312
[image.png 34]: https://img-blog.csdnimg.cn/img_convert/f10e9ee26d96ff747b054f8987179405.png#averageHue=#c5ae70&clientId=u53a48681-2301-4&from=paste&height=392&id=uee91426c&originHeight=691&originWidth=1332&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=927514&status=done&style=none&taskId=uca5cc3da-be19-4a7a-ac23-0575e51b774&title=&width=755.5999755859375
[image.png 35]: https://img-blog.csdnimg.cn/img_convert/a38dc09e5e797ffbdd222133b690394e.png#averageHue=#fdecb6&clientId=u53a48681-2301-4&from=paste&height=274&id=u59d65cca&originHeight=884&originWidth=1920&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=91888&status=done&style=none&taskId=u816b9d67-6487-4f9e-81da-258250b255a&title=&width=595
[image.png 36]: https://img-blog.csdnimg.cn/img_convert/22c6144729a106b198875520917681c3.png#averageHue=#f7f6f4&clientId=u53a48681-2301-4&from=paste&height=149&id=u181a6cf8&originHeight=186&originWidth=748&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=19253&status=done&style=none&taskId=ud641d584-317b-459a-8037-4293857ddd7&title=&width=598.4
[image.png 37]: https://img-blog.csdnimg.cn/img_convert/5a62a2532cd0ffc842419415295fe648.png#averageHue=#e5e7c7&clientId=u53a48681-2301-4&from=paste&height=369&id=u62fa32f0&originHeight=461&originWidth=1890&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=48547&status=done&style=none&taskId=u83f320a4-555e-46c1-93fe-68170eed5e6&title=&width=1512
[image.png 38]: https://img-blog.csdnimg.cn/img_convert/4494f10362673ff31104dd4c1649151c.png#averageHue=#e6c097&clientId=u53a48681-2301-4&from=paste&height=529&id=u12974471&originHeight=661&originWidth=666&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=27850&status=done&style=none&taskId=ub1716aff-8dfa-4375-ae7e-7ff2bf80a79&title=&width=532.8
[image.png 39]: https://img-blog.csdnimg.cn/img_convert/bfe0f3f6f480b8df6bbfae7195fb2660.png#averageHue=#f7f7f6&clientId=u53a48681-2301-4&from=paste&height=559&id=ub4de0dd6&originHeight=699&originWidth=448&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=35542&status=done&style=none&taskId=u62c84c47-42bc-4eee-8ff8-035f8f013d7&title=&width=358.4
[image.png 40]: https://img-blog.csdnimg.cn/img_convert/734c5fac64f8fed01040fd0ed389c116.png#averageHue=#ecd2b0&clientId=u53a48681-2301-4&from=paste&height=513&id=u5ac5b9ab&originHeight=781&originWidth=1323&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=56231&status=done&style=none&taskId=uc4a208c6-0066-4159-8fd1-422d09601c3&title=&width=868.4000244140625
[https_swagger.io]: https://swagger.io/
[http_ip]: http://ip
[http_localhost_8080_doc.html]: http://localhost:8080/doc.html
[image.png 41]: https://img-blog.csdnimg.cn/img_convert/861e729340719fccf8cc875f16960295.png#averageHue=#fdfdfc&clientId=u53a48681-2301-4&from=paste&height=617&id=ueb3ff552&originHeight=771&originWidth=1919&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=73473&status=done&style=none&taskId=u273c7781-d8bf-48fa-87ff-56ee27f18ae&title=&width=1535.2
[image.png 42]: https://img-blog.csdnimg.cn/img_convert/7b57409c4f41b2c51e1e0780422772bb.png#averageHue=#d1bc9e&clientId=u53a48681-2301-4&from=paste&height=669&id=ue73b4172&originHeight=836&originWidth=1920&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=117635&status=done&style=none&taskId=ue34c3d50-55d1-43ae-ad5b-42c77b64b8e&title=&width=1536
[image.png 43]: https://img-blog.csdnimg.cn/img_convert/57cb3000ba8e18edc72e1a60fa67981d.png#averageHue=#d0bb9d&clientId=u53a48681-2301-4&from=paste&height=518&id=u547b172d&originHeight=647&originWidth=1911&originalType=binary&ratio=1.25&rotation=0&showTitle=false&size=97181&status=done&style=none&taskId=u66242e89-a459-463f-8d78-389e0347bca&title=&width=1528.8