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

Question

Spring JPA 具有 Pageable 接口。我可以将其传递给存储库方法。它的一些实现如PageRequest包含 a page、 asize和 a 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 页的所有结果。

但是，您也可以不只是给它一个未分页的 Pageable 和一个 Sort 参数，如果你这样做，它会抛出这个异常： java.lang.IllegalStateException: Method must not have Pageable *and* Sort parameter. Use sorting capabilities on Pageable instead!

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

我们的用户只是想传递size=0他们的请求，然后获取所有数据（不限于某个任意的最大值，而是一个真正的未分页请求）。这很烦人，因为这意味着我需要从控制器中删除 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;
    }
}

在我的控制器中有这个：

@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 接口类。