@ParametersAreNonnullByDefault

Package xyz.zhouxy.plusone.commons.model.dto

数据传输对象 1.

See: Description

Class Summary

Class	Description
PageResult<T>	返回分页查询的结果
PagingAndSortingQueryParams	分页排序查询参数 包含三个主要的属性： size - 每页显示的记录数 pageNum - 当前页码 orderBy - 排序条件 分页必须伴随着排序，不然可能出现同一个对象重复出现在不同页，有的对象不被查询到的情况。
PagingAndSortingQueryParams.PagingParamsBuilder
PagingAndSortingQueryParams.SortableProperty	可排序属性
PagingParams	分页参数
UnifiedResponse<T>	统一结果，对返回给前端的数据进行封装。
UnifiedResponses	UnifiedResponse 工厂类。

Package xyz.zhouxy.plusone.commons.model.dto Description

数据传输对象

1. 分页

分页组件由 PagingAndSortingQueryParams 作为入参， 因为分页必须伴随着排序，不然可能出现同一个对象重复出现在不同页，有的对象不被查询到的情况， 所以分页查询的入参必须包含排序条件。

用户可继承 PagingAndSortingQueryParams 构建自己的分页查询入参，需在构造器中调用 PagingAndSortingQueryParams 的构造器，传入一个 Map 作为白名单， key 是供前端指定用于排序的属性名，value 是对应数据库中的字段名，只有在白名单中指定的属性名才允许作为排序条件。

PagingAndSortingQueryParams 包含三个主要的属性：

• size - 每页显示的记录数
• pageNum - 当前页码
• orderBy - 排序条件

其中 orderBy 是一个 List，可以指定多个排序条件，每个排序条件是一个字符串， 格式为“属性名-ASC”或“属性名-DESC”，分别表示升序和降序。

比如前端传入的 orderBy 为 ["name-ASC","age-DESC"]，意味着要按 name 进行升序，name 相同的情况下则按 age 进行降序。

使用时调用 PagingAndSortingQueryParams#buildPagingParams() 方法获取分页参数 PagingParams。

分页结果可以存放到 PageResult 中，作为出参。

2. UnifiedResponse

UnifiedResponse 对返回给前端的数据进行封装，包含 code、message、data。

UnifiedResponses 用于快速构建 UnifiedResponse 对象，默认的成功代码为 2000000。

用户可以继承 UnifiedResponses 实现自己的工厂类， 自定义 SUCCESS_CODE 和 DEFAULT_SUCCESS_MSG，以及工厂方法。

Author:

ZhouXY108