AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Mybatis分页插件PageHelper的学习与使用

2022-12-29 474
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Mybatis分页插件PageHelper的学习与使用

PageHelper使用

至于怎么使用我想上面提供的两个项目讲的绝逼讲的比我清楚，下面直接进入PageHelper使用实战


首先，集成引入分页插件有下面2种方式，一种是直接下jar包一种是mawen依赖，推荐使用 Maven 方式。


方法一： 直接下载jar包


jar包下载地址，由于使用了sql 解析工具，你还需要下载 jsqlparser.jar


方法二： Maven添加依赖


<dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.2</version>
  </dependency>

1.导入maven依赖分页插件


我这里就采用方法二maven依赖


2.各个情况下xml的配置


情况一：如果是mybatis单独使用PageHelper分页插件的时候，就需要在xml配置中添加如下代码：


<!--
plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下properties?, settings?,
 typeAliases?, typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?, 
 environments?, databaseIdProvider?, mappers?
  -->
  <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugins> 
    <!-- 使用下面的方式配置参数，推荐的两个项目中有所有的参数介绍 -->
        <plugin interceptor="com.github.pagehelper.PageInterceptor"> 
            <property name="param1" value="value1"/>
        </plugin>
    </plugins>

情况二：显然，我是这个是ssm项目，mybatis是交由spring的IOC容器管理的，就需要在spring的xml配置中添加如下代码（创建工厂中添加）：


<!-- 把交给IOC管理 SqlSessionFactory -->
 <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
     <property name="dataSource" ref="dataSource"/>
     <!-- 传入PageHelper的插件 -->
     <property name="plugins">
         <array>
             <!-- 传入插件的对象 -->
             <bean class="com.github.pagehelper.PageInterceptor">
                 <property name="properties">
                     <props>
                         <prop key="helperDialect">oracle</prop>
                         <prop key="reasonable">true</prop>
                     </props>
                 </property>
             </bean>
         </array>
     </property>
 </bean>


下面用一个图来分析一下两个参数作用：

更多情况请参考上面推荐的项目~


3.Controller代码编写


上面我们配置完了，至于为什么从controller代码开始是因为controller调用service嘛，这样编写代码更方便快捷！为了看出差别，未分页的controller代码方法如下：


@Controller
@RequestMapping("/orders")
public class OrdersController {
    @Autowired
    private IOrdersService ordersService;
//查询所有orders未分页
   @RequestMapping("/findAll.do")
    public ModelAndView findAll() {
        ModelAndView mv = new ModelAndView();
        List<Orders> ordersList = ordersService.findAll();
        mv.addObject("ordersList", ordersList);
        mv.setViewName("orders-list");
        return mv;
    }
}


而采用了分页代码则是如下：


//采用分页代码方法
   @RequestMapping("/findAll.do")
    public ModelAndView findAll(@RequestParam(name="page",required = true,defaultValue = "1")int page,@RequestParam(name="size",required = true,defaultValue = "4")int size ) {
        ModelAndView mv = new ModelAndView();
        List<Orders> ordersList = ordersService.findAll(page,size);
        //PageInfo就是一个分页Bean
        PageInfo pageInfo =new PageInfo(ordersList);
        mv.addObject("pageInfo", pageInfo);
        mv.setViewName("orders-list");
        return mv;
    }

可以发现多了两个参数分别是page和size


4.Service接口代码编写


public interface IOrdersService {
    List<Orders> findAll(int page,int size);
}

5.Service实现类代码编写


在执行sql之前（ServiceImpl），使用PageHelper分页，参数pageNum 是页码值 参数pageSize 代表是每页显示条数。在ServiceImpl中,使用PageHelper分页操作代码如下：


@Service
public class OrdersServiceImpl implements IOrdersService {
    @Autowired
    private IOrdersDao ordersDao;
    @Override
    public List<Orders> findAll(int page,int size) {
        //参数pageNum 是页码值   参数pageSize 代表是每页显示条数
        PageHelper.startPage(page, size);
        return ordersDao.findAll();
    }
}

特别注意：在编写PageHelper分页代码时的 PageHelper.startPage(page, size)这一句必须写在查询方法的上一句，中间不能添加任何代码，否则失效！


6.jsp页面未处理代码


没有更改的jsp页面代码,普通查询关键更改代码块，注意这里接收数据为 ordersList

<c:forEach items="${ordersList}" var="orders">
   <tr>
        <td><input name="ids" type="checkbox"></td>
        ...
        <td>...</td>
        </td>
    </tr>
</c:forEach>

这下面的代码则是未分页逻辑代码


<div class="box-tools pull-right">
                        <ul class="pagination">
                            <li>
                                <a href="#" aria-label="Previous">首页</a>
                            </li>
                            <li><a href="#">上一页</a></li>
                            <li><a href="#">1</a></li>
                            <li><a href="#">2</a></li>
                            <li><a href="#">3</a></li>
                            <li><a href="#">4</a></li>
                            <li><a href="#">5</a></li>
                            <li><a href="#">下一页</a></li>
                            <li>
                                <a href="#" aria-label="Next">尾页</a>
                            </li>
                        </ul>
                    </div>
                </div>


7.jsp页面处理后代码


更改后的jsp页面代码,分页查询的关键更改代码块，注意这里接收数据为 ordersList.list


<c:forEach items="${ordersList.list}" var="orders">
   <tr>
        <td><input name="ids" type="checkbox"></td>
        ...
        <td>...</td>
        </td>
    </tr>
</c:forEach>

这下面的代码则是分页逻辑代码

<div class="box-tools pull-right">
   <ul class="pagination">
        <li>
            <a href="${pageContext.request.contextPath}/orders/findAll.do?page=1&size=${pageInfo.pageSize}" aria-label="Previous">首页</a>
        </li>
        <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum-1}&size=${pageInfo.pageSize}">上一页</a></li>
        <c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
            <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageNum}&size=${pageInfo.pageSize}">${pageNum}</a></li>
        </c:forEach>
        <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum+1}&size=${pageInfo.pageSize}">下一页</a></li>
        <li>
            <a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pages}&size=${pageInfo.pageSize}" aria-label="Next">尾页</a>
        </li>
    </ul>
</div>
</div>


8.jsp页面处理前后代码分析



//PageInfo就是一个分页Bean
   PageInfo pageInfo =new PageInfo(ordersList);

为了能看到上面的pageInfo源代码，我就把代码贴在下面了


package com.github.pagehelper;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
public class PageInfo<T> implements Serializable {
    private static final long serialVersionUID = 1L;
    private int pageNum;
    private int pageSize;
    private int 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;
    private boolean isLastPage;
    private boolean hasPreviousPage;
    private boolean hasNextPage;
    private int navigatePages;
    private int[] navigatepageNums;
    private int navigateFirstPage;
    private int navigateLastPage;
    public PageInfo() {
        this.isFirstPage = false;
        this.isLastPage = false;
        this.hasPreviousPage = false;
        this.hasNextPage = false;
    }
    public PageInfo(List<T> list) {
        this(list, 8);
    }
    public PageInfo(List<T> list, int navigatePages) {
        this.isFirstPage = false;
        this.isLastPage = false;
        this.hasPreviousPage = false;
        this.hasNextPage = false;
        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();
            if (this.size == 0) {
                this.startRow = 0;
                this.endRow = 0;
            } else {
                this.startRow = page.getStartRow() + 1;
                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 = (long)list.size();
            this.startRow = 0;
            this.endRow = list.size() > 0 ? list.size() - 1 : 0;
        }
        if (list instanceof Collection) {
            this.navigatePages = navigatePages;
            this.calcNavigatepageNums();
            this.calcPage();
            this.judgePageBoudary();
        }
    }
    private void calcNavigatepageNums() {
        int i;
        if (this.pages <= this.navigatePages) {
            this.navigatepageNums = new int[this.pages];
            for(i = 0; i < this.pages; ++i) {
                this.navigatepageNums[i] = i + 1;
            }
        } else {
            this.navigatepageNums = new int[this.navigatePages];
            i = this.pageNum - this.navigatePages / 2;
            int endNum = this.pageNum + this.navigatePages / 2;
            int i;
            if (i < 1) {
                i = 1;
                for(i = 0; i < this.navigatePages; ++i) {
                    this.navigatepageNums[i] = i++;
                }
            } else if (endNum > this.pages) {
                endNum = this.pages;
                for(i = this.navigatePages - 1; i >= 0; --i) {
                    this.navigatepageNums[i] = endNum--;
                }
            } else {
                for(i = 0; i < this.navigatePages; ++i) {
                    this.navigatepageNums[i] = i++;
                }
            }
        }
    }
    private void calcPage() {
        if (this.navigatepageNums != null && this.navigatepageNums.length > 0) {
            this.navigateFirstPage = this.navigatepageNums[0];
            this.navigateLastPage = this.navigatepageNums[this.navigatepageNums.length - 1];
            if (this.pageNum > 1) {
                this.prePage = this.pageNum - 1;
            }
            if (this.pageNum < this.pages) {
                this.nextPage = this.pageNum + 1;
            }
        }
    }
    private void judgePageBoudary() {
        this.isFirstPage = this.pageNum == 1;
        this.isLastPage = this.pageNum == this.pages || this.pages == 0;
        this.hasPreviousPage = this.pageNum > 1;
        this.hasNextPage = this.pageNum < this.pages;
    }
    public int getPageNum() {
        return this.pageNum;
    }
    public void setPageNum(int pageNum) {
        this.pageNum = pageNum;
    }
    public int getPageSize() {
        return this.pageSize;
    }
    public void setPageSize(int pageSize) {
        this.pageSize = pageSize;
    }
    public int getSize() {
        return this.size;
    }
    public void setSize(int size) {
        this.size = size;
    }
    public int getStartRow() {
        return this.startRow;
    }
    public void setStartRow(int startRow) {
        this.startRow = startRow;
    }
    public int getEndRow() {
        return this.endRow;
    }
    public void setEndRow(int endRow) {
        this.endRow = endRow;
    }
    public long getTotal() {
        return this.total;
    }
    public void setTotal(long total) {
        this.total = total;
    }
    public int getPages() {
        return this.pages;
    }
    public void setPages(int pages) {
        this.pages = pages;
    }
    public List<T> getList() {
        return this.list;
    }
    public void setList(List<T> list) {
        this.list = list;
    }
    /** @deprecated */
    @Deprecated
    public int getFirstPage() {
        return this.navigateFirstPage;
    }
    /** @deprecated */
    @Deprecated
    public void setFirstPage(int firstPage) {
        this.navigateFirstPage = firstPage;
    }
    public int getPrePage() {
        return this.prePage;
    }
    public void setPrePage(int prePage) {
        this.prePage = prePage;
    }
    public int getNextPage() {
        return this.nextPage;
    }
    public void setNextPage(int nextPage) {
        this.nextPage = nextPage;
    }
    /** @deprecated */
    @Deprecated
    public int getLastPage() {
        return this.navigateLastPage;
    }
    /** @deprecated */
    @Deprecated
    public void setLastPage(int lastPage) {
        this.navigateLastPage = lastPage;
    }
    public boolean isIsFirstPage() {
        return this.isFirstPage;
    }
    public void setIsFirstPage(boolean isFirstPage) {
        this.isFirstPage = isFirstPage;
    }
    public boolean isIsLastPage() {
        return this.isLastPage;
    }
    public void setIsLastPage(boolean isLastPage) {
        this.isLastPage = isLastPage;
    }
    public boolean isHasPreviousPage() {
        return this.hasPreviousPage;
    }
    public void setHasPreviousPage(boolean hasPreviousPage) {
        this.hasPreviousPage = hasPreviousPage;
    }
    public boolean isHasNextPage() {
        return this.hasNextPage;
    }
    public void setHasNextPage(boolean hasNextPage) {
        this.hasNextPage = hasNextPage;
    }
    public int getNavigatePages() {
        return this.navigatePages;
    }
    public void setNavigatePages(int navigatePages) {
        this.navigatePages = navigatePages;
    }
    public int[] getNavigatepageNums() {
        return this.navigatepageNums;
    }
    public void setNavigatepageNums(int[] navigatepageNums) {
        this.navigatepageNums = navigatepageNums;
    }
    public int getNavigateFirstPage() {
        return this.navigateFirstPage;
    }
    public int getNavigateLastPage() {
        return this.navigateLastPage;
    }
    public void setNavigateFirstPage(int navigateFirstPage) {
        this.navigateFirstPage = navigateFirstPage;
    }
    public void setNavigateLastPage(int navigateLastPage) {
        this.navigateLastPage = navigateLastPage;
    }
    public String toString() {
        StringBuffer sb = new StringBuffer("PageInfo{");
        sb.append("pageNum=").append(this.pageNum);
        sb.append(", pageSize=").append(this.pageSize);
        sb.append(", size=").append(this.size);
        sb.append(", startRow=").append(this.startRow);
        sb.append(", endRow=").append(this.endRow);
        sb.append(", total=").append(this.total);
        sb.append(", pages=").append(this.pages);
        sb.append(", list=").append(this.list);
        sb.append(", prePage=").append(this.prePage);
        sb.append(", nextPage=").append(this.nextPage);
        sb.append(", isFirstPage=").append(this.isFirstPage);
        sb.append(", isLastPage=").append(this.isLastPage);
        sb.append(", hasPreviousPage=").append(this.hasPreviousPage);
        sb.append(", hasNextPage=").append(this.hasNextPage);
        sb.append(", navigatePages=").append(this.navigatePages);
        sb.append(", navigateFirstPage=").append(this.navigateFirstPage);
        sb.append(", navigateLastPage=").append(this.navigateLastPage);
        sb.append(", navigatepageNums=");
        if (this.navigatepageNums == null) {
            sb.append("null");
        } else {
            sb.append('[');
            for(int i = 0; i < this.navigatepageNums.length; ++i) {
                sb.append(i == 0 ? "" : ", ").append(this.navigatepageNums[i]);
            }
            sb.append(']');
        }
        sb.append('}');
        return sb.toString();
    }
}


文章标签：
Java
容器
SQL
Spring
Maven
mybatis
数据格式
XML
数据库连接
关键词：
MyBatis插件
MyBatis分页插件
MyBatis分页
MyBatis学习
MyBatis pagehelper
游客yno6xv7miabmw
目录
相关文章
2G冲浪词条
|
3月前
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目，接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件，创建`application.yml`进行相关配置，如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件，包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码，并在主类添加`@MapperScan`注解完成整合
2G冲浪词条
529 1
Spring boot 使用mybatis generator 自动生成代码插件
Quan_Chen
|
6月前
|
SQL Java 数据库连接
微服务——MyBatis分页
本文介绍了分页的多种实现方式，包括自带RowBounds分页、第三方插件PageHelper分页、SQL分页、数组分页及拦截器分页。其中，RowBounds是先查询全部结果再内存分页；PageHelper通过修改SQL动态添加分页关键字；SQL分页依赖数据库自身的分页功能如`LIMIT`；数组分页则是查询全量数据后用`subList`方法截取；拦截器分页则统一在SQL后添加分页语句。最后总结逻辑分页适合小数据量，但大数据量易内存溢出；物理分页虽小数据量效率较低，但更适合大数据场景，优先推荐使用。
Quan_Chen
85 0
游客kufrkwrbkmpsa
|
6月前
|
SQL Oracle 关系型数据库
【YashanDB知识库】Mybatis-Plus调用YashanDB怎么设置分页
【YashanDB知识库】Mybatis-Plus调用YashanDB怎么设置分页
游客kufrkwrbkmpsa
65 0
蓝易云
|
4月前
|
SQL Java 数据安全/隐私保护
发现问题：Mybatis-plus的分页总数为0，分页功能失效，以及多租户插件的使用。
总的来说，使用 Mybatis-plus 确实可以极大地方便我们的开发，但也需要我们理解其工作原理，掌握如何合适地使用各种插件。分页插件和多租户插件是其中典型，它们的运用可以让我们的代码更为简洁、高效，理解和掌握好它们的用法对我们的开发过程有着极其重要的意义。
蓝易云
469 15
游客f5gbkctaanby4
|
6月前
|
SQL Java 关系型数据库
MyBatis篇-分页
本文介绍了多种分页方式，包括自带rowbound内存分页、第三方插件pagehelper（通过修改SQL实现分页）、SQL分页（依赖limit或rownum等关键字）、数组分页（先查询全部数据再用subList分页）、拦截器分页（自定义拦截器为SQL添加分页语句）。最后总结了逻辑分页（内存分页，适合小数据量）和物理分页（直接在数据库层面分页，适合大数据量）的优缺点，强调物理分页优先于逻辑分页。
游客f5gbkctaanby4
339 0
大数据文摘
|
6月前
|
SQL Java 数据库连接
MyBatis 实现分页的机制
MyBatis 的分页机制主要依赖于 `RowBounds` 对象和分页插件。`RowBounds` 实现内存分页，适合小数据量场景，通过设定偏移量和限制条数对结果集进行筛选。而针对大数据量，则推荐使用分页插件（如 PageHelper），实现物理分页。插件通过拦截 SQL 执行，动态修改语句添加分页逻辑，支持多种数据库方言。配置插件后，无需手动调整查询方法即可完成分页操作，提升性能与灵活性。
大数据文摘
128 0
游客kufrkwrbkmpsa
|
6月前
|
Oracle 关系型数据库 Java
【YashanDB数据库】Mybatis-plus分页框架识别不到Yashandb
Mybatis-plus分页框架识别不到Yashandb
游客kufrkwrbkmpsa
113 0
Quan_Chen
|
6月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式：基于XML和注解的形式。重点讲解了注解方式，包括@Select、@Insert、@Update、@Delete等常用注解的使用方法，以及多参数时@Param注解的应用。同时，针对字段映射不一致的问题，提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点，灵活使用两者以提高开发效率，并附带课程源码供下载学习。
Quan_Chen
485 0
潜意识Java
|
8月前
|
前端开发 Java 数据库连接
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤，涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括： 1. **数据库准备**：创建数据库和表。 2. **查询数据库**：验证数据库是否可用。 3. **IDEA代码配置**：构建实体类并配置数据库连接。 4. **测试类编写**：编写并运行测试类以确保一切正常。
潜意识Java
303 2
java冯坚持
|
11月前
|
Java 数据库连接 Maven
mybatis使用一：springboot整合mybatis、mybatis generator，使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator，使用逆向工程来自动生成Java代码，包括实体类、Mapper文件和Example文件，以提高开发效率。
java冯坚持
410 2
mybatis使用一：springboot整合mybatis、mybatis generator，使用逆向工程生成java代码。