前言今天学习了使用yapi设计接口swagger测试接口并完成了苍穹外卖员工管理的部分目录前言今日完结任务今日收获1. 学会了使用swagger查看和测试接口2. 完成新增员工业务代码开发3.完成员工分页查询业务代码(以下只展示代码开发部分)4.完成员工状态修改业务代码开发5. 完成修改员工信息业务代码开发总结今日完结任务1. 新增员工业务代码开发2. 员工分页查询业务代码开发3. 员工状态修改业务代码开发4. 员工信息编辑业务代码开发今日收获1. 学会了使用swagger查看和测试接口swagger是一个自动生成api文档和测试接口的框架swagger的主要功能是a.根据注解生成api文档。 b.提供一个可视化界面可以查看所有接口的信息。c. 在线测试接口swagger中的常用注解Api(tags) //用在类上例如controller对类进行说明 ApiOperation(value) //用在方法上说明方法的作用 ApiModel(value) //用在类上例如entity,DTO,VO类 ApiModelProperty(value) //用在属性上描述属性信息2. 完成新增员工业务代码开发接口开发步骤 a. 需求分析和设计接口 b. 代码开发 c. 测试接口并完善代码a. 需求分析和设计接口分析需求后通过yapi来设计接口b. 代码开发Controller:PostMapping Apioperation(新增员工) public Result save(RequestBody EmployeeDTO employeeDTO) { log.info(新增员工{},employeeDTO); employeeService.save(employeeDTO); return Result.success(); }(1)关于DTODTO是数据传输类的简称。为什么要使用数据传输类而不是直接使用实体类因为传入的参数中只是实体类中的一部分使用DTO可以保证数据传输的安全性可以避免前端传输不可被修改的数据DTO还可以保证业务的灵活性不同的业务可以使用不同的DTO最后DTO也实现了解耦前端不需要知道数据库中的数据Service: (这里只展示接口的实现类部分)Override public void save(EmployeeDTO employeeDTO) { //将DTO类转换为实体类 Employee employee new Employee(); //二者有相同的属性可以直接使用类拷贝但是要注意属性名要一样 BeanUtils.copyProperties(employeeDTO, employee); //拷贝完后为实体类中不被包含在DTO类中的属性赋值 // id 主键自增所以可以设置为null //设置状态,注意不要写死而是使用常量类中的量 employee.setStatus(StatusConstant.ENABLE); //设置密码默认为123456,不要忘记MD5加密 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); }(1)关于TODO: 通过TODO注释可以来表面哪些功能还未开发完善(2)MD5加密保证了数据的安全性避免数据泄露后导致用户密码泄露(3)ThreadLocal: ThreadLocal为每个线程提供一个单独的存储空间具有线程隔离功能只有在线程内才能获取到对应的值而线程外无法获取。客户端发起的一个请求就是一个线程(4)在第一次测试新增用户接口时会报错错误码为401这是由于测试时的请求头没有携带token所以会被拦截器拦截。解决方法也很简单通过login功能获得到token后添加到swagger的全局变量中即可(5)功能完善新增用户时记录操作者的id,通过上文的ThreadLocal来实现相关方法被定义在BaseContext类中public class BaseContext { public static ThreadLocalLong 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(); } }Mapper: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.完成员工分页查询业务代码(以下只展示代码开发部分)Controller:GetMapping(/page) ApiOperation(员工分页查询) // TODO完善日期的展示形式 public ResultPageResult page(EmployeePageQueryDTO employeePageQuerryDTO) { log.info(员工分页查询,{}, employeePageQuerryDTO); PageResult pageResult employeeService.pageQuerry(employeePageQuerryDTO); return Result.success(pageResult); }Service:(仅展示接口的实现类)Override public PageResult pageQuerry(EmployeePageQueryDTO employeePageQuerryDTO) { //使用pageHelper插件进行分页查询 PageHelper.startPage(employeePageQuerryDTO.getPage(),employeePageQuerryDTO.getPageSize()); PageEmployee result employeeMapper.pageQuerry(employeePageQuerryDTO); long total result.getTotal(); ListEmployee records result.getResult(); return new PageResult(total, records); }Mapper:select idpageQuerry resultTypecom.sky.entity.Employee select * from employee where if test name!null and name! name like concat(%,#{name},%) /if /where order by update_time desc /select使用动态sql,可以支持通过name查询员工(1)PageHelper: 可以自动的进行分页查询在执行Mapper时PageHelper会通过ThreadLocal 来拦截sql语句并自动执行查询功能和分页功能原始sql语句select * from employee order by update_time desc被PageHelper拦截后会自动执行以下两条sql语句#获取total,封装到一个PageT对象的total属性里 select count(*) from employee #自动分页查询封装到PageT对象的result属性里 select * from employee limit page, pageSize得到的结果total,records)被封装到一个PageT类中可以通过getTotal()和getResult()分别获得总树还有分页查询的信息(2)关于TODO:解决时间显示的问题由于一开始的时间被封装成一个数组返回前端 我们需要扩展MVC框架的消息转换器来将时间转换为json格式返回Override protected void extendMessageConverters(ListHttpMessageConverter? converters) { //创建一个消息转换器对象 MappingJackson2HttpMessageConverter converter new MappingJackson2HttpMessageConverter(); //为消息转换器设置一个对象转换器将对象转换为json converter.setObjectMapper(new JacksonObjectMapper()); //将自己的消息转换器加入容器中,0是索引说明我们加入的新的消息转换器排在第一位会被优先使用 converters.add(0,converter); }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); } }关于Jackson:可以将java对象转换为json格式4.完成员工状态修改业务代码开发Controller:PostMapping(/status/{status}) ApiOperation(启用、禁用员工账号) public Result startOrStop(PathVariable Integer status, Long id) { log.info(修改员工状态 {} {},status, id); employeeService.startOrStop(status, id); return Result.success(); }Service:Override //动态修改直接传入实体类而不是传入仅这两个参数 public void startOrStop(Integer status, Long id) { Employee employee Employee.builder() .status(status) .id(id) .build(); employeeMapper.update(employee); }(1)注意这里通过传入实体类来进行update而不是只传入两个固定参数。好处参数没有写死方便后续进行修改(2)builder的使用在Employee类上加Builder注解后可以通过builder来创建实体对象Mapper:update idupdate update employee set if testname!null and name! name #{name} ,/if if testusername!null and username! username#{username}, /if if testpassword!null and password! password#{password}, /if if testphone!null and phone! phone#{phone}, /if if testsex!null and sex! sex#{sex}, /if if testidNumber!null and idNumber! id_number#{idNumber}, /if if teststatus!null status#{status}, /if if testupdateTime!null update_time#{updateTime}, /if if testupdateUser!null update_user#{updateUser}/if /set where id#{id} /update这里使用动态sql5. 完成修改员工信息业务代码开发该功能要实现两个接口接口1按照id查询员工信息用于回显 接口2对指定id员工的信息进行修改Controller:/** * 根据ID查询员工信息 */ GetMapping(/{id}) ApiOperation(根据ID查询员工信息) public Result getById(PathVariable Long id) { log.info(根据Id查询员工信息 {}, id); Employee employee employeeService.getById(id); return Result.success(employee); } /** * 修改员工信息 */ PutMapping ApiOperation(修改员工信息) public Result update(RequestBody EmployeeDTO employeeDTO) { log.info(修改员工信息 {}, employeeDTO); employeeService.update(employeeDTO); return Result.success(); }Service:/** * 根据ID查询员工信息 */ Override public Employee getById(Long id) { Employee employee employeeMapper.getById(id); employee.setPassword(*****); return employee; } /** * 修改员工信息 * param employeeDTO */ Override public void update(EmployeeDTO employeeDTO) { Employee employee new Employee(); BeanUtils.copyProperties(employeeDTO, employee); employee.setUpdateTime(LocalDateTime.now()); employee.setUpdateUser(BaseContext.getCurrentId()); employeeMapper.update(employee); }注意这里在查询员工信息时将返回实体类中的password改为了*****这保证了安全性让前端无法获得用户的密码Mapper:/** * 根据Id查询员工信息 * param id * return */ Select (select * from employee where id #{id}) Employee getById(Long id); /*修改员工信息动态sql*/ void update(Employee employee);修改员工信息的xml与上文修改状态的动态sql相同总结1.学会了使用yapi设计接口2.学会了使用swagger管理和测试接口以及了解了swagger的各种注解使用3.TODO注释的使用用来标记未完善的功能和接口4.通过ThreadLocal来获取当前线程的信息5.了解了PageHelper的实现原理:通过ThreadLocal来实现6. 扩展MVC消息转换器: 创建一个消息转换器convertor,为convertor设置一个消息转换类将设置好的convertor消息转换器传入到convertors容器中记得要把索引设置为0这样设置的转换器就会优先触发7. DTO数据传输类的使用及其优点8. Builder注解和builder的使用来创建对象并为属性赋值