主要内容:
- 实现新增员工功能
- 实现员工分页查询功能
- 实现设置员工账号状态
- 实现修改员工账号信息
1、新增员工功能
后端大致流程:
Controller层:前端传输的JSON格式数据,使用EmployeeDTO接收,注意添加@RequestBody,接着调用Service层的 save方法
Service层:由于DTO主要是做各层之间传输数据使用,现在需要将传入的数据交给Mapper插入到数据库中,因此Service这里处理EmployeeDTO转为Entity类的Employee并补全属性,再调用Mapper层的save方法
Mapper层:普通的插入操作,注意对应字段名即可
解决不能添加重复员工问题
当传入的数据中username已经在数据库中存在时会报异常:SQLIntegrityConstraintViolationException
此时会报错信息:
java.sql.SQLIntegrityConstraintViolationException: Duplicate entry 'wangwu' for key 'employee.idx_username'
在全局异常处理其中创建对应捕捉该异常的方法:
- 添加方法注解@ExceptionHandler
- 在方法形参中设置捕捉的异常类
- 获取异常信息
- 封装对应错误信息进Result并返回
@ExceptionHandler
public Result exceptionSQLExceptionHandler(SQLIntegrityConstraintViolationException ex){
log.info("异常信息:{}", ex.getMessage());
ex.printStackTrace();
// 获取异常信息并将其按照空格进行分割变为数组
String[] split = ex.getMessage().split(" ");
// 获取数组中的第3个元素
if(split[2]!=null&&split[2]!=""){
// 拼接字符串到返回结果中
return Result.error(split[2]+MessageConstant.USERNAME_EXIST);
}
return Result.error(MessageConstant.UNKNOWN_ERROR);
}
解决思路:由于报错的异常信息格式是固定为"Duplicate entry 'XXX' for key 'employee.idx_username' " ,因此获取该异常信息,并按照空格分割为数组得到重复的用户名,封装进Result中返回给前端,前端根据该信息给相应提示
2、分页查询
请求路径
localhost:8080/admin/employee/page
请求参数
name
page
pageSize
Controller层
@ApiOperation("分页查询员工接口")
@GetMapping("/page")
public Result<PageResult> page(EmployeePageQueryDTO employeePageQueryDTO){
log.info("分页查询员工操作:" + employeePageQueryDTO);
PageResult pageResult=employeeService.page(employeePageQueryDTO);
return Result.success(pageResult);
}
主要操作:
1.接收请求参数封装到EmployeePageQueryDTO
2.日志打印操作信息
3.调用employeeService的page方法传入DTO
4.返回Result结果
Service层
@Override
public PageResult page(EmployeePageQueryDTO employeePageQueryDTO) {
//设置分页查询的页码和每页记录数
PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
//数据库中查询数据存入集合
List<Employee> employeeList = employeeMapper.page(employeePageQueryDTO.getName());
Page<Employee> page= (Page<Employee>)employeeList;
//封装返回总记录数和数据
return new PageResult(page.getTotal(), page.getResult());
}
主要操作:
1.调用PageHelper插件实现分页查询
2.调用PageHelper的startPage方法传入 分页查询的页码 和 每页记录数
3.调用Mapper层通过name值查询数据得到一个List<Employee>集合
4.将该List集合强转为Page<Employee>
5.创建PageResult对象传入 总记录数 和 查询到的结果数据
3、解决日期格式显示问题
在Java中LocalDate类型数据存在如果转为Json格式,会变成数组而不是字符串显示的问题
3.1解决方式一
在LocalDate类型的属性上方添加@JsonFormat("yyyy-MMM-dd HH:mm:ss")
3.2解决方式二
创建类
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);
}
}
修改配置类
@Override
protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
//创建消息转化器对象
MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
//设置对象转换器
messageConverter.setObjectMapper(new JacksonObjectMapper());
//将消息转化器对象添加到消息转化器集合中
converters.add(0,messageConverter);
}
4、修改员工账号状态功能
4.1接口文档
请求路径:
http:8080/admin/employee/status/{status}?id=XXX
请求方式:POST
请求参数:
路径参数 1 为启用,0为禁止
4.2Controller层
@ApiOperation("修改员工账号状态")
@PostMapping("/status/{status}")
public Result updateStatus(@PathVariable Integer status, Long id) {
log.info("修改员工状态操作:" + status + "操作员工:" + id);
Employee employee = Employee.builder()
.status(status)
.id(id)
.build();
employeeService.update(employee);
return Result.success();
}
主要操作
- 接收路径参数status状态码和id
- 日志打印操作
- 通过Builder建造者模式创建一个Employee对象
- 调用Service层的update方法
- 返回成功结果
4.3Service层
/**
* 修改员工账号状态
*
* @param employee
*/
@Override
public void update(Employee employee) {
employee.setUpdateTime(LocalDateTime.now());
employee.setUpdateUser(BaseContext.getCurrentId());
employeeMapper.update(employee);
}
主要操作:
- 给传递来的employee对象补全信息,修改时间和当前操作用户
- 调用Mapper层的update修改方法
4.4Mapper层
<update id="update">
UPDATE employee
<set>
<if test="name != null and name !=''">
name = #{name},
</if>
<if test="username != null and username !=''">
username = #{username},
</if>
<if test="phone != null and phone !=''">
phone = #{phone},
</if>
<if test="sex != null and sex !=''">
sex = #{sex},
</if>
<if test="idNumber != null and idNumber !=''">
id_number = #{idNumber},
</if>
<if test="status != null and password !=''">
status = #{status},
</if>
<if test="updateTime != null and password !=''">
update_time = #{updateTime},
</if>
<if test="updateUser != null and password !=''">
update_user = #{updateUser},
</if>
<if test="password != null and password !=''">
password = #{password},
</if>
</set>
<where>
id = #{id}
</where>
</update>
通过动态SQL语句,增强SQL性能和强健性
5、修改员工账号信息
修改员工操作主要涉及两个请求
1、通过id获取到需要修改员工的原本信息显示到页面
2、将修改后的信息更新到数据库
5.1通过Id获取到需要修改员工的信息
请求路径:/admin/emploee/{ id }
请求方式:GET
请求参数: Id
返回数据:
- code
- date
- createTime
- createUser
- id
- idNumber
- name
- password
- phone
- sex
- status
- updateTime
- updateUser
- username
- msg
Controlle层
/**
* 根据ID查询员工
* @param id
* @return
*/
@ApiOperation("根据ID查询员工")
@GetMapping("/{id}")
public Result<Employee> findById(@PathVariable Long id) {
log.info("根据ID查询员工操作:" + id);
Employee employee= employeeService.findById(id);
return Result.success(employee);
}
主要操作:
- 由于请求方式是Get,因此id是携带在请求路径中的。形参接收时需要添加@PathVariable注解
- 日志打印操作
- 调用Service层的findById操作
- 返回查询到的结果封装进Result
Service层
@Override
public Employee findById(Long id) {
Employee employee = employeeMapper.findById(id);
return employee;
}
主要操作:调用mapper层的findById
Mapper层
@Select ("select * from employee where id = #{id}")
Employee findById (Long id )
5.2更新数据库员工信息
请求路径:/admin/employee
请求方式:PUT
请求参数:
- id
- idNumber
- name
- phone
- sex
- username
返回数据类型:Result
- code
- data
- msg
Controller层
/**
* 修改员工信息
* @param employee
* @return
*/
@ApiOperation("修改员工信息")
@PutMapping
public Result update(@RequestBody Employee employee) {
log.info("修改员工信息操作:" + employee);
employeeService.update(employee);
return Result.success();
}
主要操作:
- 由于请求参数是JSON格式,因此要在形参前加@RequestBody
- 日志打印信息
- 调用Service层的update
- 返回Result结果
Service层
/**
* 修改员工账号状态
*
* @param employee
*/
@Override
public void update(Employee employee) {
//1、补全修改时间、修改人
employee.setUpdateTime(LocalDateTime.now());
employee.setUpdateUser(BaseContext.getCurrentId());
//2、调用mapper层方法
employeeMapper.update(employee);
}
主要操作:
- 补全修改信息中的更新时间和操作人
- 调用Mapper层的update方法