SpringBoot员工分页查询

需求分析与设计

一：产品原型

系统中的员工很多的时候，如果在一个页面中全部展示出来会显得比较乱，不便于查看，所以一般的系统中都会以分页的方式来展示列表数据。而在我们的分页查询页面中, 除了分页条件以外，还有一个查询条件 "员工姓名"。

查询员工原型：

业务规则：

• 根据页码展示员工信息

• 每页展示10条数据

• 分页查询时可以根据需要（非必须——>动态SQL），输入员工姓名进行查询

 二：接口设计

查询——>get

三个参数——>员工姓名(非必须）、页码、每页记录数

找到资料-->项目接口文档-->苍穹外卖-管理端接口.html

 

 细节：

• 请求参数是Query类型，无需@RequestBody，不是json格式提交，在路径后直接拼接。/admin/employee/page?name=zhangsan

• total：总记录数

• records[]：当前这一页需要展示的数据集合

• 返回数据中records数组中使用Employee实体类对属性进行封装。

代码开发

一：设计DTO类

将前端的请求参数封装成DTO对象，在sky-pojo模块中：

package com.sky.dto;

import lombok.Data;

import java.io.Serializable;

@Data
public class EmployeePageQueryDTO implements Serializable {

    //员工姓名
    private String name;

    //页码
    private int page;

    //每页显示记录数
    private int pageSize;

}

二：封装PageResult（分页查询重点）

后面所有的分页查询，统一都封装为PageResult对象。

在sky-common模块的result包下(包中定义返回类）

package com.sky.result;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.util.List;

/**
 * 封装分页查询结果
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageResult implements Serializable {

    private long total; //总记录数

    private List records; //当前页数据集合

}

还需要后端统一返回结果：员工信息分页查询后端返回的对象类型为: Result<PageResult>

三：Controller类

	/**
     * 员工分页查询
     * @param employeePageQueryDTO
     * @return
     */
    @GetMapping("/page")
    @ApiOperation("员工分页查询")
    public Result<PageResult> page(EmployeePageQueryDTO employeePageQueryDTO){
        log.info("员工分页查询，参数为：{}", employeePageQueryDTO);
        PageResult pageResult = employeeService.pageQuery(employeePageQueryDTO);//后续定义
        return Result.success(pageResult);
    }

 四：Service类

	/**
     * 分页查询
     *
     * @param employeePageQueryDTO
     * @return
     */
    public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
        // select * from employee limit 0,10
        //开始分页查询
        PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());

        Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);//后续定义

        long total = page.getTotal();
        List<Employee> records = page.getResult();

        return new PageResult(total, records);
    }

注意：

<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>${pagehelper}</version>
</dependency>

此处使用 mybatis 的分页插件 PageHelper 来简化分页代码的开发，调用startPage方法告诉Page对象当前页码以及一页多少记录。

Page对象是该插件提供的，调用pageQuery方法自动的进行分页操作。

mapper层只需要正常的进行查询即可，无需考虑分页。

故在pom.xml文中添加依赖

<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>${pagehelper}</version>
</dependency>

五：Mapper层

	/**
     * 分页查询
     * @param employeePageQueryDTO
     * @return
     */
    Page<Employee> pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

利用alt+enter点击create statements快速在对应的XML文件快速生成select动态sql语句：

<select id="pageQuery" resultType="com.sky.entity.Employee">
        select * from employee
        <where>
            <if test="name != null and name != ''">
                and name like concat('%',#{name},'%')
            </if>
        </where>
        order by create_time desc
    </select>

功能测试

 代码完善

问题描述：操作时间字段显示有问题。

服务端返回给前端的是数组类型。 

解决方式：

1). 方式一

在属性上加上注解，对日期进行格式化

解决方式：

1). 方式一

在属性上加上注解，对日期进行格式化

解决方式：

1). 方式一

在属性上加上注解，对日期进行格式化

但这种方式，需要在每个时间属性上都要加上该注解，使用较麻烦，不能全局处理。

2). 方式二（推荐 )

在WebMvcConfiguration中扩展SpringMVC的消息转换器，统一对日期类型进行格式处理

	/**
     * 扩展Spring MVC框架的消息转化器
     * @param converters
     */
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        log.info("扩展消息转换器...");
        //创建一个消息转换器对象
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        //需要为消息转换器设置一个对象转换器，对象转换器可以将Java对象序列化为json数据
        converter.setObjectMapper(new JacksonObjectMapper());
        //将自己的消息转化器加入容器中
        converters.add(0,converter);
    }

 添加后，再次测试

时间格式定义，sky-common模块中

package com.sky.json;

public class JacksonObjectMapper extends ObjectMapper {

	//.......
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
    //.......

    }
}

注意：

/**
 * 对象映射器:基于jackson将Java对象转为json，或者将json转为Java对象
 * 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]
 * 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]
 */