数据科学与大数据技术毕业实习(二)
Day01
课程内容
- 软件开发整体介绍
- 瑞吉外卖项目介绍
- 开发环境搭建
- 后台登录功能开发
- 后台退出功能开发
- 完善登录功能
1. 软件开发整体介绍
作为一名软件开发工程师,我们需要了解在软件开发过程中的开发流程, 以及软件开发过程中涉及到的岗位角色,角色的分工、职责, 并了解软件开发中涉及到的三种软件环境。那么这一小节,我们将从 软件开发流程、角色分工、软件环境 三个方面,来整体上介绍一下软件开发。
1.1 软件开发流程
点击查看每个阶段具体情况
1). 第 1 阶段: 需求分析
完成产品原型、需求规格说明书的编写。
产品原型,一般是通过网页(html)的形式展示当前的页面展示什么样的数据, 页面的布局是什么样子的,点击某个菜单,打开什么页面,点击某个按钮,出现什么效果,都可以通过产品原型看到。
需求规格说明书, 一般来说就是使用 Word 文档来描述当前项目有哪些功能,每一项功能的需求及业务流程是什么样的,都会在文档中描述。
2). 第 2 阶段: 设计
设计的内容包含 产品设计、UI 界面设计、概要设计、详细设计、数据库设计。
在设计阶段,会出具相关的 UI 界面、及相关的设计文档。比如数据库设计,需要设计当前项目中涉及到哪些数据库,每一个数据库里面包含哪些表,这些表结构之间的关系是什么样的,表结构中包含哪些字段,字段类型都会在文档中描述清楚。
3). 第 3 阶段: 编码
编写项目代码、并完成单元测试。
作为软件开发工程师,我们主要的工作就是在该阶段, 对分配给我们的模块功能,进行编码实现。编码实现完毕后,进行单元测试,单元测试通过后再进入到下一阶段。
4). 第 4 阶段: 测试
在该阶段中主要由测试人员, 对部署在测试环境的项目进行功能测试, 并出具测试报告。
5). 第 5 阶段: 上线运维
在项目上线之前, 会由运维人员准备服务器上的软件环境安装、配置, 配置完毕后, 再将我们开发好的项目,部署在服务器上运行。
我们作为软件开发工程师, 我们主要的任务是在编码阶段, 但是在一些小的项目组当中, 也会涉及到数据库的设计、测试等方面的工作。
#1.2 角色分工
整个软件开发过程中涉及到的岗位角色,以及各个角色的职责分工
岗位/角色 | 职责/分工 |
---|---|
项目经理 | 对整个项目负责,任务分配、把控进度 |
产品经理 | 进行需求调研,输出需求调研文档、产品原型等 |
UI 设计师 | 根据产品原型输出界面效果图 |
架构师 | 项目整体架构设计、技术选型等 |
开发工程师 | 功能代码实现 |
测试工程师 | 编写测试用例,输出测试报告 |
运维工程师 | 软件环境搭建、项目上线 |
角色分工, 是在一个项目组中比较标准的角色分工, 但是在实际的项目中, 有一些项目组由于人员配置紧张, 可能并没有专门的架构师或测试人员, 这个时候可能需要有项目经理或者程序员兼任 。
#1.3 软件环境
在我们日常的软件开发中,会涉及到软件开发中的三套环境, 分别是: 开发环境、测试环境、生产环境
点击查看代码
1). 开发环境(development)
我们作为软件开发人员,在开发阶段使用的环境,就是开发环境,一般外部用户无法访问 。
比如,我们在开发中使用的 MySQL 数据库和其他的一些常用软件,我们可以安装在本地, 也可以安装在一台专门的服务器中, 这些应用软件仅仅在软件开发过程中使用, 项目测试、上线时,我们不会使用这套环境了,这个环境就是开发环境。
2). 测试环境(testing)
当软件开发工程师,将项目的功能模块开发完毕,并且单元测试通过后,就需要将项目部署到测试服务器上,让测试人员对项目进行测试。那这台测试服务器就是专门给测试人员使用的环境, 也就是测试环境,用于项目测试,一般外部用户无法访问 。
3). 生产环境(production)
当项目开发完毕,并且由测试人员测试通过之后,就可以上线项目,将项目部署到线上环境,并正式对外提供服务, 这个线上环境也称之为生产环境。
拓展知识:
准生产环境: 对于有的公司来说,项目功能开发好, 并测试通过以后,并不是直接就上生产环境。为了保证我们开发的项目在上线之后能够完全满足要求,就需要把项目部署在真实的环境中, 测试一下是否完全符合要求啊,这时候就诞生了准生产环境,你可以把他当做生产环境的克隆体,准生产环境的服务器配置, 安装的应用软件(JDK、Tomcat、数据库、中间件 ...) 的版本都一样,这种环境也称为 "仿真环境"。
ps.由于项目的性质和类型不同,有的项目可能不需要这个环境
#2. 瑞吉外卖项目介绍
在开发瑞吉外卖这个项目之前,我们需要全方位的来介绍一下当前我们学习的这个项目。接下来,我们将从以下的五个方面, 来介绍瑞吉外卖这个项目。
#2.1 项目介绍
本项目(瑞吉外卖)是专门为餐饮企业(餐厅、饭店) 定制的一款软件产品,包括 系统管理后台 和 移动端应用 两部分。其中系统管理后台 主要提供给餐饮企业内部员工使用,可以对餐厅的分类、菜品、套餐、订单、员工等进行管理维护。移动端应用主要提供给消费者使用,可以在线浏览菜品、添加购物车、下单等。
本项目共分为 2 期进行开发:
阶段 | 功能实现 |
---|---|
第一期 | 主要实现基本需求,其中移动端应用通过 H5 实现,用户可以通过手机浏览器访问 |
第二期 | 主要针对系统进行优化升级,提高系统的访问性能 |
#2.2 产品原型
产品原型,就是一款产品成型之前,由产品经理绘制的一个简单的框架,就是将页面的排版布局展现出来,使产品的初步构思有一个可视化的展示。通过原型展示,可以更加直观的了解项目的需求和提供的功能。
注意事项: 产品原型主要用于展示项目的功能,并不是最终的页面效果。
在课程资料的产品原型文件夹下,提供了两份产品原型。
1). 管理端
餐饮企业内部员工使用。 主要功能有:
模块 | 描述 |
---|---|
登录/退出 | 内部员工必须登录后,才可以访问系统管理后台 |
员工管理 | 管理员可以在系统后台对员工信息进行管理,包含查询、新增、编辑、禁用等功能 |
分类管理 | 主要对当前餐厅经营的 菜品分类 或 套餐分类 进行管理维护, 包含查询、新增、修改、删除等功能 |
菜品管理 | 主要维护各个分类下的菜品信息,包含查询、新增、修改、删除、启售、停售等功能 |
套餐管理 | 主要维护当前餐厅中的套餐信息,包含查询、新增、修改、删除、启售、停售等功能 |
订单明细 | 主要维护用户在移动端下的订单信息,包含查询、取消、派送、完成,以及订单报表下载等功能 |
2). 用户端
移动端应用主要提供给消费者使用。主要功能有:
模块 | 描述 |
---|---|
登录/退出 | 在移动端, 用户也需要登录后使用 APP 进行点餐 |
点餐-菜单 | 在点餐界面需要展示出菜品分类/套餐分类, 并根据当前选择的分类加载其中的菜品信息, 供用户查询选择 |
点餐-购物车 | 用户选中的菜品就会加入用户的购物车, 主要包含 查询购物车、加入购物车、删除购物车、清空购物车等功能 |
订单支付 | 用户选完菜品/套餐后, 可以对购物车菜品进行结算支付, 这时就需要进行订单的支付 |
个人信息 | 在个人中心页面中会展示当前用户的基本信息, 用户可以管理收货地址, 也可以查询历史订单数据 |
#2.3 技术选型
关于本项目的技术选型, 我们将会从 用户层、网关层、应用层、数据层 这几个方面进行介绍,而对于我们服务端开发工程师来说,在项目开发过程中,我们主要关注应用层 及数据层 技术的应用。
点击查看各层的技术选型
1). 用户层
本项目中在构建系统管理后台的前端页面,我们会用到 H5、Vue.js、ElementUI 等技术。而在构建移动端应用时,我们会使用到微信小程序。
2). 网关层
Nginx 是一个服务器,主要用来作为 Http 服务器,部署静态资源,访问性能高。在 Nginx 中还有两个比较重要的作用: 反向代理和负载均衡, 在进行项目部署时,要实现 Tomcat 的负载均衡,就可以通过 Nginx 来实现。
3). 应用层
SpringBoot: 快速构建 Spring 项目, 采用 "约定优于配置" 的思想, 简化 Spring 项目的配置开发。
Spring: 统一管理项目中的各种资源(bean), 在 web 开发的各层中都会用到。
SpringMVC(由 SpringBoot‘简化’):SpringMVC 是 spring 框架的一个模块,springmvc 和 spring 无需通过中间整合层进行整合,可以无缝集成。
lombok:能以简单的注解形式来简化 java 代码,提高开发人员的开发效率。例如开发中经常需要写的 javabean,都需要花时间去添加相应的 getter/setter,也许还要去写构造器、equals 等方法。
Swagger: 可以自动的帮助开发人员生成接口文档,并对接口进行测试。
4). 数据层
MySQL: 关系型数据库, 本项目的核心业务数据都会采用 MySQL 进行存储。
MybatisPlus: 本项目持久层将会使用 MybatisPlus 来简化开发, 基本的单表增删改查直接调用框架提供的方法即可。
Redis(使用 SpringCache 替代): 基于 key-value 格式存储的内存数据库, 访问速度快, 经常使用它做缓存(降低数据库访问压力, 提供访问效率), 在后面的性能优化中会使用。
5). 工具
git: 版本控制工具, 在团队协作中, 使用该工具对项目中的代码进行管理。(仅作了解)
maven: 项目构建工具。
junit:单元测试工具,开发人员功能实现完毕后,需要通过 junit 对功能进行单元测试。
#2.4 功能架构
点击查看功能架构详情
1). 移动端前台功能
手机号登录 , 微信登录 , 收件人地址管理 , 用户历史订单查询 , 菜品规格查询 , 购物车功能 , 下单 , 分类及菜品浏览。
2). 系统管理后台功能
员工登录/退出 , 员工信息管理 , 分类管理 , 菜品管理 , 套餐管理 , 菜品口味管理 , 订单管理 。
#2.5 角色
在瑞吉外卖这个项目中,存在以下三种用户,这三种用户对应三个角色: 后台系统管理员、后台系统普通员工、C 端(移动端)用户。
角色 | 权限操作 |
---|---|
后台系统管理员 | 登录后台管理系统,拥有后台系统中的所有操作权限 |
后台系统普通员工 | 登录后台管理系统,对菜品、套餐、订单等进行管理 (不包含员工管理) |
C 端用户 | 登录移动端应用,可以浏览菜品、添加购物车、设置地址、在线下单等 |
#3. 开发环境搭建
#3.1 数据库环境搭建
#3.1.1 创建数据库
可以通过以下两种方式中的任意一种, 来创建项目的数据库:
点击查看创建数据库方式
1).图形界面
注意: 本项目数据库的字符串, 选择 utf8mb4
2).命令行(了解)
#3.1.2 数据库表导入
项目的数据库创建好了之后, 可以直接将 资料/数据模型/db_reggie.sql 直接导入到数据库中, 也可以通过两种方式实现:
点击查看数据库表导入方式
1).图形界面
2).命令行
注意: 通过命令导入表结构时,注意 sql 文件不要放在中文目录中
#3.1.3 数据库表介绍 🍐
数据库表导入之后, 接下来介绍一下本项目中所涉及到的表结构:
序号 | 表名 | 说明 |
---|---|---|
1 | employee | 员工表 |
2 | category | 菜品和套餐分类表 |
3 | dish | 菜品表 |
4 | setmeal | 套餐表 |
5 | setmeal_dish | 套餐菜品关系表 |
6 | dish_flavor | 菜品口味关系表 |
7 | user | 用户表(C 端) |
8 | address_book | 地址簿表 |
9 | shopping_cart | 购物车表 |
10 | orders | 订单表 |
11 | order_detail | 订单明细表 |
#3.2 Maven 项目搭建
#3.2.1 创建 maven 项目
1). 在 idea 中创建 maven project, 项目名称 reggie_take_out
点击查看图示
2). 检查项目编码
点击查看图示
3). 检查 maven 配置
点击查看图示
4). 检查 JDK 版本
点击查看图示
JDK 的版本选择 1.8;
#3.2.2 搭建基础环境
#1️⃣ 在 pom.xml 中导入依赖
<!-- mybatispuls 起步依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<!-- getset 自动生成 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
</dependency>
<!-- json解析 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.76</version>
</dependency>
<!-- 通用工具包 -->
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
<!-- mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- 数据库连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.23</version>
</dependency>
2️⃣ 在工程的 resources 目录下创建 application.yml 文件,并引入配置
1 |
|
3️⃣ 创建包 com.itheima.reggie , 并编写启动类
1 |
|
#3️⃣ 创建包 com.itheima.reggie , 并编写启动类
点击查看代码
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@Slf4j
@SpringBootApplication
public class ReggieApplication {
public static void main(String[] args) {
SpringApplication.run(ReggieApplication.class,args);
log.info("项目启动成功...");
}
}
2
3
4
5
6
7
8
9
10
11
12
@Slf4j : 是 lombok 中提供的注解, 用来通过 slf4j 记录日志。
当搭建完上述的基础环境之后, 就可以通过引导类, 启动该项目。
搭建基础环境方式 2 -使用现场的框架 :point_left:
初始项目架子中,已经包含了前端静态资源,书写静态资源配置器后(3.2.3 的第 3 部),可以直接启动运行
#3.2.3 前端静态资源导入
我们作为服务端开发工程师, 我们课程学习的重心应该放在后端的业务代码上 , 前端的页面我们只需要导入课程资料中的前端资源, 前端页面的代码我们只需要能看懂即可。
1). 导入静态资源
前端资源存放位置为 资料/前端资源 :
将上述两个目录中的静态资源文件, 导入到项目的 resources 目录下:
2). 创建配置类 WebMvcConfig,设置静态资源映射
用于在 Springboot 项目中, 默认静态资源的存放目录为 : “classpath:/resources/“, “classpath:/static/“, “classpath:/public/“ ; 而在我们的项目中静态资源存放在 backend, front 目录中, 那么这个时候要想访问到静态资源, 就需要设置静态资源映射。
- 在 config 包下创建 WebMvcConfig 类,配置静态资源
1 |
|
3). 打开浏览器,输入地址,访问测试
测试地址:http://localhost:8080/backend/index.html
点击查看测试页面效果
#3.3 搭建框架练习 ✏️
练习时长:10min
#3.3.0「搭建框架练习」目的
搭建好瑞吉外卖项目的基础框架
#3.3.1「搭建框架练习」需求&效果
启动服务器,打开浏览器访问:http://localhost:8080/backend/index.html 显示下述效果
报红色的 404 错误是正常现象,因为后台的代码还没有写,目前只访问前端的代码
#3.3.2「搭建框架练习」步鄹
- 下载 reggie_take_outfrist.zip 压缩包,解压到非中文目录中,
- 使用 idea 打开工程,选择 reggie_take_out 文件夹,打开后显示如下效果:
- 将 com.itheima.reggie.config.WebMvcConfig 类,错误的代码进行注释或删除
- 启动 ReggieApplication 中的 main 方法
- 打开浏览器,访问 http://localhost:8080/backend/index.html 观察效果如 3.3.1 要求所示
- 注意:导工程后,一定要做的三个步鄹
- 检查 Maven 仓库 是否正确配置仓库
- 检查 jdk-1.8
- 检查编译器版本-1.8
#4. 后台系统登录功能
#4.1 需求分析
1). 页面原型展示
点击查看图示
2). 登录页面成品展示
登录页面存放目录 /resources/backend/page/login/login.html
点击查看图示
3). 查看登录请求
通过浏览器调试工具(F12),可以发现,点击登录按钮时,页面会发送请求(请求地址为 http://localhost:8080/employee/login)并提交参数 username 和 password, 请求参数为 json 格式数据 {“username”:”admin”,”password”:”123456”}。
点击查看图示
此时报 404,是因为我们的后台系统还没有响应此请求的处理器,所以我们需要创建相关类来处理登录请求 ;
4). 数据模型(employee 表)
点击查看图示
5). 前端页面分析
点击查看图示
当点击 "登录" 按钮, 会触发 Vue 中定义的 handleLogin 方法:
在上述的前端代码中, 大家可以看到, 发送登录的异步请求之后, 获取到响应结果, 在响应结果中至少包含三个属性: code、data、msg 。
由前端代码,我们也可以看到,在用户登录成功之后,服务端会返回用户信息,而前端是将这些用户信息,存储在客户端的 localStorage 中了。
localStorage.setItem("userInfo", JSON.stringify(res.data));
#4.2 代码开发
#4.2.1 基础准备工作
首先在工程下创建包结构:
提示
- common –放一些通用的类
- config –配置文件
- controller –放一些控制类,用来处理前端请求
- entity –对象实体类
- mapper –操作数据库的接口类
- service –业务层代码
控制层(controller) 调用业务层(service)—>调用持久层(mapper)
1). 创建实体类 Employee
该实体类主要用于和员工表 employee 进行映射。 该实体类, 也可以直接从资料( 资料/实体类 )中拷贝工程中。
所属包: com.itheima.reggie.entity
1 |
|
2). 定义 Mapper 接口
在 MybatisPlus 中, 自定义的 Mapper 接口, 需要继承自 BaseMapper。
所属包: com.itheima.reggie.mapper
点击查看代码
@Mapper
public interface EmployeeMapper extends BaseMapper<Employee>{
}
>
3).Service 接口
本项目的 Service 接口, 在定义时需要继承自 MybatisPlus 提供的 Service 层接口 IService, 这样就可以直接调用 父接口的方法直接执行业务操作, 简化业务层代码实现。
所属包: com.itheima.reggie.service
4). Service 实现类
所属包: com.itheima.reggie.service.impl
点击查看代码
@Service
public class EmployeeServiceImpl extends ServiceImpl<EmployeeMapper,Employee> implements EmployeeService{
}
1
2
3
4
5). Controller 基础代码
所属包: com.itheima.reggie.controller
1
2
3
4
5
6
7
8
9
@Slf4j
@RestController
@RequestMapping("/employee")
public class EmployeeController {
@Autowired
private EmployeeService employeeService;
}
6). 导入通用结果类 R
此类是一个通用结果类,服务端响应的所有结果最终都会包装成此种类型返回给前端页面。
所属包: com.itheima.reggie.common
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
/**
* 通用返回结果,服务端响应的数据最终都会封装成此对象
* @param <T>
*/
@Data
public class R<T> {
private Integer code; //编码:1成功,0和其它数字为失败
private String msg; //错误信息
private T data; //数据
private Map map = new HashMap(); //动态数据
public static <T> R<T> success(T object) {
R<T> r = new R<T>();
r.data = object;
r.code = 1;
return r;
}
public static <T> R<T> error(String msg) {
R r = new R();
r.msg = msg;
r.code = 0;
return r;
}
public R<T> add(String key, Object value) {
this.map.put(key, value);
return this;
}
}
A. 如果业务执行结果为成功, 构建 R 对象时, 只需要调用 success 方法; 如果需要返回数据传递 object 参数, 如果无需返回, 可以直接传递 null。
B. 如果业务执行结果为失败, 构建 R 对象时, 只需要调用 error 方法, 传递错误提示信息即可。
#4.2.2 登录逻辑分析
点击查看 处理逻辑
①. 将页面提交的密码 password 进行 md5 加密处理 , 得到加密后的字符串
②. 根据页面提交的用户名 username 查询数据库中员工数据信息
③. 如果没有查询到, 则返回登录失败结果
④. 密码比对,如果不一致, 则返回登录失败结果
⑤. 查看员工状态,如果为已禁用状态,则返回员工已禁用结果
⑥. 登录成功,将员工 id 存入 Session, 并返回登录成功结果
#4.2.3 代码实现
技术点说明:
A. 由于需求分析时, 我们看到前端发起的请求为 post 请求, 所以服务端需要使用注解 @PostMapping
B. 由于前端传递的请求参数为 json 格式的数据, 这里使用 Employee 对象接收, 但是将 json 格式数据封装到实体类中, 在形参前需要加注解 @RequestBody
/**
* 员工登录
* @param request
* @param employee
* @return
*/
@PostMapping("/login")
public R<Employee> login(HttpServletRequest request,@RequestBody Employee employee){
//1、将页面提交的密码password进行md5加密处理
String password = employee.getPassword();
password = DigestUtils.md5DigestAsHex(password.getBytes());
//2、根据页面提交的用户名username查询数据库
LambdaQueryWrapper<Employee> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(Employee::getUsername,employee.getUsername());
Employee emp = employeeService.getOne(queryWrapper);
//3、如果没有查询到则返回登录失败结果
if(emp == null){
return R.error("登录失败");
}
//4、密码比对,如果不一致则返回登录失败结果
if(!emp.getPassword().equals(password)){
return R.error("登录失败");
}
//5、查看员工状态,如果为已禁用状态,则返回员工已禁用结果
if(emp.getStatus() == 0){
return R.error("账号已禁用");
}
//6、登录成功,将员工id存入Session并返回登录成功结果
request.getSession().setAttribute("employee",emp.getId());
return R.success(emp);
}
#4.3 功能测试
代码实现完毕后, 启动项目, 访问 url: http://localhost:8080/backend/page/login/login.html , 进行登录测试。
在测试过程中, 可以通过 debug 断点调试的方式来跟踪程序的执行过程,并且可以查看程序运行时各个对象的具体赋值情况。而且需要注意, 在测试过程中,需要将所有的情况都覆盖到。
1). 问题说明
当我们在进行 debug 端点调试时, 前端可能会出现如下问题: 前端页面的控制台报出错误-超时;
2). 解决方案
前端进行异步请求时, 默认超时 10000ms , 可以将该值调大一些。
由于修改了 JS 文件,需要手动清理一下浏览器缓存,避免缓存影响,JS 不能及时生效。
#5. 后台系统退出功能
#5.1 需求分析
在后台管理系统中,管理员或者员工,登录进入系统之后,页面跳转到后台系统首页面(backend/index.html),此时会在系统的右上角显示当前登录用户的姓名。
如果员工需要退出系统,直接点击右侧的退出按钮即可退出系统,退出系统后页面应跳转回登录页面。
1). 退出页面展示
2).前端页面分析
点击 将会调用一个 js 方法 logout, 在 logout 的方法中执行如下逻辑:
A. 发起 post 请求, 调用服务端接口 /employee/logout 执行退出操作 ;
B. 删除客户端 localStorage 中存储的用户登录信息, 跳转至登录页面 ;
#5.2 代码实现
需要在 Controller 中创建对应的处理方法, 接收页面发送的 POST 请求 /employee/logout ,具体的处理逻辑:
A. 清理 Session 中的用户 id
B. 返回结果
点击查看代码
/**
* 员工退出
* @param request
* @return
*/
@PostMapping("/logout")
public R<String> logout(HttpServletRequest request){
//清理Session中保存的当前登录员工的id
request.getSession().removeAttribute("employee");
return R.success("退出成功");
}
1
2
3
4
5
6
7
8
9
10
11
#5.3 功能测试
1). 代码实现完毕后, 重启服务, 访问登录界面 http://localhost:8080/backend/page/login/login.html ;
2). 登录完成之后, 进入到系统首页 backend/index.html, 点击右上角 按钮 执行退出操作, 完成后看看是否可以跳转到登录页面 , 并检查 localStorage。
###补充说明:
#6. 完善登录功能
#6.1 问题分析
前面我们已经完成了后台系统的员工登录功能开发,但是目前还存在一个问题,接下来我们来说明一个这个问题, 以及如何处理。
1). 目前现状
用户如果不登录,直接访问系统首页面,照样可以正常访问。
2). 理想效果
上述这种设计并不合理,我们希望看到的效果应该 是,只有登录成功后才可以访问系统中的页面,如果没有登录, 访问系统中的任何界面都直接跳转到登录页面。
那么,具体应该怎么实现呢?
可以使用我们之前讲解过的 过滤器、拦截器来实现,在过滤器、拦截器中拦截前端发起的请求,判断用户是否已经完成登录,如果没有登录则返回提示信息,跳转到登录页面。
#6.2 思路分析
过滤器具体的处理逻辑如下:
A. 获取本次请求的 URI
B. 判断本次请求, 是否需要登录, 才可以访问
C. 如果不需要,则直接放行
D. 判断登录状态,如果已登录,则直接放行
E. 如果未登录, 则返回未登录结果
如果未登录,我们需要给前端返回什么样的结果呢? 这个时候, 我们可以去看看前端是如何处理的 ?
#6.3 代码实现
1). 定义登录校验过滤器
自定义一个过滤器 LoginCheckFilter 并实现 Filter 接口, 在 doFilter 方法中完成校验的逻辑。 那么接下来, 我们就根据上述分析的步骤, 来完成具体的功能代码实现:
所属包: com.itheima.reggie.filter
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
package com.teamwork.takeout.filter;
import com.alibaba.fastjson.JSON;
import com.teamwork.takeout.common.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.AntPathMatcher;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;
/**
* 检查用户是否已经完成登录
* filterName:过滤器在对象容器中的名字
* urlPatterns:匹配路径
*/
@Slf4j
@WebFilter("/")
public class LoginCheckFilter implements Filter {
//路径匹配器,支持通配符
public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest; //获取session中值
HttpServletResponse response = (HttpServletResponse) servletResponse; //重定向
//1、获取本次请求的URI
String requestURI = request.getRequestURI();
// {}占位符
log.info("接受到的请求路径:{}", requestURI);
//定义不需要处理的请求路径--白名单
String[] urls = new String[]{
"/employee/login", // 登陆页 直接放行
"/employee/logout",//注销页 直接放行
"/backend/**", //所有的pc端的 前端资源 放行
"/front/**" //所有的移动端 前端资源 放行
};
//2、判断本次请求是否需要处理
boolean check = check(urls, requestURI);
//3、如果不需要处理,则直接放行
if (check) {
// filterChain.doFilter 放行
filterChain.doFilter(servletRequest, servletResponse);
// 直接返回该方法,下面的代码不要执行了
return;
}
//4、判断登录状态,如果已登录,则直接放行
HttpSession session = request.getSession();
Object employee = session.getAttribute("employee");
// 如果用户id不等于空,说明已经登陆过,直接放行
if (employee != null) {
log.info("用户已经登录,直接放行");
filterChain.doFilter(servletRequest, servletResponse);
// 直接返回该方法,下面的代码不要执行了
return;
}
log.info("用户未登录");
//5、如果未登录则返回未登录结果,通过输出流方式向客户端页面响应数据
// JSON.toJSONString 将对象 转成 JSON字符串 给前端使用 返回的数据一定是NOTLOGIN 且code 为0
response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
//对应一下
return;
}
//遍历,看是否在白名单中
private boolean check(String[] urls, String requestURI) {
for(String URI:urls){
if(URI.equals(requestURI))
return true;
}
return false;
}
}
AntPathMatcher 拓展:
介绍: Spring 中提供的路径匹配器 ; 通配符规则:
符号
含义
?
匹配一个字符
*
匹配 0 个或多个字符
**
匹配 0 个或多个目录/字符
2). 开启组件扫描
需要在引导类上, 加上 Servlet 组件扫描的注解, 来扫描过滤器配置的@WebFilter 注解, 扫描上之后, 过滤器在运行时就生效了。
点击查看代码
@Slf4j
@SpringBootApplication
@ServletComponentScan
public class ReggieApplication {
public static void main(String[] args) {
SpringApplication.run(ReggieApplication.class,args);
log.info("项目启动成功...");
}
}
1
2
3
4
5
6
7
8
9
@ServletComponentScan 的作用:
在 SpringBoot 项目中, 在引导类/配置类上加了该注解后, 会自动扫描项目中(当前包及其子包下)的@WebServlet , @WebFilter , @WebListener 注解, 自动注册 Servlet 的相关组件 ;
#6.4 功能测试
代码编写完毕之后,我们需要将工程重启一下,然后在浏览器地址栏直接输入系统管理后台首页,然后看看是否可以跳转到登录页面即可。我们也可以通过 debug 的形式来跟踪一下代码执行的过程。
对于前端的代码, 也可以进行 debug 调试。
F12 打开浏览器的调试工具, 找到我们前面提到的 request.js, 在 request.js 的响应拦截器位置打上断点。
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 胡小宁的博客!