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

时间:2019-11-06 05:14:14

标签: java spring spring-mvc jpa spring-data

Spring JPA具有Pageable接口。我可以将其传递给存储库方法。它的某些实现,例如PageRequest包含pagesizesort。但是,还有一个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,即仅返回包含所有结果的一页。

但是,您不仅可以同时赋予其未分页的Pageable和Sort参数,还可以引发以下异常:java.lang.IllegalStateException: Method must not have Pageable *and* Sort parameter. Use sorting capabilities on Pageable instead!

那么我应该如何在不复制所有存储库方法(主要具有自定义查询)的情况下使用具有Pageable和Sort的版本呢?

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

1 个答案:

答案 0 :(得分:0)

目前,我实现了自己的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接口类。