1.新增员工
1.需求分析和设计
1.接口设计
管理端发的请求:/admin前缀
用户端发的请求:/user前缀

2.数据库设计
由于主键ID自增,所以直接由数据库维护即可

2.代码开发
1.根据新增员工接口设计对应的DTO
虽然前端提交的数据对应的DTO的属性在实体类中都包含,精确封装
如果用实体类来传参 不需要的变量是对性能的浪费,如果接口需要的参数很少并且不需要做数据校验的时候 也可以不做封装直接传参
1.设计DTO

2.
2.代码
1.controller
/**
* 新增员工
* @param employeeDTO
* @return
*/
@PostMapping
@ApiOperation("新增员工接口")
public Result save(@RequestBody EmployeeDTO employeeDTO) {
log.info("新增员工:{}", employeeDTO);
employeeService.save(employeeDTO);
return Result.success();
}
2.service
注意
这里调用持久层,把数据插入
但这里插入的是DTO,为了方便封装前端提交过来的数据(实体类)
但最终传给持久层,建议使用实体类
所以这里要做一个对象转换DTO->实体
/**
* 新增员工
* @param employeeDTO
* @return
*/
void save(EmployeeDTO employeeDTO);
/**
* 新增员工
* @param employeeDTO
*/
@Override
public void save(EmployeeDTO employeeDTO) {
//new Employee
Employee employee = new Employee();
//拷贝属性,忽略id属性
BeanUtils.copyProperties(employeeDTO, employee);
//设置账号状态,默认正常状态,1表示正常,0表示锁定,这里还定义了常量类,方便后续修改
employee.setStatus(StatusConstant.ENABLE);
//设置创建时间和修改时间
employee.setCreateTime(LocalDateTime.now());
employee.setUpdateTime(LocalDateTime.now());
//设置创建人,修改人id,即当前登录用户id,后期通过JWT获取
//TODO 后期需要改为当前登录用户id
employee.setCreateUser(1L);
employee.setUpdateUser(1L);
employeeMapper.insert(employee);
}
3.mapper
/**
* 插入员工数据
* @param employee
*/
@Insert("insert into employee " +
"(username, name, password, phone, sex, id_number, status, create_time, update_time, create_user, update_user) " +
"values" +
"(#{username}, #{name}, #{password}, #{phone}, #{sex}, #{idNumber}, #{status}, #{createTime},#{updateTime},#{createUser}, #{updateUser})")
void insert(Employee employee);
3.功能测试
以接口文档为主
mapper层没连接数据库
service层没设置默认密码
4.代码完善
问题
1.录入用户名已存在,抛出异常没处理---全局异常处理器
duplicate唯一键异常
通过全局异常处理器统一捕获SQL异常
首先,复制异常名:SQLIntegrityConstraintViolationException
然后在全局异常处理器新建方法主要处理我们刚刚看到的异常(SQL异常)
/**
* 处理SQL异常
* @param ex
* @return
*/
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
}
现在捕获到异常后怎么处理?--->
在控制台找到该异常的描述(Duplicate entry '水秀英' for key 'employee.idx_username')
粘贴为注释先
然后通过ex.getMessage()捕获异常信息
然后判断异常里面是否有关键字:Duplicate entry
如果有关键字,则说明输出的日志就是上面那段信息
然后我们希望给前端提示:这个添加的用户名已经存在,所以需要动态的把重复那个字符串提取出来
注意:常量类--->提示信息规范
尽量在代码里面少用字符串,而是通过使用常量类,把提示信息规范起来,通过常量去定义
/**
* 处理SQL异常
* @param ex
* @return
*/
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
//Duplicate entry '水秀英' for key 'employee.idx_username'
//获取异常信息,然后判断异常里面是否有关键字:Duplicate entry,如果有关键字,则输出的日志就是上面那段信息
String message = ex.getMessage();
if (message.contains("Duplicate entry")){
//获取用户名
String[] split = message.split(" ");
String username = split[2];
String msg = username + MessageConstant.ALREADY_EXIST;
return Result.error(msg);
}else {
return Result.error(MessageConstant.UNKNOWN_ERROR);
}
}
2.新增员工时,创建人ID和修改人ID设置为固定值,要动态的获取当前用户登录的ID
JWT令牌认证过程
目前问题---传ID
在拦截器解析出Token中的员工登录ID后,怎么传给service的save方法
解决方案:ThreadLocal(存储空间)每次在拦截器添加值,在service取出
是Thread(线程)的一个局部变量
为每个 线程提供独立的空间,具有线程隔离效果,只有在线程内才能获取对应的值,线程外不能访问
而客户端发起的每次请求,tomcat服务器都会给我们,分配一个单独的线程 ,然后在线程上可能要执行不同的代码(con,ser,map),属于同一个线程,满足该条件就可以使用ThreadLocal将数据存进去,再在对应的地方取出。
所以可以在拦截器那:把ID--->当前用户的存到存储空间里面
对应的,当程序执行到service的save方法时,就从该存储空间取值(ID)
set()
get()
remove()
注意:一般包装为工具类
在sky-common-context包下
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();
}
}
过程
1.employeeController(控制层设置ID)
登录这段代码
调用createJWT生成令牌,此时传入一个map对象(claims:有效载荷),这个对象里面已经放了一个empID,具体的值就是登录用户的ID,所以在登录成功生成token时,已经把ID生成在里面了
//登录成功后,生成jwt令牌
Map<String, Object> claims = new HashMap<>();
claims.put(JwtClaimsConstant.EMP_ID, employee.getId());
String token = JwtUtil.createJWT(
jwtProperties.getAdminSecretKey(),
jwtProperties.getAdminTtl(),
claims);
2.JwtTokenAdminInterceptor(拦截器)
对应的,当我们的拦截器把token拦截下来后,就在这个地方
Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
解析,如果校验通过,就可以把empid取出,因为当时生成已经放进去了,所以可以解析出来
所以在拦截器的位置可以把ID取到
取到之后,问题:如何传给service,因为我们希望在我们的service的Save方法里面,也就是新增员工的时候设置ID,
但拦截器并没有直接调用调用service方法
那么通过什么方式把Id传进去?
//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);
//拦截器并没有直接调用调用service方法
//3、通过,放行
return true;
}
3.ThreadLocal
如果满足同一个线程的条件,就可以把数据存入ThreadLocal里面,然后在对应的地方把它取出来即可
现在思路:
在拦截器,把用户登录的ID存到存储空间里面,对应的在service的sace方法从这块存储空间里面把对应用户登录的ID取出
这步是在JwtTokenAdminInterceptor(拦截器)把数据存入ThreadLocal里面
//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);
//用工具类(BaseContext)在当前线程(ThreadLocal)中设置当前登录的员工id
BaseContext.setCurrentId(empId);
//3、通过,放行
return true;
}
然后再save方法取出线程中的值
4.service
//TODO 后期需要改为当前登录用户id
employee.setCreateUser(BaseContext.getCurrentId());
employee.setUpdateUser(BaseContext.getCurrentId());
最后推送并提交
2.员工分页查询
1.需求分析与设计
1.从产品原型获取业务规则

1.根据页码展示员工数据
2.每页展示10条数据
3.分页查询时,可以根据需要,输入员工姓名进行查询
2.设计接口
1.查询操作:get请求
2.查询提交数据:每页页码,每页查询记录数,还有姓名
3.响应数据:总数据,当前这一页展示的数据集合响应回去
注意:请求参数格式
Quary:不是json,而是通过地址栏用?的形式进行传递
2.代码开发
1.所有的分页查询结果都封装成PageResult对象,并统一再封装成Result对象
PageResult:
总记录数
当前页数据集合
/**
* 封装分页查询结果
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageResult implements Serializable {
private long total; //总记录数
private List records; //当前页数据集合
}
由于要返回给前端,所以统一再封装成Result对象:Result<PageResult>
最后将该对象转成json返回给前端
2.步骤
首先
在service模块的 全局yml文件 下
mybatis:
#mapper配置文件
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.sky.entity
configuration:
#开启驼峰命名
map-underscore-to-camel-case: true
1.controller
注意
数据格式如果是json,需要加requestbody注解, 如果数据格式是Query,直接声明参数,springmvc框架会把数据封装成dto对象:EmployeePageQueryDTO
/**
* 员工分页查询
* @param employeePageQueryDTO
* @return
*/
@GetMapping("/page")
@ApiOperation("员工分页查询接口")//生成接口文档
public Result<PageResult> page(EmployeePageQueryDTO employeePageQueryDTO) {
log.info("分页查询:{}", employeePageQueryDTO);
PageResult pageResult = employeeService.pageQuery(employeePageQueryDTO);
return Result.success(pageResult);
}
2.service
注意
分页查询,mybatis提供了pageHelper分页插件,简化分页代码的编写
首先 开启分页查询
然后 该方法返回值固定,就叫Page ,而且有泛型,是Employee实体
@Override
public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
//开启分页查询,参数:页码,每页记录数
PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
//就可以调用mapper层获取分页数据了
Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);
3.mapper
注意
mapper返回值是Page里面的泛型,xml文件里面不要引用错误
/**
* 分页查询
* @param employeePageQueryDTO
* @return
*/
Page<Employee> pageQuery(EmployeePageQueryDTO employeePageQueryDTO);
4.xml
注意:添加MySQL方言
提示表名,可以在Settings | Languages & Frameworks | SQL Dialects里面将两个SQL Dialect设置成MySQL。就可以了
还有resultType="com.sky.entity.Employee
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.sky.mapper.EmployeeMapper">
<select id="pageQuery" resultType="com.sky.entity.Employee">
select * from employee
<where>
<if test="name != null and name != ''">
name like concat('%',#{name},'%')
</if>
</where>
order by create_time desc
</select>
</mapper>
5.解决service返回值
由于
//就可以调用mapper层获取分页数据了,返回值是Page<Employee>,一个page对象,里面封装了分页数据
Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);
但整个方法想返回的是一个PageResult,所以要对Page对象进行加工处理,变成PageResult
然后想到PageResult要构造时,需要两个参数,total,records(返回数据集合),
而Page对象可以拿到这两个属性,所以就可以封装到PageResult里面
@Override
public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
//开启分页查询,参数:页码,每页记录数
PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
//就可以调用mapper层获取分页数据了,返回值是Page<Employee>,一个page对象,里面封装了分页数据
Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);
//获取总记录数,还有数据
long total = page.getTotal();
List<Employee> records = page.getResult();
return new PageResult(total, records);
}
总结
分页实现思路:
pageHelper底层基于ThreadLocal实现,把Page存到 一个存储空间里面了,后面开始分页查询,然后在分页查询前 又通过ThreadLocal把页码和每页记录数取出 ,取出后会动态的把limit关键字拼接上去,并把页码 和每页记录数算出来,然后构成SQL.
3.功能测试
注意
401:token
4.代码完善
问题:
时间格式不对
解决方案:
1.在属性上加上注解@JsonFormat(pattern"")
2.在WebMvcConfiguration扩展SpringMVC的信息转换器,统一对日期类型进行格式化处理。(推荐方案)
扩展SpringMVC的信息转换器--->重写父类的一个方法即可。
信息转换器的作用
统一对我们的后端返回给前端的数据统一进行转换处理,比如这里要进行日期类型的格式化
代码+解释
该方法在程序启用时就会被调用到
后面我们就会统一使用这个消息转换器对LocalDateTime这类型的数据进行统一的格式化处理
/**
* 扩展SpringMVC框架的消息转换器,将String类型转换成json
* 作用:统一对我们的后端返回给前端的数据统一进行转换处理,比如这里要进行日期类型的格式化
* @param converters
*/
@Override
protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
log.info("扩展消息转换器...");
//创建一个消息转换器对象
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
//为消息转换器设置对象转换器,对象转换器:将Java对象序列化为json数据
//对象转换器底层使用Jackson将Java对象转为json数据
//对象转换器已经在common模块的json包中已经定义了,这里直接使用
//该JacksonObjectMapper()类不需要我们编写,因为是固定的代码,只需要知道这个类作用即可
converter.setObjectMapper(new JacksonObjectMapper());
//设置对象转换器后,由于设置的消息转换器还没有交给SpringMVC框架,所以框架也不会去使用消息转换器
//将自己的消息转换器对象追加到converters(容器)中,它是一个集合,集合中存放的是整个SpringMVC框架所使用的消息转换器对象
converters.add(0,converter);
//然后的话,容器里面框架已经自带了一些消息转换器,add之后,我们的消息转换器对象就会放在最后一个,消息转换器是有顺序的,排在最后默认是使用不到的
//我们现在希望自己的消息转换器对象优先使用,所以可以加一个参数0,表示索引,0表示第一个,优先使用
}
注意
对象转换器底层使用Jackson将Java对象转为json数据 对象转换器已经在common模块的json包中已经定义了,这里直接使用 该JacksonObjectMapper()类不需要我们编写,因为是固定的代码,只需要知道这个类作用即可
package com.sky.json;
/**
* 对象映射器:基于jackson将Java对象转为json,或者将json转为Java对象
* 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]
* 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]
*/
public class JacksonObjectMapper extends ObjectMapper {
public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
//public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
public JacksonObjectMapper() {
super();
//收到未知属性时不报异常
this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);
//反序列化时,属性不存在的兼容处理
this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
SimpleModule simpleModule = new SimpleModule()
.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
//注册功能模块 例如,可以添加自定义序列化器和反序列化器
this.registerModule(simpleModule);
}
}
3.启用禁用员工账号
1.需求分析与设计
业务规则:
•可以对状态为"启用" 的员工账号进行"禁用"操作
•可以对状态为"禁用"的员工账号进行"启用"操作
•状态为"禁用"的员工账号不能登录系统
2.代码开发
提交参数:
ID(地址栏传参)、status(路径参数)
1.controller
注意:
这里返回值泛型不是强制的,然后这个项目的规则是,针对查询类的操作,因为要返回Data数据,这个时候就建议把泛型加上,对于非查询类,就不需要泛型,因为最终只需要返回一个code即可,data往往是空的。
/**
* 账号禁用/启用
* @param status
* @param id
* @return
*/
@PostMapping("/status/{status}")
@ApiOperation("员工账号禁用/启用")
public Result startOrStop(@PathVariable Integer status, Long id) {
log.info("员工账号禁用/启用,员工状态:{},员工id:{}", status, id);
employeeService.startOrStop(status, id);
return Result.success();
}
2.service
/**
* 启用禁用员工账号
* @param status
* @param id
*/
void startOrStop(Integer status, Long id);
注意:使用动态update
这里把update语句写成动态的,也就是不止修改status,而是根据传进来参数的不同,可以修改多个字段,这样update语句通用性就更强点。
然后这里调用mapper的update方法进行动态更新,传参应该是实体类才合适(就是说还要添加时间修改,最好用实体类封装,而不是传入ID、status)
传入employee是为了通用性 以后要通过其他字段修改值 也可以使用这个update方法
注意:两种构造实体对象方法
1.由于实体类有@Builder注解(构建器)
/**
* 启用禁用员工账号
* @param status
* @param id
*/
@Override
public void startOrStop(Integer status, Long id) {
Employee employee = Employee.builder()
.status(status)
.id(id)
.updateTime(LocalDateTime.now())
.build();
employeeMapper.update(employee);
}
2.new()
Employee employee = new Employee();
employee.setStatus(status);
employee.setId(id);
employee.setUpdateTime(LocalDateTime.now());
employee.setUpdateUser(BaseContext.getCurrentId());
employeeMapper.startOrStop(employee);
3.mapper
/**
* 根据id动态修改属性
* @param employee
* @return
*/
void update(Employee employee);
4.xml
<update id="update">
update employee
<set>
<if test="username != null">username = #{username},</if>
<if test="name != null">name = #{name},</if>
<if test="password != null">password = #{password},</if>
<if test="phone != null">phone = #{phone},</if>
<if test="sex != null">sex = #{sex},</if>
<if test="idNumber != null">id_number = #{idNumber},</if>
<if test="status != null">status = #{status},</if>
<if test="updateTime != null">update_time = #{updateTime},</if>
<if test="updateUser != null">update_user = #{updateUser},</if>
</set>
where id = #{id}
</update>
3.功能测试
4.编辑员工
1.需求分析与设计
1.功能分析
点击修改进行页面跳转到编辑页面 
这个页面回显当前员工信息
根据实际需要可以修改它的信息
此操作就是对员工信息的一个简单修改
2.接口分析
1.回显操作需要根据ID 来查询数据,然后再在这个页面做到回显
这个查就需要对应一个接口
2.修改信息完后点击保存,最终真正修改到我们的数据库,就是第二个接口
1.GET,并通过路径参数传入ID
2.PUT

2.代码开发
1.查询
1.controller
/**
* 查询回显员工信息
* @param id
* @return
*/
@GetMapping("/{id}")
@ApiOperation("员工查询接口")
public Result<Employee> getById(@PathVariable Long id) {
log.info("员工查询接口,员工id:{}", id);
Employee employee = employeeService.getById(id);
return Result.success(employee);
}
2.service
/**
* 根据id查询员工信息
* @param id
* @return
*/
Employee getById(Long id);
/**
* 根据id查询员工信息
*
* @param id
* @return
*/
@Override
public Employee getById(Long id) {
Employee employee = employeeMapper.getById(id);
return employee;
}
3.mapper
/**
* 根据id查询员工信息
* @param id
* @return
*/
@Select("select * from employee where id = #{id}")
Employee getById(Long id);
2.编辑
1.controller
/**
* 修改员工信息
* @param employeeDTO
* @return
*/
@PutMapping
@ApiOperation("员工修改接口")
public Result update(@RequestBody EmployeeDTO employeeDTO) {
log.info("员工修改接口,员工信息:{}", employeeDTO);
employeeService.update(employeeDTO);
return Result.success();
}
2.service
/**
* 编辑员工信息
* @param employeeDTO
*/
void update(EmployeeDTO employeeDTO);
/**
* 编辑员工信息
* @param employeeDTO
*/
@Override
public void update(EmployeeDTO employeeDTO) {
Employee employee = new Employee();
BeanUtils.copyProperties(employeeDTO, employee);
employee.setUpdateTime(LocalDateTime.now());
//注意,这里是使用BaseContext.getCurrentId()这个工具类(线程)获取当前登录用户的id(拦截器里面已经设置好)
employee.setUpdateUser(BaseContext.getCurrentId());
employeeMapper.update(employee);
}
这里实现类也可以使用之前修改状态的update方法,因为之前使用了动态修改
由于之前的update方法返回类型是Employee,而这里接受的是EmployeeDTO对象,所以要对数据进行转换
这里直接通过对象属性拷贝即可,但由于是修改操作,还需要设置修改时间,修改人
注意
这里是使用BaseContext.getCurrentId()这个工具类(线程)获取当前登录用户的id(拦截器里面已经设置好)
3.mapper
之前有了,复用之前的
3.功能测试
5.导入分类管理功能代码(之后可以练习)
以后开发菜品管理、套餐管理、移动端的一些功能都会使用到这个分类
1.需求分析与设计
1.业务规则
分类名称唯一
分类按照类型分为菜品分类 和套餐分类
新添加的分类状态默认为禁用(防止新添加的分类如果默认为启用的话,会展示在移动端,而新分类是肯定没有菜品和套餐的,这样新添加的分类是没有意义的,而禁用状态就不会展示,避免了这种情况)
2.接口设计
1.新增分类
2.分类分页查询
3.根据ID删除分类
4.修改分类
5.启用禁用分类
6.根据类型查询分类
3.注意:导入过程
从mapper层开始,防止代码报错
4.注意:为什么导入其他mapper
原因:这个地方有一个业务的限定,比如:
要删除一个分类的时候,并不是直接删,需要判断该分类下边是否挂菜品(即需要查询菜品表、套餐表),看看当前菜品还有套餐是否属于该分类的,所以这里使用到菜品和套餐的mapper
注意还有映射文件的导入
注意:根据类型查询分类前端写错了,和分页查询共用一个URL,"/page",所以要在pageQuery里写list方法的业务逻辑!!!
注意:拷进这些类可能的的问题
它有可能不会自动编译,建议手动去maven那里编译一下
如果是自己写的,不是拷的,一般情况都会自动编译