新增员工功能开发
员工管理效果:
1. 新增员工
1.1 需求分析和设计
1.1.1 产品原型
后台系统中可以管理员工信息,通过新增员工来添加后台系统用户。
新增员工原型:
当填写完表单信息, 点击"保存"按钮后, 会提交该表单的数据到服务端, 在服务端中需要接受数据, 然后将数据保存至数据库中。
注意事项:
- 账号必须是唯一的。
- 手机号为合法的11位手机号码。
- 身份证号为合法的18位身份证号码。
- 密码默认为123456。
1.1.2 接口设计
- 管理端发出的请求,统一使用 /admin 作为前缀。
- 用户端发出的请求,统一使用 /user作为前缀。
1.1.3 表设计
新增员工,其实就是将我们新增页面录入的员工数据插入到employee表。
employee表结构:
字段名数据类型说明****备注idbigint主键自增namevarchar(32)姓名usernamevarchar(32)用户名唯一passwordvarchar(64)密码phonevarchar(11)手机号sexvarchar(2)性别id_numbervarchar(18)身份证号statusInt账号状态1正常 0锁定create_timeDatetime创建时间update_timedatetime最后修改时间create_userbigint创建人idupdate_userbigint最后修改人id
其中,employee表中的status字段已经设置了默认值1,表示状态正常。
1.2 代码开发
1.2.1 设计DTO类
根据新增员工接口设计对应的DTO
前端传递参数列表:
思考:是否可以使用对应的实体类来接收呢?
注意:当前端提交的数据和实体类中对应的属性差别比较大时,建议使用DTO来封装数据
由于上述传入参数和实体类有较大差别,所以自定义DTO类。
进入sky-pojo模块,在com.sky.dto包下,已定义EmployeeDTO
packagecom.sky.dto;importlombok.Data;importjava.io.Serializable;@DatapublicclassEmployeeDTOimplementsSerializable{privateLong id;privateString username;privateString name;privateString phone;privateString sex;privateString idNumber;}
1.2.2 Controller层
EmployeeController中创建新增员工方法
进入到sky-server模块中,在com.sky.controller.admin包下,在EmployeeController中创建新增员工方法,接收前端提交的参数。
/**
* 新增员工
* @param employeeDTO
* @return
*/@PostMapping@ApiOperation("新增员工")publicResultsave(@RequestBodyEmployeeDTO employeeDTO){
log.info("新增员工:{}",employeeDTO);
employeeService.save(employeeDTO);//该方法后续步骤会定义returnResult.success();}
注:Result类定义了后端统一返回结果格式。
进入sky-common模块,在com.sky.result包下定义了Result.java
packagecom.sky.result;importlombok.Data;importjava.io.Serializable;/**
* 后端统一返回结果
* @param <T>
*/@DatapublicclassResult<T>implementsSerializable{privateInteger code;//编码:1成功,0和其它数字为失败privateString msg;//错误信息privateT data;//数据publicstatic<T>Result<T>success(){Result<T> result =newResult<T>();
result.code =1;return result;}publicstatic<T>Result<T>success(T object){Result<T> result =newResult<T>();
result.data = object;
result.code =1;return result;}publicstatic<T>Result<T>error(String msg){Result result =newResult();
result.msg = msg;
result.code =0;return result;}}
1.2.3 Service层接口
在EmployeeService接口中声明新增员工方法
进入到sky-server模块中,com.sky.server.EmployeeService
/**
* 新增员工
* @param employeeDTO
*/voidsave(EmployeeDTO employeeDTO);
1.2.4 Service层实现类
在EmployeeServiceImpl中实现新增员工方法
com.sky.server.impl.EmployeeServiceImpl中创建方法
/**
* 新增员工
*
* @param employeeDTO
*/publicvoidsave(EmployeeDTO employeeDTO){Employee employee =newEmployee();//对象属性拷贝BeanUtils.copyProperties(employeeDTO, employee);//设置账号的状态,默认正常状态 1表示正常 0表示锁定
employee.setStatus(StatusConstant.ENABLE);//设置密码,默认密码123456
employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));//设置当前记录的创建时间和修改时间
employee.setCreateTime(LocalDateTime.now());
employee.setUpdateTime(LocalDateTime.now());//设置当前记录创建人id和修改人id
employee.setCreateUser(10L);//目前写个假数据,后期修改
employee.setUpdateUser(10L);
employeeMapper.insert(employee);//后续步骤定义}
在sky-common模块com.sky.constants包下已定义StatusConstant.java
packagecom.sky.constant;/**
* 状态常量,启用或者禁用
*/publicclassStatusConstant{//启用publicstaticfinalIntegerENABLE=1;//禁用publicstaticfinalIntegerDISABLE=0;}
1.2.5 Mapper层
在EmployeeMapper中声明insert方法
com.sky.EmployeeMapper中添加方法
/**
* 插入员工数据
* @param employee
*/@Insert("insert into employee (name, username, password, phone, sex, id_number, create_time, update_time, create_user, update_user,status) "+"values "+"(#{name},#{username},#{password},#{phone},#{sex},#{idNumber},#{createTime},#{updateTime},#{createUser},#{updateUser},#{status})")voidinsert(Employee employee);
在application.yml中已开启驼峰命名,故id_number和idNumber可对应。
mybatis:configuration:#开启驼峰命名map-underscore-to-camel-case:true
1.3 功能测试
1.3.1 接口文档测试
启动服务:访问http://localhost:8080/doc.html,进入新增员工接口
json数据:
{"id":0,"idNumber":"111222333444555666","name":"xiaozhi","phone":"13812344321","sex":"1","username":"小智"}
响应码:401 报错
通过断点调试:进入到JwtTokenAdminInterceptor拦截器
/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/publicbooleanpreHandle(HttpServletRequest request,HttpServletResponse response,Object handler)throwsException{//判断当前拦截到的是Controller的方法还是其他资源if(!(handler instanceofHandlerMethod)){//当前拦截到的不是动态方法,直接放行returntrue;}//1、从请求头中获取令牌 jwtProperties.getAdminTokenName()获取为tokenString 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、通过,放行returntrue;}catch(Exception ex){//4、不通过,响应401状态码
response.setStatus(401);returnfalse;}}
报错原因:由于JWT令牌校验失败,导致EmployeeController的save方法没有被调用
解决方法:调用员工登录接口获得一个合法的JWT令牌
使用admin用户登录获取令牌
添加令牌:
将合法的JWT令牌添加到全局参数中
文档管理–>全局参数设置–>添加参数
接口测试:
其中,请求头部含有JWT令牌
查看employee表:
测试成功。
1.4 代码完善
目前,程序存在的问题主要有两个:
- 录入的用户名已存,抛出的异常后没有处理
- 新增员工时,创建人id和修改人id设置为固定值
接下来,我们对上述两个问题依次进行分析和解决。
1.4.1 问题一
描述:录入的用户名已存,抛出的异常后没有处理
分析:
新增username=zhangsan的用户,若employee表中之前已存在。
后台报错信息:
查看employee表结构:
发现,username已经添加了唯一约束,不能重复。
解决:
通过全局异常处理器来处理。
进入到sky-server模块,com.sky.hander包下,GlobalExceptionHandler.java添加方法
/**
* 处理SQL异常
* @param ex
* @return
*/@ExceptionHandlerpublicResultexceptionHandler(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];String msg = username +MessageConstant.ALREADY_EXISTS;returnResult.error(msg);}else{returnResult.error(MessageConstant.UNKNOWN_ERROR);}}
进入到sky-common模块,在MessageConstant.java添加
publicstaticfinalStringALREADY_EXISTS="已存在";
再次,接口测试:
1.4.2 问题二
描述:新增员工时,创建人id和修改人id设置为固定值
分析:
/**
* 新增员工
*
* @param employeeDTO
*/publicvoidsave(EmployeeDTO employeeDTO){Employee employee =newEmployee();//................//当前设置的id为固定值10//
employee.setCreateUser(10L);
employee.setUpdateUser(10L);////.................................
employeeMapper.insert(employee);//后续步骤定义}
解决:
通过某种方式动态获取当前登录员工的id。
员工登录成功后会生成JWT令牌并响应给前端:
在sky-server模块
packagecom.sky.controller.admin;/**
* 员工管理
*/@RestController@RequestMapping("/admin/employee")@Slf4j@Api(tags ="员工相关接口")publicclassEmployeeController{@AutowiredprivateEmployeeService employeeService;@AutowiredprivateJwtProperties jwtProperties;/**
* 登录
*
* @param employeeLoginDTO
* @return
*/@PostMapping("/login")@ApiOperation(value ="员工登录")publicResult<EmployeeLoginVO>login(@RequestBodyEmployeeLoginDTO employeeLoginDTO){//.........//登录成功后,生成jwt令牌Map<String,Object> claims =newHashMap<>();
claims.put(JwtClaimsConstant.EMP_ID, employee.getId());String token =JwtUtil.createJWT(
jwtProperties.getAdminSecretKey(),
jwtProperties.getAdminTtl(),
claims);//............returnResult.success(employeeLoginVO);}}
后续请求中,前端会携带JWT令牌,通过JWT令牌可以解析出当前登录员工id:
JwtTokenAdminInterceptor.java
packagecom.sky.interceptor;/**
* jwt令牌校验的拦截器
*/@Component@Slf4jpublicclassJwtTokenAdminInterceptorimplementsHandlerInterceptor{@AutowiredprivateJwtProperties jwtProperties;/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/publicbooleanpreHandle(HttpServletRequest request,HttpServletResponse response,Object handler)throwsException{//..............//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、通过,放行returntrue;}catch(Exception ex){//4、不通过,响应401状态码
response.setStatus(401);returnfalse;}}}
思考:解析出登录员工id后,如何传递给Service的save方法?
通过ThreadLocal进行传递。
1.4.3 ThreadLocal
介绍:
ThreadLocal 并不是一个Thread,而是Thread的局部变量。
ThreadLocal为每个线程提供单独一份存储空间,具有线程隔离的效果,只有在线程内才能获取到对应的值,线程外则不能访问。
常用方法:
- public void set(T value) 设置当前线程的线程局部变量的值
- public T get() 返回当前线程所对应的线程局部变量的值
- public void remove() 移除当前线程的线程局部变量
对ThreadLocal有了一定认识后,接下来继续解决问题二
初始工程中已经封装了 ThreadLocal 操作的工具类:
在sky-common模块
packagecom.sky.context;publicclassBaseContext{publicstaticThreadLocal<Long> threadLocal =newThreadLocal<>();publicstaticvoidsetCurrentId(Long id){
threadLocal.set(id);}publicstaticLonggetCurrentId(){return threadLocal.get();}publicstaticvoidremoveCurrentId(){
threadLocal.remove();}}
在拦截器中解析出当前登录员工id,并放入线程局部变量中:
在sky-server模块中,拦截器:
packagecom.sky.interceptor;/**
* jwt令牌校验的拦截器
*/@Component@Slf4jpublicclassJwtTokenAdminInterceptorimplementsHandlerInterceptor{@AutowiredprivateJwtProperties jwtProperties;/**
* 校验jwt
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/publicbooleanpreHandle(HttpServletRequest request,HttpServletResponse response,Object handler)throwsException{//.............................//2、校验令牌try{//.................Claims claims =JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);Long empId =Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
log.info("当前员工id:", empId);/将用户id存储到ThreadLocalBaseContext.setCurrentId(empId);//3、通过,放行returntrue;}catch(Exception ex){//......................}}}
在Service中获取线程局部变量中的值:
/**
* 新增员工
*
* @param employeeDTO
*/publicvoidsave(EmployeeDTO employeeDTO){//.............................//设置当前记录创建人id和修改人id
employee.setCreateUser(BaseContext.getCurrentId());//目前写个假数据,后期修改
employee.setUpdateUser(BaseContext.getCurrentId());
employeeMapper.insert(employee);}
测试:使用admin(id=1)用户登录后添加一条记录
查看employee表记录
后记
👉👉💕💕美好的一天,到此结束,下次继续努力!欲知后续,请看下回分解,写作不易,感谢大家的支持!! 🌹🌹🌹
版权归原作者 失重外太空. 所有, 如有侵权,请联系我们删除。