首先进行控制器EmployeeController编写
@PostMapping
@ApiOperation("新增员工")
public Result save(@RequestBody EmployeeDTO employeeDTO) {
log.info("新增员工:{}",employeeDTO);
System.out.println("当前线程的id:"+Thread.currentThread().getId());
employeeService.save(employeeDTO);
return Result.success();
}
@PostMapping
这是一个Spring MVC 提供的注解,用于指定当前方法处理 HTTP POST 请求
@ApiOperation("新增员工")
这是 Swagger UI 的注解,用于文档生成(以下是Swagger 配置)
@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;
}
/**
* 设置静态资源映射
* @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/");
}
Knife4j工具会自动为你生成一个预构建的 HTML 文件,通常命名为 doc.html
,并将其放置在类路径下的 META-INF/resources/
目录中。
接口文档,访问http://localhost:8080/doc.html#/
回到EmployeeController
public Result save(@RequestBody EmployeeDTO employeeDTO)中,返回类型是 Result
类型的对象,用来封装响应结果的数据。
@RequestBody
注解,表示方法参数 employeeDTO
将从请求体中读取 JSON 数据,并将其转换为 EmployeeDTO
对象。EmployeeDTO
是一个专门用于封装数据的对象,不用实体类的原因是1.实体泄露2.耦合度高。
hread.currentThread().getId() 被用来获取当前线程的 ID
最后调用employeeService
中save方法
编写save方法在实体类中
@Override
public void save(EmployeeDTO employeeDTO) {
System.out.println("当前线程的id:"+Thread.currentThread().getId());
Employee employee = new Employee();
//对象属性拷贝
BeanUtils.copyProperties(employeeDTO, employee);
//设置账号状态
employee.setStatus(StatusConstant.ENABLE);
//设置密码,默认123456
employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));
//创建时间
employee.setCreateTime(LocalDateTime.now());
employee.setUpdateTime(LocalDateTime.now());
//设置当前记录创建人id
//TODO 后期要改为当前登录用户id
employee.setCreateUser(BaseContext.getCurrentId());
employee.setUpdateUser(BaseContext.getCurrentId());
employeeMapper.insert(employee);
}
BaseContext中当前用户登录的id获取方法:在jwt校验中
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.setCurrentId((empId));
//3、通过,放行
return true;
}
如果唯一的用户名已经存在,配置一个全局异常处理
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
//Duplicate entry 'zyc' for key 'employee.idx_username'
String message = ex.getMessage();
if(message.contains("Duplicate entry")){
String[] split = message.split(" ");
String username=split[2];
String msg=username+ MessageConstant.ALREADY_RXIXTS;
return Result.error(msg);
}else {
return Result.error((MessageConstant.UNKNOWN_ERROR));
}
}
最后返回存储成功结果
到此新增员工功能结束,接口文档测试: