整合Spring Data JPA与Spring MVC: 分页和排序pageable
https://www.tianmaying.com/tutorial/spring-jpa-page-sort
Spring Data Jpa对于分页以及排序的查询也有着完美的支持,接下来,我们来学习如何通过Pageable
来对数据库进行分页查询。
添加maven依赖
首先我们需要引入Jpa,数据库直接使用hsqldb
内存数据库就可以了:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>1.2.5.RELEASE</version></parent><groupId>tmy</groupId><artifactId>demo.jpa.page</artifactId><version>0.0.1-SNAPSHOT</version><name>tmy-spring-jpa-page-demo</name><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId></dependency><dependency><groupId>org.hsqldb</groupId><artifactId>hsqldb</artifactId><scope>runtime</scope></dependency></dependencies>
</project>
继承PagingAndSortingRepository
Jpa的基本使用方法在如何使用Jpa访问关系型数据库已经介绍过,我们暂且跳过,这里我们直接来看接口BlogRepository
的定义:
public interface BlogRepository extends PagingAndSortingRepository<Blog, Integer> {Page<Blog> findByDeletedFalse(Pageable pageable);}
我们可以看到,BlogRepository
定义了这样一个方法:Page<Blog> findByDeletedFalse(Pageable pageable);
,我们主要关注它的参数以及返回值。
- Pageable 是Spring Data库中定义的一个接口,该接口是所有分页相关信息的一个抽象,通过该接口,我们可以得到和分页相关所有信息(例如
pageNumber
、pageSize
等),这样,Jpa就能够通过pageable参数来得到一个带分页信息的Sql语句。 - Page类也是Spring Data提供的一个接口,该接口表示一部分数据的集合以及其相关的下一部分数据、数据总数等相关信息,通过该接口,我们可以得到数据的总体信息(数据总数、总页数...)以及当前数据的信息(当前数据的集合、当前页数等)
Spring Data Jpa除了会通过命名规范帮助我们扩展Sql语句外,还会帮助我们处理类型为Pageable
的参数,将pageable参数转换成为sql'语句中的条件,同时,还会帮助我们处理类型为Page
的返回值,当发现返回值类型为Page
,Spring Data Jpa将会把数据的整体信息、当前数据的信息,分页的信息都放入到返回值中。这样,我们就能够方便的进行个性化的分页查询。
Pageable
只是一个抽象的接口,那么,家下来我们学习如何获得pageable对象。
通过参数生成Pageable对象
Pageable
定义了很多方法,但其核心的信息只有两个:一是分页的信息(page、size),二是排序的信息。Spring Data Jpa提供了PageRequest
的具体实现,Spring MVC提供了对Spring Data JPA非常好的支持,我们只提供分页以及排序信息即可:
@RequestMapping(value = "/params", method=RequestMethod.GET)
public Page<Blog> getEntryByParams(@RequestParam(value = "page", defaultValue = "0") Integer page,@RequestParam(value = "size", defaultValue = "15") Integer size) {Sort sort = new Sort(Direction.DESC, "id");Pageable pageable = new PageRequest(page, size, sort);return blogRepository.findAll(pageable);
}
在这里,我们通过参数获得分页的信息,并通过Sort
以及Direction
告诉pageable需要通过id逆序排列。Spring MVC的介绍情移步这里:Spring MVC快速入门。
这里可以看到,通过参数来得到一个pageable对象还是比较繁琐的,当查询的方法比较多的时候,会产生大量的重复代码。为了避免这种情况,Spring Data提供了直接生成pageable的方式。
直接获取Pageable对象
@RequestMapping(value = "", method=RequestMethod.GET)
public Page<Blog> getEntryByPageable(@PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC) Pageable pageable) {return blogRepository.findAll(pageable);
}
我们可以看到,我们只需要在方法的参数中直接定义一个pageable类型的参数,当Spring发现这个参数时,Spring会自动的根据request的参数来组装该pageable对象,Spring支持的request参数如下:
- page,第几页,从0开始,默认为第0页
- size,每一页的大小,默认为20
- sort,排序相关的信息,以
property,property(,ASC|DESC)
的方式组织,例如sort=firstname&sort=lastname,desc
表示在按firstname正序排列基础上按lastname倒序排列
这样,我们就可以通过url的参数来进行多样化、个性化的查询,而不需要为每一种情况来写不同的方法了。
通过url来定制pageable很方便,但唯一的缺点是不太美观,因此我们需要为pageable设置一个默认配置,这样很多情况下我们都能够通过一个简洁的url来获取信息了。
Spring提供了@PageableDefault
帮助我们个性化的设置pageable的默认配置。例如@PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC)
表示默认情况下我们按照id倒序排列,每一页的大小为15。
返回结果
最后,让我们进入程序的根目录,运行命令mvn spring-boot:run
将web应用启动起来,启动完成后,访问http://localhost:8080/
页面,我们将看到如下结果:
{"content":[{"id":123,"title":"blog122","content":"this is blog content"},{"id":122,"title":"blog121","content":"this is blog content"},{"id":121,"title":"blog120","content":"this is blog content"},{"id":120,"title":"blog119","content":"this is blog content"},{"id":119,"title":"blog118","content":"this is blog content"},{"id":118,"title":"blog117","content":"this is blog content"},{"id":117,"title":"blog116","content":"this is blog content"},{"id":116,"title":"blog115","content":"this is blog content"},{"id":115,"title":"blog114","content":"this is blog content"},{"id":114,"title":"blog113","content":"this is blog content"},{"id":113,"title":"blog112","content":"this is blog content"},{"id":112,"title":"blog111","content":"this is blog content"},{"id":111,"title":"blog110","content":"this is blog content"},{"id":110,"title":"blog109","content":"this is blog content"},{"id":109,"title":"blog108","content":"this is blog content"}],"last":false,"totalPages":9,"totalElements":123,"size":15,"number":0,"first":true,"sort":[{"direction":"DESC","property":"id","ignoreCase":false,"nullHandling":"NATIVE","ascending":false}],"numberOfElements":15
}
通过查询结果,我们可以知道:
- 以id倒序排列的10条数据
- 当前页不是最后一页,后面还有数据
- 总共有9页
- 每页大小为15
- 当前页为第0页
- 当前页是第一页
- 当前页是以id倒序排列的
- 当前页一共有15条数据
怎么样,信息是不是很丰富,代码是不是很简单,快点来尝试一下Jpa的分页查询吧。
之前我们学习了如何使用Jpa访问关系型数据库。比较完整Spring MVC和JPA教程请见Spring Data JPA实战入门,Spring MVC实战入门。
通过Jpa大大简化了我们对数据库的开发工作。但是,之前的例子中我们只提到了最简单的CRUD(增删改查)操作。实际上,Spring Data Jpa对于分页以及排序的查询也有着完美的支持,接下来,我们来学习如何通过Pageable
来对数据库进行分页查询。
添加maven依赖
首先我们需要引入Jpa,数据库直接使用hsqldb
内存数据库就可以了:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>1.2.5.RELEASE</version></parent><groupId>tmy</groupId><artifactId>demo.jpa.page</artifactId><version>0.0.1-SNAPSHOT</version><name>tmy-spring-jpa-page-demo</name><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId></dependency><dependency><groupId>org.hsqldb</groupId><artifactId>hsqldb</artifactId><scope>runtime</scope></dependency></dependencies>
</project>
继承PagingAndSortingRepository
Jpa的基本使用方法在如何使用Jpa访问关系型数据库已经介绍过,我们暂且跳过,这里我们直接来看接口BlogRepository
的定义:
public interface BlogRepository extends PagingAndSortingRepository<Blog, Integer> {Page<Blog> findByDeletedFalse(Pageable pageable);}
我们可以看到,BlogRepository
定义了这样一个方法:Page<Blog> findByDeletedFalse(Pageable pageable);
,我们主要关注它的参数以及返回值。
- Pageable 是Spring Data库中定义的一个接口,该接口是所有分页相关信息的一个抽象,通过该接口,我们可以得到和分页相关所有信息(例如
pageNumber
、pageSize
等),这样,Jpa就能够通过pageable参数来得到一个带分页信息的Sql语句。 - Page类也是Spring Data提供的一个接口,该接口表示一部分数据的集合以及其相关的下一部分数据、数据总数等相关信息,通过该接口,我们可以得到数据的总体信息(数据总数、总页数...)以及当前数据的信息(当前数据的集合、当前页数等)
Spring Data Jpa除了会通过命名规范帮助我们扩展Sql语句外,还会帮助我们处理类型为Pageable
的参数,将pageable参数转换成为sql'语句中的条件,同时,还会帮助我们处理类型为Page
的返回值,当发现返回值类型为Page
,Spring Data Jpa将会把数据的整体信息、当前数据的信息,分页的信息都放入到返回值中。这样,我们就能够方便的进行个性化的分页查询。
Pageable
只是一个抽象的接口,那么,家下来我们学习如何获得pageable对象。
通过参数生成Pageable对象
Pageable
定义了很多方法,但其核心的信息只有两个:一是分页的信息(page、size),二是排序的信息。Spring Data Jpa提供了PageRequest
的具体实现,Spring MVC提供了对Spring Data JPA非常好的支持,我们只提供分页以及排序信息即可:
@RequestMapping(value = "/params", method=RequestMethod.GET)
public Page<Blog> getEntryByParams(@RequestParam(value = "page", defaultValue = "0") Integer page,@RequestParam(value = "size", defaultValue = "15") Integer size) {Sort sort = new Sort(Direction.DESC, "id");Pageable pageable = new PageRequest(page, size, sort);return blogRepository.findAll(pageable);
}
在这里,我们通过参数获得分页的信息,并通过Sort
以及Direction
告诉pageable需要通过id逆序排列。Spring MVC的介绍情移步这里:Spring MVC快速入门。
这里可以看到,通过参数来得到一个pageable对象还是比较繁琐的,当查询的方法比较多的时候,会产生大量的重复代码。为了避免这种情况,Spring Data提供了直接生成pageable的方式。
直接获取Pageable对象
@RequestMapping(value = "", method=RequestMethod.GET)
public Page<Blog> getEntryByPageable(@PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC) Pageable pageable) {return blogRepository.findAll(pageable);
}
我们可以看到,我们只需要在方法的参数中直接定义一个pageable类型的参数,当Spring发现这个参数时,Spring会自动的根据request的参数来组装该pageable对象,Spring支持的request参数如下:
- page,第几页,从0开始,默认为第0页
- size,每一页的大小,默认为20
- sort,排序相关的信息,以
property,property(,ASC|DESC)
的方式组织,例如sort=firstname&sort=lastname,desc
表示在按firstname正序排列基础上按lastname倒序排列
这样,我们就可以通过url的参数来进行多样化、个性化的查询,而不需要为每一种情况来写不同的方法了。
通过url来定制pageable很方便,但唯一的缺点是不太美观,因此我们需要为pageable设置一个默认配置,这样很多情况下我们都能够通过一个简洁的url来获取信息了。
Spring提供了@PageableDefault
帮助我们个性化的设置pageable的默认配置。例如@PageableDefault(value = 15, sort = { "id" }, direction = Sort.Direction.DESC)
表示默认情况下我们按照id倒序排列,每一页的大小为15。
返回结果
最后,让我们进入程序的根目录,运行命令mvn spring-boot:run
将web应用启动起来,启动完成后,访问http://localhost:8080/
页面,我们将看到如下结果:
{"content":[{"id":123,"title":"blog122","content":"this is blog content"},{"id":122,"title":"blog121","content":"this is blog content"},{"id":121,"title":"blog120","content":"this is blog content"},{"id":120,"title":"blog119","content":"this is blog content"},{"id":119,"title":"blog118","content":"this is blog content"},{"id":118,"title":"blog117","content":"this is blog content"},{"id":117,"title":"blog116","content":"this is blog content"},{"id":116,"title":"blog115","content":"this is blog content"},{"id":115,"title":"blog114","content":"this is blog content"},{"id":114,"title":"blog113","content":"this is blog content"},{"id":113,"title":"blog112","content":"this is blog content"},{"id":112,"title":"blog111","content":"this is blog content"},{"id":111,"title":"blog110","content":"this is blog content"},{"id":110,"title":"blog109","content":"this is blog content"},{"id":109,"title":"blog108","content":"this is blog content"}],"last":false,"totalPages":9,"totalElements":123,"size":15,"number":0,"first":true,"sort":[{"direction":"DESC","property":"id","ignoreCase":false,"nullHandling":"NATIVE","ascending":false}],"numberOfElements":15
}
通过查询结果,我们可以知道:
- 以id倒序排列的10条数据
- 当前页不是最后一页,后面还有数据
- 总共有9页
- 每页大小为15
- 当前页为第0页
- 当前页是第一页
- 当前页是以id倒序排列的
- 当前页一共有15条数据
怎么样,信息是不是很丰富,代码是不是很简单,快点来尝试一下Jpa的分页查询吧。
转载于:https://www.cnblogs.com/Andrew520/p/9413160.html
整合Spring Data JPA与Spring MVC: 分页和排序pageable相关推荐
- Spring Data Jpa多表联合分页查询
参考:https://blog.csdn.net/qq_36144258/article/details/80298354 近期一个项目用到Spring Data Jpa,Jpa用来做单表查询非常的简 ...
- 【spring data jpa】spring data jpa 中的update 更新字段,如果原字段值为null不处理,不为null则在原来的值上加一段字符串...
示例代码: /*** 如果barCode字段值为null则不处理* 如果barCode字段值不为null则在原本值的前面拼接 del:* @param dealer* @return*/@Modify ...
- Spring Boot 应用系列 1 -- Spring Boot 2 整合Spring Data JPA和Druid,双数据源
最近Team开始尝试使用Spring Boot + Spring Data JPA作为数据层的解决方案,在网上逛了几圈之后发现大家并不待见JPA,理由是(1)MyBatis简单直观够用,(2)以Hib ...
- Springboot整合Spring Data JPA
1 Spring Data JPA 1.Spring Data JPA的概念 在介绍Spring Data JPA的时候,我们首先认识下Hibernate.Hibernate是数据访问解决技术的绝对霸 ...
- 第九章SpringBoot整合Spring Data JPA
目录 1 概述 2 Spring Data JPA整合 2.1 pom文件 2.2 配置文件 2.3 实体类 2.4 Dao接口 2.5 启动类 2.6 编写测试类 3 Spring Data JPA ...
- Spring Boot整合Spring Data JPA操作数据
一. Sping Data JPA 简介 Spring Data JPA 是 Spring 基于 ORM 框架.JPA 规范的基础上封装的一套 JPA 应用框架,底层使用了 Hibernate 的 J ...
- 使用Spring Data JPA进行分页和排序
通过代码示例学习使用Spring Data JPA进行分页和排序 . 了解如何使用Springs PagingAndSortingRepository接口获取分页和排序结果. 1概述 在处理大量数据时 ...
- Spring Boot 整合 Spring Data JPA
JPA 是一个基于 O/R 映射的 Java 持久化规范,其定义了一系列对象持久化的标准,目前实现这一规范的产品有 Hibernate.EclipseLink.OpenJPA.TopLink 等,这也 ...
- Spring Boot 2.x基础教程:使用Spring Data JPA访问MySQL
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 作者 | 翟永超 来源 | http://blog.di ...
- SpringBoot学习笔记:Spring Data Jpa的使用
更多请关注公众号 Spring Data Jpa 简介 JPA JPA(Java Persistence API)意即Java持久化API,是Sun官方在JDK5.0后提出的Java持久化规范(JSR ...
最新文章
- 使用Relay部署编译ONNX模型
- makefille的使用
- mac系统下,解决git clone速度慢导至失败的问题
- thinkphp mysql desc table_Thinkphp 连接数据库、查询、添加
- Notepad++免费开源文本编辑器
- 【安全漏洞】CVE-2020-26567 DSR-250N 远程拒绝服务漏洞分析
- 预言机、预言机网络、预测市场
- 基于读取车载RFID标签自动开关车库门c#算法实现
- C++(13)--函数的进阶:内联、传递引用、参数默认值、重载、函数模板
- 前面是个主席台的飞鸽传书
- [计算机网络] - IP基础知识
- Windows编译libcaffe时报cudnn.hpp(114): too few arguments in function call错误
- git fetch pull
- jeesite 去掉 /a
- MP3标题重命名以及文本去掉模板尾巴
- R语言利用openxlsx包输出EXCEL报告
- 第三方支付API支付宝支付申请流程 支付宝新老版本
- DNS-域名系统 【应用层】【计算机网络】
- 【Python】天气预报(发送网易邮件,微信公众测试号,企业微信),周末用时一天,两万字代码,纯肝货(完整项目)一一CSDN21天学习挑战赛
- 这10个学习资源网站,一年能帮你省下几十万的学费
热门文章
- 【BZOJ】1002: [FJOI2007]轮状病毒 递推+高精度
- UVA 10125 - Sumsets
- [笔记]读.Net 2.0面向对像揭密--条件编译
- ACL'22 | 使用对比学习增强多标签文本分类中的k近邻机制
- 【高校联合主办| SCI、EI 快检索】物联网,机器学习,网络安全,通信技术,算法,微芯片等计算机多主题征稿!...
- 【linux】图解Linux最常用命令!秒懂!
- 实习、竞赛、论文?关于计算机读研的一些小建议!
- 如何防止softmax函数上溢出(overflow)和下溢出(underflow)
- 【每日算法Day 101】字节跳动 AI Lab 精选面试编程题
- 数据结构与算法python—4.栈及python实现与leetcode总结