springboot系列——分页插件PageHelper整合

这是mybatis常用的分页插件
引入依赖jar包：

<!--分页插件pagehelper-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.5</version>
</dependency>

分页具体调用

@ApiOperation("分页获取用户信息")
@PostMapping("/pageList")
public PageInfo<User> pageList(@RequestBody UserPageReq req){
   PageHelper.startPage(req.getPageNum(),req.getPageSize());
   User user = new User();
   BeanUtils.copyProperties(req,user);
   List<User> list =  userService.pageList(user);
   PageInfo<User> res = new PageInfo<>(list);
   return new PageInfo<>(list);
}

这里需要说明下：
PageHelper在调用startPage后，只对第一个select查询有效 如果第一个不是你要返回的结果，那么你的最后结果就会出现无法分页问题。
使用实例中封装的req为：

@Data
public class UserPageReq extends BasePageReq {

    @ApiModelProperty(name = "年龄")
    private Integer age;

    @ApiModelProperty(name = "性别")
    private Integer gender;

    @ApiModelProperty(name = "是否已删除0 未删除 1 已删除")
    private Integer isDeleted;
}

@Data
public class BasePageReq {

    @ApiModelProperty(name = "每页条数")
    protected int pageSize = 10;

    @ApiModelProperty(name = "当前页数")
    protected int pageNum = 1;
}

分页获取效果：

分页效果

大功告成！！！
But
从这个返回结果发现，后面一堆的返回参数其实大部分在我们实际开发过程是不需要的，这里我们对分页返回结果做一下封装，一般前端需要的参数total和list，我们再加一个code和message作为参数返回给前端：

@Data
@Builder
public class PageResult<T> implements Serializable {

    /**
     * 总条数
     */
    private long total;

    /**
     * 业务对象
     */
    private List<T> data;

    /**
     * 返回码
     */
    private String code;

    /**
     * 返回消息
     */
    private String message;
}

修改一下Controller中的调用函数返回值和值的构造方式：

@ApiOperation("分页获取用户信息")
@PostMapping("/pageList")
public PageResult<User> pageList(@RequestBody UserPageReq req){
    PageHelper.startPage(req.getPageNum(),req.getPageSize());
    User user = new User();
    BeanUtils.copyProperties(req,user);
    List<User> list =  userService.pageList(user);
    PageInfo<User> res = new PageInfo<>(list);
    return PageResult.<User>builder().message("查询成功").data(res.getList()).total(res.getTotal()).code("200").build();
}

这里需要说明下，这个code是需要调用枚举类的，这里我就直接写了，这里会被阿里插件标注是个魔法值，大家在编程的时候要注意啊！！！
我们来看下封装后的效果：

返回结果

哇，清爽很多！！！