SpringBoot2.x中你不知道的PageHelper是什么

本篇文章为大家展示了Spring Boot 2.x中你不知道的PageHelper是什么,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。

创新互联公司2013年成立,是专业互联网技术服务公司,拥有项目网站建设、网站制作网站策划,项目实施与项目整合能力。我们以让每一个梦想脱颖而出为使命,1280元西宁做网站,已为上家服务,为西宁各地企业和个人服务,联系电话:18982081108

PageHelper

说起PageHelper,使用过Mybatis的朋友可能不是很陌生,作为一款国人开发的分页插件,它基本上满足了我们的日常需求。

花了一个晚上的时间,研究了一下合理的怎么玩这个。

快速入门

如果你想在一个Spring Boot项目中快速进行一次分页操作,只需要两步即可:

导入Maven

这里我导入的是官方最新的:


    org.mybatis.spring.boot
    mybatis-spring-boot-starter
    2.0.0


    tk.mybatis
    mapper-spring-boot-starter
    2.1.5


    com.github.pagehelper
    pagehelper-spring-boot-starter
    1.2.10
使用
 // 只有紧跟在PageHelper.startPage方法后的第一个Mybatis的查询(Select)方法会被分页!!!!
 PageHelper.startPage(1, 10);
 return PageInfo.of(userService.findAll());

没错,只需要两句代码即可达到我们想要的分页效果

进阶玩法

如果,你仅仅是想简单的使用分页功能,那么这篇文章到这里对你而言来说就已经结束了,但是作为一个程序员,你会仅仅满足于初级的玩儿法吗?不!你不会!所以,接着往下看~

从文档中,我们可以看出,作者给我们提供了很多的参数供我们配置:

helperDialectoffsetAsPageNumrowBoundsWithCountpageSizeZeroreasonableparamssupportMethodsArgumentsautoRuntimeDialectcloseConn等等,我们可以通过配置这些属性来获得更为强大的效果~

这里需要说明一点,网上的教程大部分是让我们在xml或者代码中配置,其实如果你使用的是springboot,干嘛要舍近求远呢,我们可以直接在Spring boot 的配置文件application.yml中进行配置:

pagehelper:
  # dialect: ①
  # 分页插件会自动检测当前的数据库链接,自动选择合适的分页方式(可以不设置)
  helper-dialect: MySQL 
  # 上面数据库设置后,下面的设置为true不会改变上面的结果(默认为true)
  auto-dialect: true 
  page-size-zero: false # ②
  reasonable: true # ③
  # 默认值为 false,该参数对使用 RowBounds 作为分页参数时有效。(一般用不着)
  offset-as-page-num: false 
  # 默认值为 false,RowBounds是否进行count查询(一般用不着)
  row-bounds-with-count: false 
  #params: ④
  #support-methods-arguments: 和params配合使用,具体可以看下面的讲解
  # 默认值为 false。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页
  auto-runtime-dialect: false # ⑤
  # 与auto-runtime-dialect配合使用
  close-conn: true 
  # 用于控制默认不带 count 查询的方法中,是否执行 count 查询,这里设置为true后,total会为-1
  default-count: false 
  #dialect-alias: ⑥

①:默认情况下会使用 PageHelper 方式进行分页,如果想要实现自己的分页逻辑,可以实现 Dialect(com.github.pagehelper.Dialect) 接口,然后配置该属性为实现类的全限定名称。(这里不推荐这样玩,毕竟你用了别人的插件,干嘛还要多此一举呢?)

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

这里需要说一点,虽然返回了全部的结果,但是还是执行了count的动作,开发者曾在issue中表示后面的版本会修复这个问题

Spring Boot 2.x中你不知道的PageHelper是什么

经我的测试,目前是还没有解决的????

③:合法性,即纠错机制,配置reasonabletrue,这时如果 pageNum <= 0 会查询第一页,如果 pageNum > pages 会查询最后一页。

④:为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值, 默认值为
pageNum=pageNum;
pageSize=pageSize;
count=countSql;
reasonable=reasonable;
pageSizeZero=pageSizeZero
support-methods-arguments支持通过 Mapper 接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页。

来个小????:

    @GetMapping("/page1")
    public PageInfo findPage(HttpServletRequest request) {
        // 直接将请求中含有的参数传给
        PageHelper.startPage(request);
        return PageInfo.of(userService.findAll());
    }
     /**
     * 查询所有信息
     * @return 人员列表
     */
    @Select("SELECT * FROM user")
    @Results({
            @Result(property = "userName",  column = "user_name"),
            @Result(property = "password", column = "password")
    })
    List findAll();
    /*****************************************************************/

    //这个方法和上面的区别是直接将含有条件的请求传给了Mapper接口
     @GetMapping("/page2")
    public PageInfo findPage2(HttpServletRequest request) {
        return PageInfo.of(userService.findPage(request));
    }

    //Mapper接口遇上一个的区别就是多了一个参数,SQL完全一致
    @Select("SELECT * FROM user")
    @Results({
            @Result(property = "userName",  column = "user_name"),
            @Result(property = "password", column = "password")
    })
    List findPage(HttpServletRequest request);

⑤:默认值为false。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页,

closeConn:默认值为 true。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false 后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。

⑥:dialect-alias 参数,允许配置自定义实现的 别名,可以用于根据JDBCURL自动获取对应实现,允许通过此种方式覆盖已有的实现,配置示例如(多个配置用分号;隔开):

pagehelper.dialect-alias=oracle=com.github.pagehelper.dialect.helper.OracleDialect
几种不同的玩法

(小声BB一句)Lambda是真的好看啊!

     //1. offsetPage
        PageHelper.offsetPage(1, 10);
        return PageInfo.of(userService.findAll());
        //2. Lambda
        return PageHelper.startPage(1, 10).doSelectPageInfo(() -> userService.findAll());

上述内容就是Spring Boot 2.x中你不知道的PageHelper是什么,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注创新互联行业资讯频道。


文章名称:SpringBoot2.x中你不知道的PageHelper是什么
转载注明:http://scyanting.com/article/gidiej.html