1 新增员工
1.1 设计
前端表单:
路径:/admin/employee
方法:POST
本项目约定:
管理端发出的请求,统一使用 /admin 作为前缀
用户端发出的请求,统一使用 /user 作为前缀
存在数据库中的实体类对象:
package com.sky.entity;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.time.LocalDateTime;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Employee implements Serializable {
private static final long serialVersionUID = 1L;
private Long id;
private String username;
private String name;
private String password;
private String phone;
private String sex;
private String idNumber;
private Integer status;
//@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime createTime;
//@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime updateTime;
private Long createUser;
private Long updateUser;
}
而前端表单需要的信息只有前面几项,所以额外设计一个 DTO
DTO,即数据传输对象(Data Transfer Object),是一种在应用程序中用于在不同层或组件之间传输数据的设计模式。DTO通常用于客户端和服务器之间的数据交换,或者在应用程序的不同层(如表示层和业务逻辑层)之间传递数据
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 代码实现
@RequestBody
是一个在Java Spring框架中使用的注解,它主要用于将HTTP请求的正文(body)映射到一个Java对象中。这个注解通常用在Spring MVC控制器的方法参数上,以便自动处理请求体的序列化和反序列化
Service 层
在 Mapper 编写 SQL 语句
1.3 测试
两种测试:
1、接口文档测试
2、前后端联调(没有前端)
访问 localhost:8080/doc.html
发送数据 -> 无响应
因为被 jwt 拦截器拦截
package com.sky.interceptor;
import com.sky.constant.JwtClaimsConstant;
import com.sky.properties.JwtProperties;
import com.sky.utils.JwtUtil;
import io.jsonwebtoken.Claims;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* 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 {
//判断当前拦截到的是 Controller 的方法还是其他资源
if (!(handler instanceof HandlerMethod)) {
//当前拦截到的不是动态方法,直接放行
return true;
}
//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;
}
}
}
需要先登录拿到 token
在全局参数设置 token
然后再新增员工
数据库中已经有数据了
1.4 代码完善
当前代码存在的问题:
1、新增一个重复用户名的用户,仅仅是抛出异常
2、创建人 和 修改人 不是当前登录的用户
1.4.1 处理异常
抛出异常
SQLIntegrityConstraintViolationException
SQLIntegrityConstraintViolationException
是 Java JDBC API 中的一个异常,它表示数据库操作违反了完整性约束。这通常发生在尝试插入或更新数据时,违反了数据库表的约束规则,如主键约束、唯一约束、外键约束或检查约束等
全局异常处理器
@RestControllerAdvice
是Spring框架中的一个注解,用于定义一个类作为全局异常处理器。当使用Spring MVC构建RESTful Web服务时,@RestControllerAdvice
类可以捕获和处理控制器抛出的异常,并将它们转换为合适的HTTP响应
package com.sky.handler;
import com.sky.constant.MessageConstant;
import com.sky.exception.BaseException;
import com.sky.result.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.sql.SQLIntegrityConstraintViolationException;
/**
* 全局异常处理器,处理项目中抛出的业务异常
*/
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
/**
* 捕获业务异常
*
* @param ex
* @return
*/
@ExceptionHandler
public Result exceptionHandler(BaseException ex) {
log.error("异常信息:{}", ex.getMessage());
return Result.error(ex.getMessage());
}
/**
* 处理 SQL 异常
*
* @param ex
* @return
*/
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex) {
// Duplicate entry 'ada' for key 'employee.idx_username'
if (ex.getMessage().contains("Duplicate entry")) {
String[] s = ex.getMessage().split(" ");
String username = s[2]; // 拿到用户名
String msg = username + MessageConstant.ALREADY_EXIST;
return Result.error(msg);
}else{
return Result.error(MessageConstant.UNKNOWN_ERROR);
}
}
}
成功捕获异常,返回错误信息
1.4.2 // TODO 后期改为当前登录用户的 id
ThreadLocal 并不是一个Thread,而是Thread的同部变量。ThreadLocal为每个线程提供单独一份存储空间,具有线程隔离的效果,只有在线程内才能获取到对应的值,线程外则不能访问
ThreadLocal 常用方法:
- public void set(T value) 设置当前线程的线程局部变量的值
- public T get() 返回当前线程所对应的线程局部变量的值
- public void remove() 移除当前线程的线程局部变量
工具类 BaseContext
在隔离器中,设置 currentID
在 service 层实现类,直接获取
2 员工分页查询
业务规则:
1、根据页码展示员工信息
2、每页展示10条数据
3、分页查询时可以根据需要,输入员工姓名进行查询
路径:/admin/employee/page
方法:GET
请求参数:
DTO
分页查询结果封装为 PageResult
员工信息分页查询后端返回的对象类型为:Result<PageResult>
Controller层
Service
利用插件 PageHelper
在 Mapper 层,不使用注解,使用 xml
首先在配置文件里面配置映射
在 xml 里面填写查询语句,不用写 limit 分页,因为使用了 PageHelper 插件
用到了模糊匹配,concat 字符串拼接
测试:
2.1 代码完善
存在的问题:
2.1.1 返回的时间格式错误
解决方式一:
在 Employee 类时间属性上加注解
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
格式正确
解决方式二:
在 WebMvcConfiguration 中扩展 Spring MVC 的消息转换器,统一对日期类型进行格式化处理
package com.sky.json;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;
/**
* 对象映射器:基于 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 启用禁用员工账号
3.1 设计
Path:/admin/employee/status/{status}
Method:POST
Query 参数:
- Query 参数是通过 URL 的查询字符串(即 URL 中的
?
后面跟随的部分)来传递的键值对- 它们是可选的,不是必须的,用于过滤或修改请求的结果
- Query参数在URL中以
&
分隔,例如:http://example.com/api/items?sort=price&order=asc
- 它们不会影响 URL 的路径部分,而是附加在URL的末尾
路径参数:
- 路径参数是 URL 路径的一部分,通常用于标识资源的唯一标识符或资源的属 性
- 它们是必需的,并且是 URL 的一部分,例如:
http://example.com/api/items/123
,其中123
是路径参数,标识了特定的资源ID- 路径参数在 URL 中用斜杠
/
分隔,并且通常用于 RESTful API设计中
3.2 实现
parameterType
用于指定传递给SQL语句的参数应该从哪种Java类型获取
Controller 层
status 通过地址栏作为路径参数传入,需要加上注解 @PathVariable
而 id 不需要加注解的原因:id 是作为 Query 参数传入,不是在 URL 上
@PathVariable
是Spring Web框架中用于RESTful Web服务的一个注解,它允许你将URL路径中的变量提取出来,并将它们作为参数传递给控制器(Controller)的处理方法
Service 层
使用了 builder 构造器
与以下代码等价:
Employee e = new Employee();
e.setStatus(status);
e.setId(id);
Mapper
xml 映射
测试:
4 编辑员工
实现的功能:
1、根据 id 查询员工
2、编辑员工信息
4.1 根据 id 查询员工
当设计RESTful API并且需要 将资源的标识符或其他属性值作为 URL 的一部分时
使用注解 @PathVariable
Service
Mapper
注意是有返回值的
测试
4.2 编辑员工信息
Controller
输入数据是 JSON,使用注解 @RequestBody
service
持久层需要的是 Employee 对象,而不是 DTO,需要 对象复制
使用 BeanUtils.copyProperties()
另外修改操作加上 修改时间 和 修改人
Mapper
依次判断哪些字段为空
5 分类相关接口
分类的实体类:
package com.sky.entity;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.time.LocalDateTime;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Category implements Serializable {
private static final long serialVersionUID = 1L;
private Long id;
//类型: 1菜品分类 2套餐分类
private Integer type;
//分类名称
private String name;
//顺序
private Integer sort;
//分类状态 0标识禁用 1表示启用
private Integer status;
//创建时间
private LocalDateTime createTime;
//更新时间
private LocalDateTime updateTime;
//创建人
private Long createUser;
//修改人
private Long updateUser;
}
@RestController
是Spring框架中的一个注解,用于标识一个类作为 Web RESTful 控制器的组件。这个注解是@Controller
和@ResponseBody
注解的组合,通常用于处理 HTTP 请求和返回响应体,特别是在创建RESTful Web服务时。
@Service
是Spring框架中的一个注解,用于标识一个类作为服务层组件(Service Layer Component)。服务层通常包含业务逻辑,并且可以被Spring的依赖注入系统管理。这个注解是@Component
注解的一个特化形式,它提供了额外的语义信息,表明一个类在应用程序中扮演的角色
@RequestMapping
是Spring MVC中用于映射HTTP请求到控制器的处理方法的注解。它是一个组合注解,这意味着它可以包含其他注解,如@GetMapping
、@PostMapping
、@PutMapping
、@DeleteMapping
等,这些都是在Spring 4.3中引入的,用于提供更具体的HTTP动作映射。
@PathVariable
注解在Spring MVC中用于从URL路径中提取变量,并将这些变量作为参数传递给控制器的处理方法
package com.sky.controller.admin;
import com.sky.dto.CategoryDTO;
import com.sky.dto.CategoryPageQueryDTO;
import com.sky.entity.Category;
import com.sky.result.PageResult;
import com.sky.result.Result;
import com.sky.service.CategoryService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.models.auth.In;
import org.apache.poi.hssf.record.chart.CategorySeriesAxisRecord;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
* 分类管理
*/
@RestController
// 设置一个默认的映射
@RequestMapping("/admin/category")
@Api(tags = "分类相关接口")
public class CategoryController {
@Autowired
private CategoryService categoryService;
/**
* 修改分类
*
* @param categoryDTO
* @return
*/
@PutMapping
@ApiOperation("修改分类")
public Result updateCategory(@RequestBody CategoryDTO categoryDTO) {
categoryService.update(categoryDTO);
return Result.success();
}
/**
* 分类分页查询
*
* @param categoryPageQueryDTO
* @return
*/
// 参数是通过 Query 传递,在地址栏中通过问号“?”分隔
@GetMapping("/page")
@ApiOperation("分类分页查询")
public Result<PageResult> page(CategoryPageQueryDTO categoryPageQueryDTO) {
PageResult pageResult = categoryService.page(categoryPageQueryDTO);
return Result.success(pageResult);
}
/**
* 启用禁用分类
*
* @param status
* @param id
* @return
*/
@PostMapping("/status/{status}")
@ApiOperation("启用禁用分类")
public Result startOrStop(@PathVariable Integer status, Long id) {
categoryService.startOrStop(status, id);
return Result.success();
}
/**
* 新增分类
*
* @param categoryDTO
* @return
*/
@PostMapping
@ApiOperation("新增分类")
public Result add(@RequestBody CategoryDTO categoryDTO) {
categoryService.add(categoryDTO);
return Result.success();
}
/**
* 根据 id 删除分类
*
* @param id
* @return
*/
@DeleteMapping
@ApiOperation("根据 id 删除分类")
// 注意 id 不要加 @PathVariable,因为参数不在 URL 中
public Result delete(Long id) {
categoryService.delete(id);
return Result.success();
}
/**
* 根据类型查询分类
*
* @param type
* @return
*/
@GetMapping("/list")
@ApiOperation("根据类型查询分类")
public Result<Category> getByType(@PathVariable Integer type) {
Category category = categoryService.getByType(type);
return Result.success(category);
}
}