java - 我应该如何将未分页但已排序的 Pageable 传递到 Spring JPA 存储库？

Question

Spring JPA 有 Pageable 接口(interface)。我可以将其传递给存储库方法。它的一些实现，如 PageRequest 包含一个 page、一个 size 和一个 sort。但是，还有一个 unpaged 实例，我可以使用 Pageable.unpaged() 创建它并返回一个 org.springframework.data.domain.Unpaged 这是一个实现 Pageable 的枚举。

当您想要使用此可分页对象的排序功能但又不想分页时，问题就来了。在这种情况下，您应该希望 Pageable.isPaged() 返回 false，但是您通常可以创建的唯一实例是 PageRequest(使用 Pagerequest.of(size, page, sort)) 始终为该方法返回 true。

如果您有这样的 JPA 存储库方法:

Page<EventTriggerVersion> findByProjectIdAndEventTriggerId(
    @Param("projectId") UUID projectId, @Param("eventTriggerId") UUID eventTriggerId, Pageable pageable);

然后你不能为它创建一个排序但不分页的 Pageable，即只返回包含所有结果的 1 页。

但是，您也可以不只给它一个未分页的可分页参数和一个排序参数，如果这样做，它会抛出这个异常:java.lang.IllegalStateException: Method must not have Pageable *and* Sort parameter。请改用 Pageable 上的排序功能!

那么我应该如何在不复制我所有的存储库方法(主要有自定义查询)的情况下做到这一点，以获得具有 Pageable 和 Sort 的版本？

我们的用户只是想在他们的请求中传递 size=0 然后获取所有数据(不限于任意最大值，而是真正的未分页请求)。这已经够烦人了，因为这意味着我需要从 Controller 中删除 Pageable 请求参数，并从页面、大小和排序中手动构造它，但现在如果没有严重的代码重复，它甚至似乎是不可能的。

Answer 1

现在我实现了自己的 Pageable 类如下:

import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;

public class SortedUnpaged implements Pageable {

    private final Sort sort;

    private SortedUnpaged(Sort sort) {
        this.sort = sort;
    }

    public static SortedUnpaged getInstance(Sort sort) {
        return new SortedUnpaged(sort);
    }

    public boolean isPaged() {
        return false;
    }

    public Pageable previousOrFirst() {
        return this;
    }

    public Pageable next() {
        return this;
    }

    public boolean hasPrevious() {
        return false;
    }

    public Sort getSort() {
        return sort;
    }

    public int getPageSize() {
        throw new UnsupportedOperationException();
    }

    public int getPageNumber() {
        throw new UnsupportedOperationException();
    }

    public long getOffset() {
        throw new UnsupportedOperationException();
    }

    public Pageable first() {
        return this;
    }
}

在我的 Controller 中有这个:

@GetMapping("/{projectId}" + SUBJECTS_PATH)
public ResponseEntity<SubjectWrapperDTO> getSubjects(
    @RequestParam(name = "size", required = false, defaultValue = "20") Integer size,
    @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
    @SortDefault(sort = "name") Sort sort) {

    Pageable pageable;
    if (size > 0) {
        pageable = PageRequest.of(page, size, sort);
    }
    else {
        pageable = SortedUnpaged.getInstance(sort);
    }
    ...

}

但这对于这样一个基本要求来说似乎有点过分，我宁愿不实现我自己的 Spring 接口(interface)类。