PageHelper使用

最新推荐文章于 2023-08-25 18:49:08 发布

BigDevil_

最新推荐文章于 2023-08-25 18:49:08 发布

阅读量446

点赞数

分类专栏： Java学习

本文链接：https://blog.csdn.net/BigDevil_/article/details/103249607

版权

Java学习专栏收录该内容

31 篇文章 0 订阅

订阅专栏

文章目录

PageHelper简介

MyBatis插件。本质是MyBatis的拦截器，在查询前修改查询的sql语句。

1、导入依赖

<pagehelper.version>4.1.3</pagehelper.version>
<jsqlparser.version>0.9.4</jsqlparser.version>
			<dependency>
				<groupId>com.github.miemiedev</groupId>
				<artifactId>mybatis-paginator</artifactId>
				<version>${mybatis.paginator.version}</version>
			</dependency>
			<dependency>
				<groupId>com.github.pagehelper</groupId>
				<artifactId>pagehelper</artifactId>
				<version>${pagehelper.version}</version>
			</dependency>

2、在mybatis配置文件中添加配置

<!-- 配置分页插件 -->
	<plugins>
		<plugin interceptor="com.github.pagehelper.PageHelper">
			<!-- 设置数据库类型 Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库-->        
        	<property name="dialect" value="mysql"/>
		</plugin>
	</plugins>

3、分页

注意：要在查询语句的上一句调用分页。

	public BootStrapResult<TbDorm> getAllDorm(int pageNum, int pageSize) {
		//startPage之后紧跟数据库查询语句
		TbDormExample example = new TbDormExample();
		PageHelper.startPage(pageNum, pageSize);
		List<TbDorm> list = dormMapper.selectByExample(example);
		PageInfo<TbDorm> info = new PageInfo<TbDorm>(list);
		//BootStrapResult封装的类，一个是总条数，一个是数据（rows），返回给前台
		BootStrapResult<TbDorm> result = new BootStrapResult<TbDorm>();
		result.setRows(info.getList());
		result.setTotal(info.getTotal());
		return result;
	}

4、问题

There is no getter for property named ‘__frch_criterion_1’ in 'class com.xxxx.dao.domain.XxxExample’

之前pagehelper版本 3.4.2
可以实现分页，但是加上条件查询就会报错，如果不用pageheler条件查询，没有错，所以这两部分单独来看都没有错，有资料说是因为有的静态分页工具不支持，可是pagehelper是动态的，就尝试一下换一个pagehelper的高版本。
更改到 4.2.3后（要先clean，在重新安装maven），就可以实现了。
有的帖子说要提高mybatis版本，没有试。先存下来

		<dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.2</version>
        </dependency>
         <dependency>  
            <groupId>org.mybatis</groupId>  
            <artifactId>mybatis-spring</artifactId>  
            <version> 1.3.1</version>  
        </dependency>

修改pom文件后，没有clean，进入源码看到的是之前的版本，会报

java.lang.NoSuchMethodError: com.github.pagehelper.PageHelper.startPage(II)L

5、使用

分页调用方式（排序字段非必须，是重载方法）

RowBounds方式
startPage(pageNum,pageSize,orderBy)；如：PageHelper.startPage(1, 10,user_id desc);
offsetPage(pageNum,pageSize,orderBy)

//第一种，RowBounds方式的调用
List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(0, 10));
 
//第二种，Mapper接口方式的调用，推荐这种使用方式。
PageHelper.startPage(1, 10);
List<Country> list = countryMapper.selectIf(1);
 
//第三种，Mapper接口方式的调用，推荐这种使用方式。
PageHelper.offsetPage(1, 10);
List<Country> list = countryMapper.selectIf(1);

https://blog.csdn.net/qq_38375620/article/details/79467545

获取PageInfo

这是两个PageInfo的构造方法，具体看源码。

PageInfo<T> info = new PageInfo<T>(查询到的list); ，获取分页信息
PageInfo<T> info = new PageInfo<T>(查询到的list , int navigateNum);，navigateNum是有效页数，即显示几个页码。
比如百度这个有效页数就是：10

PageInfo源码:


package com.github.pagehelper;

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

/**
 * 对Page<E>结果进行包装
 * <p/>
 * 新增分页的多项属性，主要参考:http://bbs.csdn.net/topics/360010907
 *
 * @author liuzh/abel533/isea533
 * @version 3.3.0
 * @since 3.2.2
 * 项目地址 : http://git.oschina.net/free/Mybatis_PageHelper
 */
@SuppressWarnings({"rawtypes", "unchecked"})
public class PageInfo<T> implements Serializable {
    private static final long serialVersionUID = 1L;
    //当前页
    private int pageNum;
    //每页的数量
    private int pageSize;
    //当前页的数量
    private int size;
    //排序
    private String orderBy;

    //由于startRow和endRow不常用，这里说个具体的用法
    //可以在页面中"显示startRow到endRow 共size条数据"

    //当前页面第一个元素在数据库中的行号
    private int startRow;
    //当前页面最后一个元素在数据库中的行号
    private int endRow;
    //总记录数
    private long total;
    //总页数
    private int pages;
    //结果集
    private List<T> list;

    //第一页
    private int firstPage;
    //前一页
    private int prePage;
    //下一页
    private int nextPage;
    //最后一页
    private int lastPage;

    //是否为第一页
    private boolean isFirstPage = false;
    //是否为最后一页
    private boolean isLastPage = false;
    //是否有前一页
    private boolean hasPreviousPage = false;
    //是否有下一页
    private boolean hasNextPage = false;
    //导航页码数
    private int navigatePages;
    //所有导航页号
    private int[] navigatepageNums;

    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.orderBy = page.getOrderBy();

            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 = 1;
            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();
        }
    }

    /**
     * 计算导航页
     */
    private void calcNavigatepageNums() {
        //当总页数小于或等于导航页码数时
        if (pages <= navigatePages) {
            navigatepageNums = new int[pages];
            for (int i = 0; i < pages; i++) {
                navigatepageNums[i] = i + 1;
            }
        } else { //当总页数大于导航页码数时
            navigatepageNums = new int[navigatePages];
            int startNum = pageNum - navigatePages / 2;
            int endNum = pageNum + navigatePages / 2;

            if (startNum < 1) {
                startNum = 1;
                //(最前navigatePages页
                for (int i = 0; i < navigatePages; i++) {
                    navigatepageNums[i] = startNum++;
                }
            } else if (endNum > pages) {
                endNum = pages;
                //最后navigatePages页
                for (int i = navigatePages - 1; i >= 0; i--) {
                    navigatepageNums[i] = endNum--;
                }
            } else {
                //所有中间页
                for (int i = 0; i < navigatePages; i++) {
                    navigatepageNums[i] = startNum++;
                }
            }
        }
    }

    /**
     * 计算前后页，第一页，最后一页
     */
    private void calcPage() {
        if (navigatepageNums != null && navigatepageNums.length > 0) {
            firstPage = navigatepageNums[0];
            lastPage = navigatepageNums[navigatepageNums.length - 1];
            if (pageNum > 1) {
                prePage = pageNum - 1;
            }
            if (pageNum < pages) {
                nextPage = pageNum + 1;
            }
        }
    }

    /**
     * 判定页面边界
     */
    private void judgePageBoudary() {
        isFirstPage = pageNum == 1;
        isLastPage = pageNum == pages;
        hasPreviousPage = pageNum > 1;
        hasNextPage = pageNum < pages;
    }

    //getter setter 方法省略.......

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("PageInfo{");
        sb.append("pageNum=").append(pageNum);
        sb.append(", pageSize=").append(pageSize);
        sb.append(", size=").append(size);
        sb.append(", startRow=").append(startRow);
        sb.append(", endRow=").append(endRow);
        sb.append(", total=").append(total);
        sb.append(", pages=").append(pages);
        sb.append(", list=").append(list);
        sb.append(", firstPage=").append(firstPage);
        sb.append(", prePage=").append(prePage);
        sb.append(", nextPage=").append(nextPage);
        sb.append(", lastPage=").append(lastPage);
        sb.append(", isFirstPage=").append(isFirstPage);
        sb.append(", isLastPage=").append(isLastPage);
        sb.append(", hasPreviousPage=").append(hasPreviousPage);
        sb.append(", hasNextPage=").append(hasNextPage);
        sb.append(", navigatePages=").append(navigatePages);
        sb.append(", navigatepageNums=");
        if (navigatepageNums == null) sb.append("null");
        else {
            sb.append('[');
            for (int i = 0; i < navigatepageNums.length; ++i)
                sb.append(i == 0 ? "" : ", ").append(navigatepageNums[i]);
            sb.append(']');
        }
        sb.append('}');
        return sb.toString();
    }
}

6、PageHelper使用案例（毕设里用的）：

封装一个PageBean对象，存放pageSize，pageNum，和orderby。因为每次分页都要传这四个参数，索性封装起来。

package com.cdps.common.pojo;

public class PageBean {
	private Integer pageNumber; // 当前页码
	private Integer pageSize; // 页面大小
	private String sort;// 排序字段
	private String order;// 排序方法
	
	/*
	* 这个方法用来获取OrderBy，可直接在startPage时使用。
	*/
	public String getOrderBy() {
		return getSort()+" "+getOrder();
	}
	
	// 其他的getter setter省略
	public String getSort() {
		// 驼峰名转下划线
		return sort.replaceAll("[A-Z]", "_$0").toLowerCase();
	}
	public void setSort(String sort) {
		this.sort = sort;
	}
	
	
	@Override
	public String toString() {
		return "PageBean [pageNumber=" + pageNumber + ", pageSize=" + pageSize + ", sort=" + sort + ", order=" + order
				+ "]";
	}
	
	
}

BSTableResult是封装的一个用于Bootstrap-Table接收的参数类型。

public class BSTableResult<T> {
    private Long total;//一共有多少条数据
    private List<T> rows; //查询结果
	...
}

service层：

@Override
	public BSTableResult<TbStudent> getStudentsByQuery(TbStudent student,PageBean pageBean) {
		// 1. 获取查询条件
		String name = student.getStuName();
		String deptCode = student.getStuDeptCode();
		String majorCode = student.getStuMajorCode();
		String classCode = student.getStuClassCode();
		String preState = student.getPreState();
		
		try {
			// 解决获取的参数在sql中 乱码Parameters: %å¼ %(String), 06(String)
			// 在tomcat插件中配置编码，解决get乱码
			name = new String(name.getBytes("iso8859-1"), "utf-8").intern();
		} catch (UnsupportedEncodingException e) {
			e.printStackTrace();
			return null;
		}
		
		// 分页参数 在PageBean中准备好了
		// 2.查询条件设置
		TbStudentExample example = new TbStudentExample();
		Criteria criteria = example.createCriteria();
		criteria.andStuIsDelEqualTo(0);
		//省略...
		// 3.分页查询
		PageHelper.startPage(pageBean.getPageNumber(), pageBean.getPageSize(), pageBean.getOrderBy());
		List<TbStudent> studentList = this.studentMapper.selectAllByExample(example);
		System.out.println("studentservie-分页：查询学生结果："+studentList);
		PageInfo<TbStudent> info = new PageInfo<>(studentList);
		System.out.println("studentservie-分页：查询学生分页PageInfo："+info);
		// 4.封装返回结果
		BSTableResult<TbStudent> result = new BSTableResult<TbStudent>();
		result.setRows(info.getList());
		result.setTotal(info.getTotal());
			
		return result;
	}

BigDevil_

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
PageHelper使用

There is no getter for property named ‘__frch_criterion_1’ in 'class com.xxxx.dao.domain.XxxExample’之前pagehelper版本 3.4.2可以实现分页，但是加上条件查询就会报错，如果不用pageheler条件查询，没有错，所以这两部分单独来看都没有错，有资料说是因为有的静态分页工具不支持，可是...
复制链接

扫一扫