java - 多排序可选查询 - 带分页的 Spring REST Controller 配置

Question

我想构建一个可以处理多个可选排序查询的 spring Controller 。根据spring.io规范这些查询应该这样格式化

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

正如 EduardoFernandes 所讨论的那样

我知道这可以通过一个排序实例来完成，其中要排序的值和方向分别根据 Gregg 给出但这不符合 Spring 规范或处理多个排序值。

我不确定如何将 spring 规范格式的多个查询转换为可以传递到我的 PageRequest 然后传递到我的存储库的排序。我也希望能够使这些成为可选的，如果可能的话，如果需要默认值来实现这一点，我可以使用基于@Anotation 的配置，这将是很好的 Rasheed Amir (@SortDefault)

这是我正在使用的基础知识..

域

@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);
}

Controller

@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)));
}

所以在 Controller 中，根据 Ralph，我根本不知道如何处理\从 RequestParam 填充排序我应该能够使用类似下面的方法从一个参数中获取多个值，但我不知道如何将其传递给排序。

我知道排序可以接受多个参数，但只能接受一个排序方向。然后粗略地说，我想让它们成为可选的。

@RequestParam MultiValueMap<String, String> params

请帮忙，我还是个菜鸟:) 谢谢

编辑

感谢 Dullimeister 的帖子，我解决了一些问题但是这种方法感觉有点乱，而且仍然不能处理多个排序参数。有谁知道更好的方法或者这是要走的路吗？

@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;
    }

Answer 1

为什么不在 Controller 中使用 Pageable ？

Pageable 可以处理很多排序查询，每一个都会存储在订单列表中。 此外，不需要任何可分页参数。当您不在 url 中传递它们时，pageable 将包含默认值(page = 0，size = 20)。您可以使用 @PageableDefault 注释更改默认值。

GET .../test?sort=name,desc&sort=code,desc