Spring Data REST搜索接口为何不返回分页元数据？

这个问题我之前也踩过坑，核心原因其实出在你仓库方法的返回类型上！

为什么两种接口表现不一样？ #

咱们先拆解一下背后的逻辑：

• 直接访问/api/users时，调用的是PagingAndSortingRepository自带的findAll(Pageable)方法，这个方法的返回类型是Page<User>。Spring Data REST识别到Page类型后，会自动把分页元数据（总条数、总页数、当前页码等）和分页导航链接（first、next、last）一起封装到响应结构里。
• 而你自定义的findByNameContainingIgnoreCase方法返回的是List<User>——虽然你传入了Pageable参数实现了数据分页截取，但List本身只是单纯的结果集合，不包含任何分页元数据（比如总共有多少条、多少页）。Spring Data REST没办法从一个List里拿到这些额外信息，自然也就没法在响应里输出分页相关的内容了。

怎么解决？ #

很简单，把自定义方法的返回类型从List<User>改成Page<User>就行：

public interface UserRepository extends PagingAndSortingRepository<User, String> { 
    Page<User> findByNameContainingIgnoreCase(String name, Pageable pageable); 
}

修改之后，再访问你的搜索接口http://localhost:43434/api/users/search/findByNameContainingIgnoreCase?name=mic，就能看到和集合接口一样的响应结构了——不仅有当前页的用户数据，还会包含page字段的分页元数据，以及first、next这类分页导航链接。

补充说明 #

Spring Data REST对不同返回类型的处理逻辑是不一样的：

• 返回Page：完整封装分页信息，包括元数据和导航链接
• 返回List：仅返回数据集合，即使传入Pageable也只会做数据截取，不会附加分页元数据
• 返回Slice：和Page类似，但不会返回总条数和总页数（适合不需要总数据量的场景，性能更好）

内容的提问来源于stack exchange，提问作者Michael