Api Result 2.1.X Release Notes

第一部分：模型类介绍

提供了满足各场景使用的实体类，如下：

ResultModel

这个类是基础实体类，有如下属性：

属性	类型	说明
success	Boolean	返回结果状态标识（成功/失败），是一个布尔值。true：表示返回成功结果；false：表示返回失败（错误）结果
message	String	描述信息，错误时，可以在这里填写错误的详细信息
data	T	数据，是一个泛型，可以是数组或者对象等等，成功并且需要返回数据时，才有该参数

ResultApiModel

结构关系如下：

 ResultModel
 └── ResultApiModel

属性列表如下：

属性	类型	说明
code	C	返回码，是一个泛型，你可以自定义你的返回码类型，可以是整数，或者字符串
success	Boolean	返回结果状态标识（成功/失败），是一个布尔值。true：表示返回成功结果；false：表示返回失败（错误）结果
message	String	描述信息，错误时，可以在这里填写错误的详细信息
data	T	数据，是一个泛型，可以是数组或者对象等等，成功并且需要返回数据时，才有该参数

ResultPageModel

结构关系如下：

 ResultModel
 └── ResultPageModel

属性列表如下：

属性	类型	说明
success	Boolean	返回结果状态标识（成功/失败），是一个布尔值。true：表示返回成功结果；false：表示返回失败（错误）结果
message	String	描述信息，错误时，可以在这里填写错误的详细信息
data	T	数据，是一个泛型，可以是数组或者对象等等，成功并且需要返回数据时，才有该参数
page	PageModel	分页对象

PageModel

属性列表如下：

属性	类型	说明
totalElements	Long	总条数
totalPages	Long	总页数
pageSize	Integer	分页大小
currentPage	Long	当前页

ResultApiPageModel

结构关系如下：

 ResultModel
 └── ResultPageModel
     └── ResultApiPageModel

属性列表如下：

属性	类型	说明
code	C	返回码，是一个泛型，你可以自定义你的返回码类型，可以是整数，或者字符串
success	Boolean	返回结果状态标识（成功/失败），是一个布尔值。true：表示返回成功结果；false：表示返回失败（错误）结果
message	String	描述信息，错误时，可以在这里填写错误的详细信息
data	T	数据，是一个泛型，可以是数组或者对象等等，成功并且需要返回数据时，才有该参数
page	PageModel	分页对象

第二部分：Helper工具类介绍

ResultHelper

ResultHelper 与 ResultModel 对应

success(String message)

成功，携带描述信息

success(String message, T data)

成功，携带描述信息和数据

error(String message)

错误，携带详细的描述信息

ResultApiHelper

ResultApiHelper 与 ResultApiModel 对应

success(S code, String message)

成功，携带返回码和描述信息

success(S code, String message, T data)

成功，携带返回码、描述信息和数据

error(S code, String message)

错误，携带错误码和详细描述信息

ResultPageHelper

ResultPageHelper 与 ResultPageModel 对应

success(String message)

成功，携带描述信息

success(String message, T data)

成功，携带描述信息和数据

success(String message, T data, Long totalElements, Long totalPages, Integer pageSize, Long currentPage)

成功，携带描述信息、数据、总数、每页条数、总页数、当前页

error(String message)

错误，携带详细的描述信息

ResultApiPageHelper

ResultApiPageHelper 与 ResultApiPageModel 对应

success(C code, String message)

成功，携带描述信息

success(C code, String message, T data, Long totalElements, Long totalPages, Integer pageSize, Long currentPage)

成功，携带描述信息、数据、总数、每页条数、总页数、当前页

error(C code, String message)

错误，携带详细的描述信息