Spring Boot分页查询进阶：整合Spring Data REST实现高效数据导航

大熊计算机

发布于 2025-07-14 20:02:19

16700

代码可运行

文章被收录于专栏：C博文C博文

运行总次数：0

代码可运行

引言

在现代微服务架构中，客户端经常需要分页加载海量数据，如电商商品、日志记录或社交动态。传统API往往返回固定格式的分页结果，开发者需手动拼装分页链接，既繁琐又易出错。Spring Data REST基于HATEOAS超媒体原则，可自动生成上一页、下一页、首尾页链接，实现零侵入式的数据导航效果。本文将带领读者一步步掌握Spring Boot分页查询进阶技巧，助力打造高效、友好的RESTful分页接口。

分页查询基础回顾

2.1 Spring Data JPA分页接口 Spring Data JPA提供了PagingAndSortingRepository，继承自CrudRepository，额外暴露了分页和排序接口。常用方法：

public interface UserRepository extends PagingAndSortingRepository<User, Long> {
    // 继承分页与排序能力，无需额外定义
}

开发者可直接通过repository.findAll(Pageable pageable)获取Page<T>对象，其中包含总记录数、总页数及当前页内容。

2.2 Pageable与Page的使用 org.springframework.data.domain.Pageable用于封装分页请求参数，常见构造方式：

Pageable pageable = PageRequest.of(pageIndex, pageSize, Sort.by("createdAt").descending());
Page<User> page = userRepository.findAll(pageable);

Page<T>则包含：

getContent()：当前页列表
getTotalPages()：总页数
hasNext() / hasPrevious()：是否可翻页
getPageable()：当前分页参数

2.3 常见分页参数设计为了方便前端交互，我们一般在URL中使用?page=0&size=20&sort=createdAt,desc参数格式，Spring Boot通过PageableHandlerMethodArgumentResolver自动解析。可在配置中全局定制默认页大小与最大页大小：

spring:
  data:
    web:
      pageable:
        default-page-size: 20
        max-page-size: 100

Spring Data REST简介

3.1 HATEOAS与超媒体驱动API HATEOAS（Hypermedia as the Engine of Application State）是一种REST设计原则，强调服务端在响应中提供必要的链接，指导客户端下一步操作。Spring HATEOAS提供EntityModel<T>和Link构建超媒体资源。

3.2 Spring Data REST核心功能 Spring Data REST通过扫描项目中继承Repository的接口，自动生成对应的CRUD REST API，并支持分页、排序、投影、事件拦截器等多项功能，极大降低开发成本。

3.3 自动暴露Repository接口只需添加依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

Spring Boot启动后，访问/users即可得到分页响应：

{
  "_embedded": {"users": [...]},
  "page": {"size":20,"totalElements":100,"totalPages":5,"number":0},
  "_links": {"self":...,"next":...,"prev":...,"first":...,"last":...}
}

整合Spring Boot与Spring Data REST

4.1 项目依赖与配置在pom.xml中同时引入：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

在application.yml中开启HATEOAS链接暴露：

spring:
  data:
    rest:
      default-page-size: 20
      max-page-size: 100
      base-path: /api

4.2 自定义Repository REST资源若想自定义暴露路径或方法名称，可在接口上添加@RepositoryRestResource注解：

@RepositoryRestResource(path = "accounts", collectionResourceRel = "accounts")
public interface AccountRepository extends PagingAndSortingRepository<Account, Long> {
    Page<Account> findByStatus(@Param("status") String status, Pageable pageable);
}

访问/api/accounts/search/findByStatus?status=ACTIVE即可分页查询。

4.3 分页查询自动链接示例示例响应：

{
  "_embedded": {"accounts":[...]},
  "page":{"size":20,"totalElements":45,"totalPages":3,"number":1},
  "_links":{
    "self":{"href":"http://.../accounts?page=1&size=20"},
    "first":{"href":"...page=0"},
    "prev":{"href":"...page=0"},
    "next":{"href":"...page=2"},
    "last":{"href":"...page=2"}
  }
}

高级定制：动态筛选与分页导航

5.1 Querydsl结合Spring Data REST 集成Querydsl后，可动态构建复杂查询：

public interface ProductRepository extends QuerydslPredicateExecutor<Product>, PagingAndSortingRepository<Product, Long> {}

前端传入?predicate=name.contains=book;price.gt=100&page=0&size=10即可组合查询和分页。

5.2 参数解析与Specification实现使用JpaSpecificationExecutor：

public interface OrderRepository extends JpaSpecificationExecutor<Order>, PagingAndSortingRepository<Order, Long> {}
// 构造Specification
Specification<Order> spec = (root, query, cb) -> cb.equal(root.get("status"), status);
Page<Order> result = orderRepository.findAll(spec, pageable);

通过自定义PageableHandlerMethodArgumentResolverCustomizer可让REST端点解析spec参数。

5.3 自定义分页元数据扩展可实现RepresentationModelProcessor<CollectionModel<?>>，为分页响应添加自定义元数据：

@Component
public class PageMetadataProcessor implements RepresentationModelProcessor<CollectionModel<?>> {
  @Override
  public CollectionModel<?> process(CollectionModel<?> model) {
    model.add(Link.of("/api/docs/pagination", "pagination-docs"));
    return model;
  }
}

实战案例：商品管理微服务

6.1 领域模型与数据库设计

Product实体：id, name, description, price, category, createdAt
索引：price、category字段建立索引

6.2 常见分页场景实现

全量分页
分类筛选分页：/products/search/findByCategory?category=electronics
价格区间分页组合查询

6.3 前端集成示例（Vue.js）

async fetchProducts(page = 0) {
  const res = await axios.get(`/api/products?page=${page}&size=20`);
  this.products = res.data._embedded.products;
  this.links = res.data._links;
}

通过links.next.href动态生成下一页按钮。