苍穹外卖-员工管理
1. 苍穹外卖项目里的实体类分为
DTO：用于接收并封装客户端提交的参数
entity：与数据库表对应的实体类
VO：用于封装给客户端返回的数据
2. 项目里应该尽量避免魔法值
使用常量或者枚举来定义值，通过常量名或者枚举名及注释来对值进行说明
3. 项目里的异常：
我们自己的代码，把异常抛出去。尽量都抛BaseException或者它的子类
4. 项目开发过程中：
尽量以debug模式启动项目，出问题之后可以随时打断点调试
出错之后一定要看错误信息
要熟练使用：
Postman或者Swagger的接口界面上进行功能测试
浏览器抓包工具F12-Network（网络）
idea里的debug功能
5. 项目里存储密码时：
绝对不允许存储明文密码
苍穹外卖项目里使用的加密方式是MD5算法：
单向摘要算法，在对数据处理过程中会丢弃一部分数据
是不可逆的。
但是不可逆并不等于不可破解。项目对密码加密时可采用 MD5+加盐
一、员工管理-新增员工
准备工作：
- 先把服务端启动：运行引导类
- 再把nginx启动：双击nginx.exe，去任务管理器里查看一下，如果有两个nginx进程就说明启动成功了
开发功能时的依赖：
- 接口文档
1.1 需求分析和设计
1.1.1 产品原型
一般在做需求分析时，往往都是对照着产品原型进行分析，因为产品原型比较直观，便于我们理解业务。
后台系统中可以管理员工信息，通过新增员工来添加后台系统用户。
新增员工原型：
当填写完表单信息, 点击"保存"按钮后, 会提交该表单的数据到服务端, 在服务端中需要接受数据, 然后将数据保存至数据库中。
注意事项：
- 账号必须是唯一的
- 手机号为合法的11位手机号码
- 身份证号为合法的18位身份证号码
- 密码默认为123456
1.1.2 接口设计
找到资料–>项目接口文档–>苍穹外卖-管理端接口.html
明确新增员工接口的请求路径、请求方式、请求参数、返回数据。
本项目约定：
- 管理端发出的请求，统一使用**/admin**作为前缀。
- 用户端发出的请求，统一使用**/user**作为前缀。
1.1.3 表设计
新增员工，其实就是将我们新增页面录入的员工数据插入到employee表。
employee表结构：
| 字段名 | 数据类型 | 说明 | 备注 |
|---|---|---|---|
| id | bigint | 主键 | 自增 |
| name | varchar(32) | 姓名 | |
| username | varchar(32) | 用户名 | 唯一 |
| password | varchar(64) | 密码 | |
| phone | varchar(11) | 手机号 | |
| sex | varchar(2) | 性别 | |
| id_number | varchar(18) | 身份证号 | |
| status | Int | 账号状态 | 1正常 0锁定 |
| create_time | Datetime | 创建时间 | |
| update_time | datetime | 最后修改时间 | |
| create_user | bigint | 创建人id | |
| update_user | bigint | 最后修改人id |
其中，employee表中的status字段已经设置了默认值1，表示状态正常。
1.2 代码开发
1.2.1 设计DTO类
根据新增员工接口设计对应的DTO
前端传递参数列表：
**思考：**是否可以使用对应的实体类来接收呢？
**注意：**当前端提交的数据和实体类中对应的属性差别比较大时，建议使用DTO来封装数据
由于上述传入参数和实体类有较大差别，所以自定义DTO类。
进入sky-pojo模块，在com.sky.dto包下，已定义EmployeeDTO
package com.sky.dto;
import lombok.Data;
import java.io.Serializable;
@Data
public class EmployeeDTO implements Serializable {
private Long id;
private String username;
private String name;
private String phone;
private String sex;
private String idNumber;
}
1.2.2 Controller层
EmployeeController中创建新增员工方法
进入到sky-server模块中，在com.sky.controller.admin包下，在EmployeeController中创建新增员工方法，接收前端提交的参数。
@PostMapping
@ApiOperation("新增员工")
public Result addEmp(@RequestBody EmployeeDTO dto){
log.info("新增员工：{}", dto);
return employeeService.addEmployee(dto);
}
**注：**Result类定义了后端统一返回结果格式。
进入sky-common模块，在com.sky.result包下定义了Result.java
package com.sky.result;
import lombok.Data;
import java.io.Serializable;
/**
* 后端统一返回结果
* @param <T>
*/
@Data
public class Result<T> implements Serializable {
private Integer code; //编码：1成功，0和其它数字为失败
private String msg; //错误信息
private T data; //数据
public static <T> Result<T> success() {
Result<T> result = new Result<T>();
result.code = 1;
return result;
}
public static <T> Result<T> success(T object) {
Result<T> result = new Result<T>();
result.data = object;
result.code = 1;
return result;
}
public static <T> Result<T> error(String msg) {
Result result = new Result();
result.msg = msg;
result.code = 0;
return result;
}
}
1.2.3 Service层接口
在EmployeeService接口中声明新增员工方法
进入到sky-server模块中,com.sky.server.EmployeeService
/**
* 新增员工
* @param dto 员工信息
* @return
*/
Result addEmployee(EmployeeDTO dto);
1.2.4 Service层实现类
在EmployeeServiceImpl中实现新增员工方法
com.sky.server.impl.EmployeeServiceImpl中创建方法
@Override
public Result addEmployee(EmployeeDTO dto) {
//封装实体类对象
Employee employee = new Employee();
//使用工具类BeanUtils把dto里的数据，拷贝到employee对象里
BeanUtils.copyProperties(dto, employee);
//补充数据
// 默认密码
employee.setPassword(DigestUtils.md5Hex(PasswordConstant.DEFAULT_PASSWORD));
// status状态：
employee.setStatus(StatusConstant.ENABLE);
// createTime和updateTime
LocalDateTime now = LocalDateTime.now();
employee.setCreateTime(now);
employee.setUpdateTime(now);
// createUser和updateUser：先写假数据
employee.setCreateUser(10L);
employee.setUpdateUser(10L);
employeeMapper.insert(employee);
return Result.success();
}
在sky-common模块com.sky.constants包下已定义StatusConstant.java
package com.sky.constant;
/**
* 状态常量，启用或者禁用
*/
public class StatusConstant {
//启用
public static final Integer ENABLE = 1;
//禁用
public static final Integer DISABLE = 0;
}
1.2.5 Mapper层
在EmployeeMapper中声明insert方法
com.sky.EmployeeMapper中添加方法
@Insert("INSERT INTO employee (name, username, password, phone, sex, id_number, status, create_time, update_time, create_user, update_user)" +
" VALUES (#{name}, #{username}, #{password}, #{phone}, #{sex}, #{idNumber}, #{status}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser})")
void insert(Employee employee);
在application.yml中已开启驼峰命名，故id_number和idNumber可对应。
mybatis:
configuration:
#开启驼峰命名
map-underscore-to-camel-case: true
1.3 功能测试
代码已经发开发完毕，对新增员工功能进行测试。
功能测试实现方式：
- 通过接口文档测试
- 通前后端联调测试
接下来我们使用上述两种方式分别测试。
1.3.1 接口文档测试
1) 请求没有携带token测试报401
**启动服务：**访问http://localhost:8080/doc.html，进入新增员工接口
json数据：
{
"idNumber": "111222333444555666",
"name": "xiaozhi",
"phone": "13812344321",
"sex": "1",
"username": "小智"
}
响应码：401 报错
**通过断点调试：**进入到JwtTokenAdminInterceptor拦截器
/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//判断当前拦截到的是Controller的方法还是其他资源
if (!(handler instanceof HandlerMethod)) {
//当前拦截到的不是动态方法，直接放行
return true;
}
//1、从请求头中获取令牌 jwtProperties.getAdminTokenName()获取为token
String token = request.getHeader(jwtProperties.getAdminTokenName());
//2、校验令牌
try {
log.info("jwt校验:{}", token);
Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
log.info("当前员工id：", empId);
//3、通过，放行
return true;
} catch (Exception ex) {
//4、不通过，响应401状态码
response.setStatus(401);
return false;
}
}
**报错原因：**由于JWT令牌校验失败，导致EmployeeController的save方法没有被调用
2) 接口界面里添加请求头token再测试
**解决方法：**调用员工登录接口获得一个合法的JWT令牌
使用admin用户登录获取令牌
添加令牌：
将合法的JWT令牌添加到全局参数中
文档管理–>全局参数设置–>添加参数
- 参数名称：token
- 参数值：刚刚上一步登录后得到的token值
- 参数类型：header
注意：添加了请求头之后，要刷新一下页面才会生效
接口测试：
其中，请求头部含有JWT令牌
查看employee表：
测试成功。
1.3.2 前后端联调测试
启动nginx,访问 http://localhost
登录–>员工管理–>添加员工
保存后，查看employee表
测试成功。
**注意：**由于开发阶段前端和后端是并行开发的，后端完成某个功能后，此时前端对应的功能可能还没有开发完成，
导致无法进行前后端联调测试。所以在开发阶段，后端测试主要以接口文档测试为主。
1.4 代码完善一：增加异常处理器
目前，程序存在的问题主要有两个：
- 录入的用户名已存，抛出的异常后没有处理
- 新增员工时，创建人id和修改人id设置为固定值
接下来，我们对上述两个问题依次进行分析和解决。
问题说明
**描述：**录入的用户名已存，抛出的异常后没有处理
分析：
新增username=zhangsan的用户，若employee表中之前已存在。
后台报错信息：
查看employee表结构：
发现，username已经添加了唯一约束，不能重复。
增加异常处理器
通过全局异常处理器来处理。
进入到sky-server模块，com.sky.hander包下，GlobalExceptionHandler.java添加方法
/**
* 处理SQL异常
* @param ex
* @return
*/
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
//Duplicate entry 'zhangsan' for key 'employee.idx_username'
String message = ex.getMessage();
if(message.contains("Duplicate entry")){
String[] split = message.split(" ");
String username = split[2];
return Result.error(username + MessageConstant.ALREADY_EXISTS);
}else{
return Result.error(MessageConstant.UNKNOWN_ERROR);
}
}
进入到sky-common模块，在MessageConstant.java添加
public static final String ALREADY_EXISTS = "已存在";
再次，接口测试：
1.5 代码完善二：绑定当前用户名
问题说明
描述：新增员工时，创建人id和修改人id设置为固定值
问题分析
通过某种方式动态获取当前登录员工的id。
员工登录成功后会生成JWT令牌并响应给前端：
在sky-server模块
package com.sky.controller.admin;
/**
* 员工管理
*/
@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) {
//.........
//登录成功后，生成jwt令牌
Map<String, Object> claims = new HashMap<>();
claims.put(JwtClaimsConstant.EMP_ID, employee.getId());
String token = JwtUtil.createJWT(
jwtProperties.getAdminSecretKey(),
jwtProperties.getAdminTtl(),
claims);
//............
return Result.success(employeeLoginVO);
}
}
后续请求中，前端会携带JWT令牌，通过JWT令牌可以解析出当前登录员工id：
JwtTokenAdminInterceptor.java
package com.sky.interceptor;
/**
* jwt令牌校验的拦截器
*/
@Component
@Slf4j
public class JwtTokenAdminInterceptor implements HandlerInterceptor {
@Autowired
private JwtProperties jwtProperties;
/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//..............
//1、从请求头中获取令牌
String token = request.getHeader(jwtProperties.getAdminTokenName());
//2、校验令牌
try {
log.info("jwt校验:{}", token);
Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
log.info("当前员工id：", empId);
//3、通过，放行
return true;
} catch (Exception ex) {
//4、不通过，响应401状态码
response.setStatus(401);
return false;
}
}
}
**思考：**解析出登录员工id后，如何传递给Service的save方法？
通过ThreadLocal进行传递。
ThreadLocal介绍
介绍：
ThreadLocal 并不是一个Thread，而是Thread的局部变量。
每个线程都有单独一份存储空间，是一个HashMap，存取数据时以ThreadLocal对象为key，以存储的值为value
这个存储空间具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问。
常用方法：
- public void set(T value) 设置当前线程的线程局部变量的值
- public T get() 返回当前线程所对应的线程局部变量的值
- public void remove() 移除当前线程的线程局部变量
对ThreadLocal有了一定认识后，接下来继续解决问题二
解决问题：使用ThreadLocal绑定当前用户
1) 准备ThreadLocal工具类
初始工程中已经封装了 ThreadLocal 操作的工具类：
在sky-common模块
package com.sky.context;
public class BaseContext {
public static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
public static void setCurrentId(Long id) {
threadLocal.set(id);
}
public static Long getCurrentId() {
return threadLocal.get();
}
public static void removeCurrentId() {
threadLocal.remove();
}
}
2) 修改拦截器代码
在拦截器中解析出当前登录员工id，并放入线程局部变量中：
在sky-server模块中，拦截器：
package com.sky.interceptor;
/**
* jwt令牌校验的拦截器
*/
@Component
@Slf4j
public class JwtTokenAdminInterceptor implements HandlerInterceptor {
@Autowired
private JwtProperties jwtProperties;
/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//.............................
//2、校验令牌
try {
//.................
Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
log.info("当前员工id：", empId);
/将用户id存储到ThreadLocal
BaseContext.setCurrentId(empId);
//3、通过，放行
return true;
} catch (Exception ex) {
//......................
}
}
}
3) Service里获取当前用户
在Service中获取线程局部变量中的值：
测试：使用admin(id=1)用户登录后添加一条记录
查看employee表记录
1.6 代码提交
点击提交：
然后push，最终推送成功：
1.7 小结
ThreadLocal的使用：
作用：用于在同一线程内共享数据的
用法：
1. 创建ThreadLocal对象： ThreadLocal<管理的数据类型> tl = new ThreadLocal<>();
2. 把数据绑定到当前线程上：tl.set(数据);
3. 从当前线程上获取数据： tl.get();
4. 从当前线程上清理数据： tl.remove();
注意：
一个ThreadLocal对象，只能管理一个数据。
使用哪个ThreadLocal对象存储的数据，就必须用哪个ThreadLocal对象获取到这个数据
当使用完成数据之后，一定要把数据从当前线程清理掉；否则可能会存在内存溢出的风险
使用技巧：
通常是创建一个类，类里提供静态的ThreadLocal对象，并提供存取数据的方法
public class Xxxx{
private static final ThreadLocal tl = new ThreadLocal();
public static void setXxx(Xxx xxx){
tl.set(xxx);
}
public static Xxx getXxx(){
return tl.get();
}
public static void remove(){
tl.remove();
}
}
如果需要绑定数据到当前线程：Xxxx.setXxx(值)
如果需要从当前线程获取数据：Xxxx.getXxx()
如果需要从当前线程清理数据：Xxxx.remote();
开发技巧
1. idea格式化代码的快捷键
ctrl + alt + L
2. idea的代码提示快捷键
先设置快捷键，建议设置为alt + /。以后在使用时，按一次快捷键会提示。快速按2次，表示强制提示匹配的内容
内容回顾
1. 如果项目里抛出了一些异常，不在异常处理器的抓取范围内：增加异常处理器
在异常处理器类里再增加一个方法
@ExceptionHandler
public Result handleXxxException(XxxException e){
打印异常信息
给客户端返回友好提示
}
2. 项目里要想随时获取到当前登录的用户：使用了ThreadLocal+拦截器实现的
前提：
登录功能，服务端在登录成功之后，会给客户端返回令牌token
客户端每次请求都会携带token
获取当前登录用户：
增加一个拦截器，要拦截 除了登录功能之外的 所有请求
在preHandle里：
获取token：如果没有token，给客户端返回401，不放行
校验并解析token：如果抛出了异常，说明令牌过期了或者被篡改了，给客户端返回401，不放行
把从令牌里得到的用户id，绑定到当前线程上，放行
在afterCompletion方法里：
从当前线程上把用户id清理掉
在Controller、Service等等我们自己的方法里，要想获取当前用户：
从当前线程上获取
使用到的技术：在同一线程内共享数据的技术 ThreadLocal
注意：
一个ThreadLocal对象，只能管理一个数据。使用哪个ThreadLocal绑定的数据，就只能使用哪个ThreadLocal获取到数据
数据使用完成之后，要从当前线程上清理掉；避免出现内存溢出的风险
API：
创建：ThreadLocal<管理的数据的类型> tl = new ThreadLocal<>();
绑定：tl.set(Object value);
获取：tl.get();
清理：tl.remove();
用法：创建一个类，类里提供静态的ThreadLocal对象和存取数据的方法
...
3. 分页查询：用到了PageHelper
开启分页：PageHelper.startPage(页码,每页几条);
查询列表：Page<> page = xxxMapper.selectList();
Mapper里的方法对应的SQL语句里，不要写limit
PageHelper会帮我们拦截SQL语句的执行，改造我们的SQL语句，变成两条SQL语句：
查询数量的
查询列表的，帮我们加上limit
得到结果：page.getTotal()得到总数量， page.getResults()得到列表
4. 服务端给客户端响应数据，如果有日期，比如LocalDateTime或者LocalDate，或者LocalTime
SpringMVC把这些日期数据转换json时，转换的结果不是常用的格式，而是 [2023, 9, 2, 18, 09, 22]
如果想要给客户端转换成指定格式的字符串：
方式1. 在LocalDateTime类型的属性上加注解@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
方式2. 配置一个统一的日期格式转换器，就不需要加那么多@JsonFormat注解了。参考课堂笔记里的代码
5. 修改功能：所有的修改功能，无论什么项目，通常都包含两个功能
查询：根据id查询数据，页面把查询的结果显示出来。用户会页面上改数据；改之后点击“修改”按钮，才会执行修改操作
修改：把页面上修改后的数据提交到服务端，服务端更新到数据库里
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
