两行代码玩转Spring Data排序和分页

简介: 两行代码玩转Spring Data排序和分页

一:唠嗑


在实际项目中对Spring Data的各种使用相当多,简单的增删改查Spring Data提供了现成的方法,一些复杂的,我们可以在接口方法写And,Not等关键字来搞定,想写原生SQL,CQL(Neo4j),Query DSL (Elasticsearch)的,直接使用@Query(“……”)注解搞定,真的是方便到不行!


本篇博客不打算讲Spring Data如何使用,不同的模块(JPA,Neo4j….)使用也略不相同,但Spring Data的排序Sort和分页Pageable接口都是差不多的,所以带大家搞明白搞明白Spring Data的排序和分页是如何使用的。


二:介绍


Spring Data的任务是为数据访问提供一个熟悉的、一致的、基于Spring的编程模型,同时仍然保留底层数据存储的特殊特性。


Spring Data 项目的目的是为了简化构建基于 Spring 框架应用的数据访问计数,包括非关系数据库、Map-Reduce 框架、云数据服务等等;另外也包含对关系数据库的访问支持。


SpringData让数据访问变得更加方便。


三:模块


Spring Data


  • Spring Data for Apache Cassandra
  • Spring Data Commons
  • Spring Data Couchbase
  • Spring Data Elasticsearch
  • Spring Data Envers
  • Spring Data for Pivotal GemFire
  • Spring Data Graph
  • Spring Data JDBC
  • Spring Data JDBC Extensions
  • Spring Data JPA
  • Spring Data LDAP
  • Spring Data MongoDB
  • Spring Data Neo4J
  • Spring Data Redis
  • Spring Data REST
  • Spring Data for Apache Solr
  • Spring for Apache Hadoop


四:排序


通过一行代码就可以快速使用:


Sort sort = new Sort(Sort.Direction.DESC, "id");


在Sort类中定义了一个枚举类型Direction,该枚举类型声明了两个常量ASC,DESC定义

方向。该构造方法的第一个参数指明方向降序(DESC)或升序(ASC),第二个参数指明以id列的值为准进行排序。


你也可以创建一个多属性的Sort实例。


Sort(Sort.Direction direction, List<String> properties)


你也可以只传入属性而不声明方向:


Sort(String... properties)



不过官方已经弃用该方法,推荐使用


public static Sort by(String... properties)


当你不声明方向时,默认方向为升序。


public static final Direction DEFAULT_DIRECTION = Direction.ASC;


Sort的一些方法


image.png


Sort.Order


Sort.Order是Sort的一个静态内部类,官方说明是:PropertyPath实现了排序的配对。方向和属性。它用于提供排序的输入 。


简单来讲,你可以定义一个Order,在需要时传入order构建Sord实例。


Order(Sort.Direction direction, String property)


更独特的使用是加入自己的空处理提示的枚举:

Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint)


Sort.NullHandling是可用于排序表达式的空处理提示的枚举。对使用的数据存储的一种提示,用于在非空条目之后对具有空值的条目进行排序。


在需要Sort时,可通过Order创建:

Sort(Sort.Order... orders)


Sort.Order的一些方法:


image.png


如果你还想全面了解它的使用,推荐阅读官方英文文档:


https://docs.spring.io/spring-data/data-commons/docs/current/api/org/springframework/data/domain/Sort.html

五:分页


Pageable只是 Spring Data 提供的分页信息的抽象接口。


实现类:

  1. AbstractPageRequest:抽象类。供PageRequest和QPageRequest继承。
  2. PageRequest: 基本的可页面化Java Bean实现。
  3. QPageRequest:基本的Java Bean实现,可以支持QueryDSL。


分页功能也只需要一行代码:

Pageable pageable = new PageRequest(int page, int size, Sort sort);


page - 从零开始的索引页



size- 要返回的页面的大小


sort - 排序


你也可以创建没有排序的分页

PageRequest(int page, int size)


更方便的是可以一行代码创建有排序方向和属性的分页

PageRequest(int page, int size, Sort.Direction direction, String... properties)


如果你使用的是2.0以后的版本,官方已经弃用以上构造方法的形式,推荐使用静态方法:



image.png


比如我们想遍历整个数据表,就可以使用分页遍历,这样不至于一次把数据全部加载到内存。



image.png


注意:在使用next()方法时,不要把pageable.next()直接作为参数传入方法。


如repository.findAll(page.next())这样的写法会导致死循环。查看next()方法的源码发现这个方法只是帮我们new了一个新的Pageable对象,原来的pageable还是没啥变化。一直next()下去也只是在原地踏步。


public Pageable next() {
        return new PageRequest(getPageNumber() + 1, getPageSize(), getSort());
    }


正确的写法:



repository.findAll(pageable = pageable.next());

六:使用


Spring Data Jpa除了会通过命名规范帮助我们扩展Sql语句外,还会帮助我们处理类型为Pageable的参数,将pageable参数转换成为sql语句中的条件,同时,还会帮助我们处理类型为Page的返回值,当发现返回值类型为Page,Spring Data Jpa将会把数据的整体信息、当前数据的信息,分页的信息都放入到返回值中。这样,我们就能够方便的进行个性化的分页查询。


public interface UserRepository extends JpaRepository<User,Long> {
    @Override
    Page<Medical> findAll(Pageable pageable);
}


如果你想用@Query写原生查询语句并实现分页:


Spring Data JPA目前不支持原生查询的动态排序,因为它必须操作声明的实际查询,这对于原生SQL是无法可靠地做到的。但是,您可以通过自己指定count查询来使用原生查询进行分页,如下面的示例所示:


public interface UserRepository extends JpaRepository<User, Long> {
  @Query(value = "SELECT * FROM USERS WHERE LASTNAME = ?1",
    countQuery = "SELECT count(*) FROM USERS WHERE LASTNAME = ?1",
    nativeQuery = true)
  Page<User> findByLastname(String lastname, Pageable pageable);
}

七:读取


分页查询:

Page<Book> sampleEntities = userRepository.findAll(pageable);


接口Page继承了接口Slice,话不多说,直接上干货!


总页数


int getTotalPages()


元素的总数

long getTotalElements()


返回当前页的索引(是第几页)

int getNumber()


返回作为List的页面内容


List<T> getContent()


返回当前在这个页上的元素的数量

int getNumberOfElements()


返回用于请求当前页的Pageable

default Pageable    getPageable()


返回页的大小。

int getSize()


返回页的排序参数。

Sort getSort()


页面是否有内容。

boolean hasContent()


是否有下一页。

boolean hasNext()


是否有上一页

boolean hasPrevious()


当前页是否是第一个

boolean isFirst()


当前页是否是最后一个

boolean isLast()


下一页的Pageable

Pageable nextPageable()


上一页的Pageable

Pageable previousPageable()



目录
相关文章
|
1月前
|
安全 Java 测试技术
《深入理解Spring》单元测试——高质量代码的守护神
Spring测试框架提供全面的单元与集成测试支持,通过`@SpringBootTest`、`@WebMvcTest`等注解实现分层测试,结合Mockito、Testcontainers和Jacoco,保障代码质量,提升开发效率与系统稳定性。
|
1月前
|
NoSQL Java 数据库连接
《深入理解Spring》Spring Data——数据访问的统一抽象与极致简化
Spring Data通过Repository抽象和方法名派生查询,简化数据访问层开发,告别冗余CRUD代码。支持JPA、MongoDB、Redis等多种存储,统一编程模型,提升开发效率与架构灵活性,是Java开发者必备利器。(238字)
|
1月前
|
存储 Java 关系型数据库
Spring Boot中Spring Data JPA的常用注解
Spring Data JPA通过注解简化数据库操作,实现实体与表的映射。常用注解包括:`@Entity`、`@Table`定义表结构;`@Id`、`@GeneratedValue`配置主键策略;`@Column`、`@Transient`控制字段映射;`@OneToOne`、`@OneToMany`等处理关联关系;`@Enumerated`、`@NamedQuery`支持枚举与命名查询。合理使用可提升开发效率与代码可维护性。(238字)
301 1
|
1月前
|
人工智能 监控 Java
零代码改造 + 全链路追踪!Spring AI 最新可观测性详细解读
Spring AI Alibaba 通过集成 OpenTelemetry 实现可观测性,支持框架原生和无侵入探针两种方式。原生方案依赖 Micrometer 自动埋点,适用于快速接入;无侵入探针基于 LoongSuite 商业版,无需修改代码即可采集标准 OTLP 数据,解决了原生方案扩展性差、调用链易断链等问题。未来将开源无侵入探针方案,整合至 AgentScope Studio,并进一步增强多 Agent 场景下的观测能力。
1396 33
|
2月前
|
安全 Java 应用服务中间件
Spring Boot + Java 21:内存减少 60%,启动速度提高 30% — 零代码
通过调整三个JVM和Spring Boot配置开关,无需重写代码即可显著优化Java应用性能:内存减少60%,启动速度提升30%。适用于所有在JVM上运行API的生产团队,低成本实现高效能。
287 3
存储 JSON Java
490 0
|
2月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
139 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
2月前
|
SQL Java 数据库连接
Spring Data JPA 技术深度解析与应用指南
本文档全面介绍 Spring Data JPA 的核心概念、技术原理和实际应用。作为 Spring 生态系统中数据访问层的关键组件,Spring Data JPA 极大简化了 Java 持久层开发。本文将深入探讨其架构设计、核心接口、查询派生机制、事务管理以及与 Spring 框架的集成方式,并通过实际示例展示如何高效地使用这一技术。本文档约1500字,适合有一定 Spring 和 JPA 基础的开发者阅读。
332 0
|
4月前
|
安全 Java Nacos
0代码改动实现Spring应用数据库帐密自动轮转
Nacos作为国内被广泛使用的配置中心,已经成为应用侧的基础设施产品,近年来安全问题被更多关注,这是中国国内软件行业逐渐迈向成熟的标志,也是必经之路,Nacos提供配置加密存储-运行时轮转的核心安全能力,将在应用安全领域承担更多职责。