1.封装PageHelper实现分页

前言

　　这几天想着动手将一些技术融合到项目中，昨天思考了会儿，想起了我与亲戚的对话：我说：“我想将若依项目完整的实现一遍”，亲戚给我反馈到“你没必要完整复现若依项目，而且你的时间不允许，你可以将它里面的功能融合到你的项目中去”。他说的很多话对我受益不浅，我认真思考了下，决定将若依的一些技术点融合到自己的项目中去。这篇博客，我将若依里面的分页实现运用于我自己编写的简单工单平台上面。接下来让我们看看若依是如何实现分页的把。

1.导入依赖

<!--实现分页-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.6</version>
</dependency>

　　首先我们导入依赖，这样才能使用分页这个功能。

2.配置文件

#pageHelper分页
pagehelper.helper-dialect=mysql
pagehelper.support-methods-arguments=true
pagehelper.params=count=countSql

　　在导入依赖之后，我们还需要进行配置文件的配置才能使这个分页插件生效

3.分页实现代码分析

3.1 Controller中的分页实现

　　在controller层中，我们如果要实现数据分页显示，必须在startPage()后面添加要分页查询的列表数据，再在最后返回分页数据

代码如下：

@GetMapping("/list")
public TableDataInfo list(@RequestParam(value = "name", required = false) String username){
    //继承BaseController类，直接调用其中的分页方法
    startPage();
    List<SysUser> list = userDetailsService.getUserListByUsername(username);
    //继承BaseController中返回分页查询数据方法，显示查询的总数、信息、状态码、返回消息
    return getDataTable(list);
}

3.2 startPage()和getDataTable()方法

　　在上述代码中，startPage()方法和getDataTable()方法都是定义在BaseController中的代码，我们的SYSUserController类通过继承该类来实现复用分页以及返回分页数据的方法。下面是BaseController中startPage()方法和getDataTable()方法代码实现：

protected void startPage(){
    PageUtils.startPage();
}

@SuppressWarnings({ "rawtypes", "unchecked" })
protected TableDataInfo getDataTable(List<?> list)
{
    TableDataInfo rspData = new TableDataInfo();
    rspData.setCode(0);
    rspData.setRows(list);
    rspData.setTotal(new PageInfo(list).getTotal());
    rspData.setMsg("分页查询成功！");
    return rspData;
}

3.3 startPage()方法具体实现

　　在上面的代码中，我们会发现BaseController中是通过PageUtils工具类的startPage()方法来实现分页的，作者将startPage()方法进行了封装，若依项目其实封装了很多知识点，使得很多代码复用，很厉害。而getDataTable()方法其实是返回TableDataInfo类的对象，该对象将list对象作为参数，返回分页查询的信息，状态码以及状态信息和查询信息的总数。

　　下面我们再进一步看一下PageUtils类是如何实现startPage()方法的

/**
 * 设置请求分页数据
 */
public static void startPage(){
    //通过TableSupport设置客户输入的分页属性
    PageDomain pageDomain = TableSupport.buildPageRequest();
    Integer pageNum = pageDomain.getPageNum();
    Integer pageSize = pageDomain.getPageSize();
    String orderBy = SqlUtil.escapeOrderBySql(pageDomain.getOrderBy());
    Boolean reasonable = pageDomain.getReasonable();
    PageHelper.startPage(pageNum, pageSize, orderBy).setReasonable(reasonable);
}

3.4 使用单例模式中的IoDH创建单例分页类

　　在上述代码中PageDomian实体类设置了分页的属性，如起始页、每页大小、升序或降序排序、合理性等等，那作者是如何具体创建PageDomain对象的呢？很显示是通过TableSupport的builePageRequest()方法来创建pageDomain对象的，下面我们再来看看它具体是如何创建的

public static PageDomain getPageDomain()
{
    PageDomain pageDomain = new PageDomain();
    //首先获取用户输入的分页参数信息，如果转换错误，则使用默认值
  pageDomain.setPageNum(Convert.toInt(ServletUtils.getParameter(PAGE_NUM), 1));
    pageDomain.setPageSize(Convert.toInt(ServletUtils.getParameter(PAGE_SIZE), 10));
    //后面使用的默认值
    pageDomain.setOrderByColumn(ServletUtils.getParameter(ORDER_BY_COLUMN));
    pageDomain.setIsAsc(ServletUtils.getParameter(IS_ASC));
    pageDomain.setReasonable(ServletUtils.getParameterToBool(REASONABLE));
    return pageDomain;
}

//为什么不直接调用getPageDomain()方法返回一个对象而是重新创建一个方法返回这个对象呢？
//这里使用的单例模式中的IoDH技术,使用静态内部类来封装属性，
//该对象通过buildPageRequest()方法返回给外部使用
public static PageDomain buildPageRequest()
{
    return getPageDomain();
}

通过IoDH创建单例PageDomain对象

　　在上面代码中首先通过一个静态方法创建一个PageDomain对象，并封装它所需要的属性，首先从客户端获取进行转换，如果转换失败就是用默认值，最后再返回PageDomain对象，在这里我当时很感慨为什么不直接调用getPageDomian()方法，而是将其传入到一个静态方法中返回PageDomain对象。后面想着这跟单例模式中最好的IoDH方法很相似。在我学习的单例模式中的IoDH例题中是使用一个静态内部类来创建单例对象，而上述代码是运用同样的形式来创建并封装单例分页对象的属性，再都是通过一个静态方法返回创建对象的方法，两者之间有着异曲同工之妙，这代码既保证了延迟加载，也保证了线程安全，很赞！

4.在若依分页实现中作者自写的工具类

    在若依项目中，作者定义了很多自定义的工具类，很厉害。在分页实现中的自定义工具类如下：

详细的源码请看若依项目，链接为RuoYi: 基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、MyBatis、Shiro没有任何其它重度依赖。直接运行即可用 (gitee.com)

5.分页查询结果

　　在上述图片中，我们可以看到分页查询的结果，由于数据库中同一名字的user太少，所以只是显示了一个，但这不影响代码的正确性。返回结果汇总包含了用户的信息、状态码、查询的用户总数目、以及状态信息。

6.小结

　　首先在Controller方法中，调用satrtPage()方法来实现分页，且该语句只会对第一个查询到的数据进行分页，最后返回参数为list的getDataInfo()方法即返回查询的信息以分页显示、显示数据总数、数据信息状态码、以及查询成功返回信息。创建一个TableSupport类使用一个静态内部类创建一个单例PageDomain对象来封装该对象的属性信息。

　　如果本文中存在问题，请大家踊跃指出，谢谢！