当前位置：首页 > news >正文

【苍穹外卖|项目日记】第二天

news 2026/5/12 17:02:16

前言：

今天学习了使用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)关于DTO，DTO是数据传输类的简称。为什么要使用数据传输类而不是直接使用实体类，因为传入的参数中只是实体类中的一部分，使用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 ThreadLocal<Long> 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 Result<PageResult> 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()); Page<Employee> result = employeeMapper.pageQuerry(employeePageQuerryDTO); long total = result.getTotal(); List<Employee> records = result.getResult(); return new PageResult(total, records); }

Mapper:

<select id="pageQuerry" resultType="com.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,封装到一个Page<T>对象的total属性里 select count(*) from employee #自动分页查询，封装到Page<T>对象的result属性里 select * from employee limit page, pageSize

得到的结果（total,records)被封装到一个Page<T>类中，可以通过getTotal()和getResult()分别获得总树还有分页查询的信息

(2)关于TODO:解决时间显示的问题

由于一开始的时间被封装成一个数组返回前端，我们需要扩展MVC框架的消息转换器，来将时间转换为json格式返回

@Override protected void extendMessageConverters(List<HttpMessageConverter<?>> 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 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="password!=null and password!='' "> password=#{password}, </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"> status=#{status}, </if> <if test="updateTime!=null"> update_time=#{updateTime}, </if> <if test="updateUser!=null"> update_user=#{updateUser}</if> </set> where id=#{id} </update>

这里使用动态sql

5. 完成修改员工信息业务代码开发

该功能要实现两个接口，接口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相同