初识Spring Boot(四)---Mybatis集成分页插件pageHelper

第一步,添加pageHelper依赖

<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>1.2.5</version>
</dependency>
<dependency>
   <groupId>org.apache.commons</groupId>
   <artifactId>commons-lang3</artifactId>
   <version>3.7</version>
</dependency>

第二步,设置配置文件

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver


pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.params=count=countSql
pagehelper.page-size-zero=true

Dialect:4.0.0以后版本可以不设置该参数,指明使用的是什么数据库

offsetAsPageNum:该参数默认为false,设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 和startPage中的pageNum效果一样

rowBoundsWithCount:该参数默认为false,设置为true时,使用RowBounds分页会进行count查询

pageSizeZero:设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是Page类型)

Reasonable: 3.3.0版本可用 - 分页参数合理化,默认false禁用,启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页 ,禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据

supportMethodsArguments:支持通过Mapper接口参数来传递分页参数

returnPageInfo:always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page

Params:3.5.0版本可用 - 为了支持startPage(Object params)方法,增加了一个params参数来配置参数映射,用于从Map或ServletRequest中取值,可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值,不理解该含义的前提下,不要随便复制该配置

第三步,添加实体层

@Data
public class User {
    private Integer id;
    private String name;
    private Integer age;

}

第四步,添加mapper 层

public interface UserMapper {

    @Select("SELECT * FROM USERS ")
    List<User> userList();
}

第五步,添加Service层

@Service
public class UserPageHelperService {

    @Autowired
    private UserMapper userMapper;

    public PageInfo<User> userList(int page,int pageSize){

        //mysql 分页查询 limit oraclet 伪列 sqlserver top
        //PageHelper 帮我们改写sql语句 生成分页语句
        PageHelper.startPage(page,pageSize);
        List<User> users = userMapper.userList();
        PageInfo<User> pageInfoUserList=new PageInfo<User>(users);

        return pageInfoUserList;

    }
}

PageHelper 原理,根据配置文件中使用的数据库类型帮我们改写sql语句 生成分页语句

支持的数据库有:
oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012
在4.0.0版本以后,dialect参数可以不配置,系统能自动识别这里提到的所有数据库。
对于不支持的数据库,可以实现com.github.pagehelper.parser.Parser接口,然后配置到dialect参数中(4.0.2版本增加)。

第六步,添加控制器,测试分页效果

@RestController
public class UserListController {

    @Autowired
    private UserPageHelperService userPageHelperService;

    @RequestMapping("/getuserlist")
    public PageInfo<User> getUserList(int page,int pageSize){

        return userPageHelperService.userList(page,pageSize);
    }

}

运行项目,浏览器访问:
http://127.0.0.1:8080/getuserlist?page=1&pageSize=2
分页效果

{
    "total": 10,
    "list": [{
        "id": 1,
        "name": "xxxx",
        "age": 11
    }, {
        "id": 2,
        "name": "xxxx",
        "age": 11
    }],
    "pageNum": 1,
    "pageSize": 2,
    "size": 2,
    "startRow": 1,
    "endRow": 2,
    "pages": 5,
    "prePage": 0,
    "nextPage": 2,
    "isFirstPage": true,
    "isLastPage": false,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "navigatePages": 8,
    "navigatepageNums": [1, 2, 3, 4, 5],
    "navigateFirstPage": 1,
    "navigateLastPage": 5,
    "firstPage": 1,
    "lastPage": 5
}

PageInfo 中的成员变量说明

·   //当前页 
·    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 firstPage;  
·      //前一页  
·      private int prePage;  
·    
·      //是否为第一页  
·      private boolean isFirstPage = false;  
·      //是否为最后一页  
·      private boolean isLastPage = false;  
·      //是否有前一页  
·      private boolean hasPreviousPage = false;  
·      //是否有下一页  
·      private boolean hasNextPage = false;  
·      //导航页码数  
·      private int navigatePages;  
·      //所有导航页号  
·      private int[] navigatepageNums;  
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容