Package cn.dinodev.spring.commons.response

Class PageResponse<T>

java.lang.Object
cn.dinodev.spring.commons.response.Response<Collection<? extends T>>
cn.dinodev.spring.commons.response.PageResponse<T>
Type Parameters:
T - 分页数据元素类型
public class PageResponse<T> extends Response<Collection<? extends T>>
REST API分页响应包装类
Author:
Cody Lu

  • Constructor Details

    • PageResponse

      protected PageResponse(int code, String msg)
      构造函数，用于创建失败的响应
      Parameters:
      code - 状态码
      msg - 消息

    • PageResponse

      protected PageResponse(int pn, int pl)
      构造函数，用于创建空的分页响应
      Parameters:
      pn - 页码
      pl - 每页数量

    • PageResponse

      protected PageResponse(Collection<? extends T> list, Long total, Integer pn, Integer pl)
      构造函数，用于创建带数据的分页响应
      Parameters:
      list - 数据列表
      total - 总条数
      pn - 页码
      pl - 每页数量

  • Method Details

    • set

      public PageResponse<T> set(Collection<? extends T> list, Long total)
      设置分页数据和总数
      Parameters:
      list - 数据列表
      total - 总条数
      Returns:
      当前 PageResponse 实例

    • setData

      public Response<Collection<? extends T>> setData(Collection<? extends T> list)

    • getTotalPage

      public Long getTotalPage()
      获取总页数
      Returns:
      总页数

    • success

      public static <T> PageResponse<T> success(org.springframework.data.domain.Page<T> page)
      从 Spring Data Page 对象创建成功的分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      page - Spring Data Page 对象
      Returns:
      成功的分页响应

    • success

      public static <T, S> PageResponse<T> success(org.springframework.data.domain.Page<S> page, Function<Collection<S>,Collection<? extends T>> converter)
      从 Spring Data Page 对象创建成功的分页响应，并转换数据
      Type Parameters:
      T - 目标数据类型
      S - 原始数据类型
      Parameters:
      page - Spring Data Page 对象
      converter - 数据转换函数
      Returns:
      转换后的成功分页响应

    • success

      public static <T> PageResponse<T> success(int pn, int pl)
      创建一个空的成功分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      pn - 页码
      pl - 每页数量
      Returns:
      空的成功分页响应

    • success

      public static <T> PageResponse<T> success(int pn, int pl, Collection<T> list, Long totalCount)
      创建一个带数据的成功分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      pn - 页码
      pl - 每页数量
      list - 数据列表
      totalCount - 总条数
      Returns:
      带数据的成功分页响应

    • success

      public static <T> PageResponse<T> success(org.springframework.data.domain.Pageable page, Collection<T> list, Long totalCount)
      从 Pageable 对象和数据列表创建成功的分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      page - Pageable 对象
      list - 数据列表
      totalCount - 总条数
      Returns:
      成功的分页响应

    • failPage

      public static <T> PageResponse<T> failPage(String msg)
      创建一个失败的分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      msg - 失败消息
      Returns:
      失败的分页响应

    • failPage

      public static <T> PageResponse<T> failPage(Status status)
      创建一个失败的分页响应
      Type Parameters:
      T - 数据类型
      Parameters:
      status - 状态
      Returns:
      失败的分页响应