PageHelper分页

Love The Way You Lie 2024-04-20 10:20 90阅读 0赞

我们在任何的系统中，分页功能是必不可少的。然而，对于这个功能如果有一种快速开发的实现方式，当然可以节省我们很多的时间了。接下来，我就给大家基于不同的环境来说说如何使用一个分页插件：`pagehelper`，它是`Mybatis`的一个分页插件。  
这里使用一个简单的`springboot`的demo项目来实现，前台页面使用的`Thymeleaf`模板引擎。  
首先加入`pageHelper`的依赖。

<dependency>
                <groupId>com.github.pagehelper</groupId>
                <artifactId>pagehelper-spring-boot-starter</artifactId>
                <version>1.2.5</version>
            </dependency>

然后在配置文件中加入`pageHelper`的相关配置。

# pageHelper配置
    # 指定数据库
    pagehelper.helper-dialect=mysql
    # 页码<=0 查询第一页，页码>=总页数查询最后一页
    pagehelper.reasonable=true
    # 支持通过 Mapper 接口参数来传递分页参数
    pagehelper.support-methods-arguments=true

`pageHelper`就可以使用了。  
（基本的`springboot`的搭建步骤就不说了，之前已经写过文章）  
简单的去数据库查一张表，达到分页效果。  
`dao`层

@Select(value = "select * from address")
        List<Map> pageListss();

`service`层和`serviceImpl`层

List<Map> pageListss( Integer pn);

@Override
        public List<Map> pageListss(Integer pn) { 
        //判断的目的是前台访问的路径没有pn参数，则pn当前页参数默认为1（第一页）
            if(pn==null){ 
                pn=1;
            }
            //参数（当前页，一页展示多少条）
            PageHelper.startPage(pn,3);
            //只有在startPage下面的第一个select动作会被分页
            List<Map> pageList=selectMapper.pageListss();
            //把查到的list列表进行pageInfo处理，返回一个分页列表
            PageInfo<Map> pageInfo=new PageInfo(pageList);
            return pageList;
        }

`controller`层

@Controller
    @RequestMapping(value = "/page")
    public class PageController { 
        @Autowired
        SelectService selectService;
        @RequestMapping("list")//pn是当前页，页面传给后台
        public String list(Integer pn,Model model){ 
    		//这时，从service返回来的列表list已经是被分页后的列表了
            List<Map> list=selectService.pageListss(pn);
            //把分页后的list放到model中，在页面展示信息（thymeleaf模板引擎使用model放置信息）
            model.addAttribute("list",list);
            return "test";
        }
    }

`test.html`

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>pageHelper练习</title>
    </head>
    <body>
    <table border="1">
        <thead>
        <tr>
            <th>ID</th>
            <th>地址</th>
            <th>详细地址</th>
            <th>电话</th>
            <th>账号</th>
        </tr>
        </thead>
        <tbody>
        <tr th:each="user : ${list}">
            
            <td th:text="${user.id}"></td>
            <td th:text="${user.location}"></td>
            
            <td th:text="${user.detail}"></td>
            
            <td th:text="${user.phone}"></td>
            <td th:text="${user.account}"></td>
        </tr>
        </tbody>
    </table>
    当前第 <span th:text="${list.pageNum}"></span> 页.
    总共 <span th:text="${list.pages}"></span> 页.
    一共 <span th:text="${list.total}"></span> 条记录
    <a th:href="@{/page/list?pn=1}">首页</a>
    <a th:href="@{ '/page/list?pn='+${list.pageNum-1}}">上一页</a>
    <a th:href="@{ '/page/list?pn='+${list.pageNum+1}}">下一页</a>
    <a th:href="@{ '/page/list?pn='+${list.pages}}">尾页</a>
    
    </body>
    </html>

访问路径`http://localhost:8082/page/list` pn参数会默认会1  
结果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70]  
说明：上面的`${list.pageNum}`，`${list.pages}`，`${list.total}`等这些属性都是属于`list`的，此时这个`list`是被分页后的列表，是从`service`层传回来的`pageInfo`分页列表。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70 1]  
而这个被`pageHelper`插件处理后的`pageInfo`列表具有诸多属性。  
`pageInfo`类说明（源码分析）

public class PageInfo<T> implements Serializable { 
        private static final long serialVersionUID = 1L;
        //当前页
        private int pageNum;
        //每页的数量
        private int pageSize;
        //当前页的数量
        private int size;
     
        //由于startRow和endRow不常用，这里说个具体的用法
        //可以在页面中"显示startRow到endRow 共size条数据"
     
        //当前页面第一个元素在数据库中的行号
        private int startRow;
        //当前页面最后一个元素在数据库中的行号
        private int endRow;
        //总记录数
        private long total;
        //总页数
        private int pages;
        //结果集
        private List<T> list;
     
        //前一页
        private int prePage;
        //下一页
        private int nextPage;
     
        //是否为第一页
        private boolean isFirstPage = false;
        //是否为最后一页
        private boolean isLastPage = false;
        //是否有前一页
        private boolean hasPreviousPage = false;
        //是否有下一页
        private boolean hasNextPage = false;
        //导航页码数
        private int navigatePages;
        //所有导航页号
        private int[] navigatepageNums;
        //导航条上的第一页
        private int navigateFirstPage;
        //导航条上的最后一页
        private int navigateLastPage;
     
        public PageInfo() { 
        }
     
        /** * 包装Page对象 * * @param list */
        public PageInfo(List<T> list) { 
            this(list, 8);
        }
     
        /** * 包装Page对象 * * @param list page结果 * @param navigatePages 页码数量 */
        public PageInfo(List<T> list, int navigatePages) { 
            if (list instanceof Page) { 
                Page page = (Page) list;
                this.pageNum = page.getPageNum();
                this.pageSize = page.getPageSize();
     
                this.pages = page.getPages();
                this.list = page;
                this.size = page.size();
                this.total = page.getTotal();
                //由于结果是>startRow的，所以实际的需要+1
                if (this.size == 0) { 
                    this.startRow = 0;
                    this.endRow = 0;
                } else { 
                    this.startRow = page.getStartRow() + 1;
                    //计算实际的endRow（最后一页的时候特殊）
                    this.endRow = this.startRow - 1 + this.size;
                }
            } else if (list instanceof Collection) { 
                this.pageNum = 1;
                this.pageSize = list.size();
     
                this.pages = this.pageSize > 0 ? 1 : 0;
                this.list = list;
                this.size = list.size();
                this.total = list.size();
                this.startRow = 0;
                this.endRow = list.size() > 0 ? list.size() - 1 : 0;
            }
            if (list instanceof Collection) { 
                this.navigatePages = navigatePages;
                //计算导航页
                calcNavigatepageNums();
                //计算前后页，第一页，最后一页
                calcPage();
                //判断页面边界
                judgePageBoudary();
            }
        }
    .......
    }

这里只列出所有属性和构造方法，那么可以清晰的看到一些属性的含义，一些属性是如何初始化，并且初始化值是怎样的，更多详细情况可以自己去查看源码。

以上的分页需求，可以非常方便的使用。  
项目经理再也不用担心我的分页了！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/07c9c7dc65d34a098ce54e6fcee4a9fb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/78cbf89ba78748fdbce3f4a134a90f13.png