spring-boot - PagingAndSortingRepository - 自定义可分页响应结构

Question

有没有办法简化从这个控制器返回的结构：

@GetMapping
public Iterable<Task> getAll(@PathParam("page") int page) {
    Pageable pageable = PageRequest.of(page, 3);

    return taskRepository.findAll(pageable);
}

现在响应的正文如下：

本地主机：8080/api/task?page=2

{
    "content": [
        ...
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 6,
        "pageSize": 3,
        "pageNumber": 2,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 19,
    "last": false,
    "totalPages": 7,
    "number": 2,
    "size": 3,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "numberOfElements": 3,
    "first": false,
    "empty": false
}

有什么办法可以减少这些数据？如果我现在对排序不感兴趣，只想返回如下内容怎么办：

{
    "content": [
        ...
    ],
    "pageable": {
        "pageSize": 3,
        "pageNumber": 2,
        "totalElements": 19,
    },
}

因此，当前的响应具有太多我并不真正需要的属性。什么是实现这一目标的好方法？如果我想定制这么多，我应该完全不同地做这件事吗？

标签： spring-bootpaginationcontrollerspring-dataresponse

Answer 1

另一种方法是根据需要创建自定义页面类并从数据创建并返回

@Data
public class CustomPage<T> {
  List<T> content;
  CustomPageable pageable;

  public CustomPage(Page<T> page) {
    this.content = page.getContent();
    this.pageable = new CustomPageable(page.getPageable().getPageNumber(),
        page.getPageable().getPageSize(), page.getTotalElements());
  }

  @Data
  class CustomPageable {
    int pageNumber;
    int pageSize;
    long totalElements;

    public CustomPageable(int pageNumber, int pageSize, long totalElements) {

      this.pageNumber = pageNumber;
      this.pageSize = pageSize;
      this.totalElements = totalElements;
    }
  }
}

并像这样使用

@GetMapping
public CustomPage<Task> getAll(@PathParam("page") int page) {
    Pageable pageable = PageRequest.of(page, 3);
    return new CustomPage<Task>(taskRepository.findAll(pageable));
}

注意： 这里的@Data 的 Lombok 用于 setter getter 等。