多种排序可选查询-具有分页功能的Spring REST Controller配置

时间:2019-02-19 20:22:47

标签: java spring rest jpa pagination

我想构建一个可以处理多个可选排序查询的spring控制器。根据{{​​3}}规范,应将这些查询的格式设置为

&sort=name,desc&sort=code,desc

spring.io

所述

我知道这可以通过一个排序实例来完成,该实例具有要排序的值,并且方向按EduardoFernandes分别给出,但是与Spring规范不匹配或不能处理多个排序值。

我不确定如何将spring规范格式的多个查询转换为可以传递给PageRequest然后传递到存储库的Sort。另外,我希望能够将其设置为可选,如果可能的话,如果根据Gregg(@SortDefault)的需要使用默认值来实现此功能,那么我可以使用基于@Anotation的配置就很好了。

这是我正在工作的基础。

@Entity
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Subject {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String code; 
...

存储库

public interface SubjectRepository extends JpaRepository<Subject, Long> {
}

服务

@Override
public Page<SubjectDTO> listSubjectsPageble(PageRequest pageableRequest) {
    return subjectRepository.findAll(pageableRequest)
            .map(subjectMapper::subjectToSubjectDTO);
}

控制器

@GetMapping
@ResponseStatus(HttpStatus.OK)
@PreAuthorize("hasRole('LECTURER')")
public Page<SubjectDTO> getSubjects(
        @RequestParam("page") int page,
        @RequestParam("size") int size,
        @RequestParam("sort") String sort

) {

    return subjectService.listSubjectsPageble(PageRequest.of(page, size, new Sort(sort)));
}

因此,在控制器中,我根本不知道如何处理/根据Rasheed Amir从RequestParam中填充Sort,我应该能够使用如下所示的内容从一个中获取多个值param,但我不知道如何将其传递给Sort。

我知道排序可以采用多个参数,但只能采用一个排序方向。然后,我想使它们成为可选的。

@RequestParam MultiValueMap<String, String> params

请帮助,我还是个菜鸟:) 谢谢

编辑

由于Ralph的帖子,我解决了一些问题,但是这种方法有点混乱,并且仍然无法处理多个排序参数。有人知道更好的方法吗?还是这条路?

@GetMapping
    @ResponseStatus(HttpStatus.OK)
    @PreAuthorize("hasRole('LECTURER')")
    public Page<SubjectDTO> getSubjects(
            @RequestParam(value = "page", defaultValue = "0", required = false) int page,
            @RequestParam(value = "size", defaultValue = "10", required = false) int size,
            @RequestParam(value = "sort", defaultValue = "name,ASC", required = false) String sortBy

    ) {
        String[] sort = sortBy.split(",");
        String evalSort = sort[0];
        String sortDirection = sort[1];
        Sort.Direction evalDirection = replaceOrderStringThroughDirection(sortDirection);
        Sort sortOrderIgnoreCase = Sort.by(new Sort.Order(evalDirection,evalSort).ignoreCase());

        return subjectService.listSubjectsPageble(PageRequest.of(page, size, sortOrderIgnoreCase));
    }

    private Sort.Direction replaceOrderStringThroughDirection(String sortDirection) {
        if (sortDirection.equalsIgnoreCase("DESC")){
            return Sort.Direction.DESC;
        } else {
            return Sort.Direction.ASC;
        }
    }

最终解决方案 谢谢大家,这就是我最终得到的。不知道它是否是完美的方法,但是它是否有效:)我最后不得不用分号替换逗号,因为FormattingConversionService会自动将单个排序参数解析为字符串而不是Sting []

@GetMapping
@ResponseStatus(HttpStatus.OK)
@PreAuthorize("hasRole('LECTURER')")
public Page<SubjectDTO> getSubjects(
        @RequestParam(value = "page", defaultValue = "0", required = false) int page,
        @RequestParam(value = "size", defaultValue = "10", required = false) int size,
        @RequestParam(value = "sort", defaultValue = "name;ASC", required = false) String[] sortBy

Sort allSorts = Sort.by(
        Arrays.stream(sortBy)
                .map(sort -> sort.split(";", 2))
                .map(array ->
                        new Sort.Order(replaceOrderStringThroughDirection(array[1]),array[0]).ignoreCase()
                ).collect(Collectors.toList())
);
return subjectService.listSubjectsPageble(PageRequest.of(page, size, allSorts));

private Sort.Direction replaceOrderStringThroughDirection(String sortDirection) {
    if (sortDirection.equalsIgnoreCase("DESC")){
        return Sort.Direction.DESC;
    } else {
        return Sort.Direction.ASC;
    }

1 个答案:

答案 0 :(得分:2)

为什么不在控制器中使用 Pageable

Pageable可以处理许多排序查询,每个查询都将存储在订单列表中。 而且,不需要任何可分页的参数。当您不通过url传递它们时,pageable将包含默认值(page = 0,size = 20)。您可以使用@PageableDefault批注来更改默认值。

GET ... / test?sort = name,desc&sort = code,desc enter image description here