refactor(forgeboot-webmvc): 优化 R 类文档注释- 为 R 类添加类级别的文档注释,说明其用途和包含的属性

- 为 buildExtraMap 方法添加详细的文档注释,解释其功能和参数
- 为 success 和 failure 方法添加详细的文档注释,解释其功能、参数和返回值
- 优化文档注释的格式和内容,提高代码可读性和维护性
This commit is contained in:
gewuyou 2025-06-26 22:25:35 +08:00
parent 8042b45cea
commit 3eb5ba6239

View File

@ -39,6 +39,9 @@ val defaultFailureResponseInformation = object : ResponseInformation {
/** /**
* 统一响应封装类 * 统一响应封装类
* *
* 该类用于封装所有接口的响应数据继承自BaseResult提供标准的响应结构
* 包含状态码成功标志消息数据请求ID和扩展信息
*
* @since 2025-05-03 16:04:42 * @since 2025-05-03 16:04:42
*/ */
data class R<T>( data class R<T>(
@ -50,6 +53,15 @@ data class R<T>(
override val extra: Map<String, Any?> = emptyMap(), override val extra: Map<String, Any?> = emptyMap(),
) : BaseResult<T>(code, success, message, data, requestId, extra) { ) : BaseResult<T>(code, success, message, data, requestId, extra) {
companion object { companion object {
/**
* 构建扩展信息映射表
*
* 该方法遍历扩展器列表调用每个扩展器的extend方法来填充额外信息
* 主要用于在构建响应时添加可选的扩展字段
*
* @param extenders 扩展信息提供者列表
* @return 包含所有扩展信息的Map对象
*/
private fun buildExtraMap(extenders: List<ResultExtender>): Map<String, Any?> { private fun buildExtraMap(extenders: List<ResultExtender>): Map<String, Any?> {
return mutableMapOf<String, Any?>().apply { return mutableMapOf<String, Any?>().apply {
extenders.forEach { it.extend(this) } extenders.forEach { it.extend(this) }
@ -59,11 +71,14 @@ data class R<T>(
/** /**
* 创建成功响应对象 * 创建成功响应对象
* *
* @param info 响应信息对象 * 使用给定的响应信息对象创建一个成功的响应实例默认使用预定义的成功信息
* @param data 响应数据 * 可指定数据内容请求ID提供者以及一组扩展器以增强响应信息
* @param requestIdProvider 请求ID提供者 *
* @param extenders 扩展信息提供者列表 * @param info 响应信息对象默认为defaultOkResponseInformation
* @return 成功响应对象 * @param data 响应数据默认为null
* @param requestIdProvider 请求ID提供者默认为DefaultRequestIdProvider
* @param extenders 扩展信息提供者列表默认为空列表
* @return 成功响应对象R<T>
*/ */
fun <T> success( fun <T> success(
info: ResponseInformation = defaultOkResponseInformation, info: ResponseInformation = defaultOkResponseInformation,
@ -79,11 +94,14 @@ data class R<T>(
/** /**
* 创建失败响应对象 * 创建失败响应对象
* *
* @param info 响应信息对象 * 使用给定的响应信息对象创建一个失败的响应实例默认使用预定义的失败信息
* @param data 响应数据 * 可指定数据内容请求ID提供者以及一组扩展器以增强响应信息
* @param requestIdProvider 请求ID提供者 *
* @param extenders 扩展信息提供者列表 * @param info 响应信息对象默认为defaultFailureResponseInformation
* @return 失败响应对象 * @param data 响应数据默认为null
* @param requestIdProvider 请求ID提供者默认为DefaultRequestIdProvider
* @param extenders 扩展信息提供者列表默认为空列表
* @return 失败响应对象R<T>
*/ */
fun <T> failure( fun <T> failure(
info: ResponseInformation = defaultFailureResponseInformation, info: ResponseInformation = defaultFailureResponseInformation,
@ -99,12 +117,15 @@ data class R<T>(
/** /**
* 创建成功响应对象 * 创建成功响应对象
* *
* @param code 响应码 * 使用指定的状态码和消息创建一个成功的响应实例
* @param message 消息 * 可指定数据内容请求ID提供者以及一组扩展器以增强响应信息
* @param data 响应数据 *
* @param requestIdProvider 请求ID提供者 * @param code 响应码默认为200
* @param extenders 扩展信息提供者列表 * @param message 消息默认为"success"
* @return 成功响应对象 * @param data 响应数据默认为null
* @param requestIdProvider 请求ID提供者默认为DefaultRequestIdProvider
* @param extenders 扩展信息提供者列表默认为空列表
* @return 成功响应对象R<T>
*/ */
fun <T> success( fun <T> success(
code: Int = 200, code: Int = 200,
@ -117,15 +138,19 @@ data class R<T>(
val extra = buildExtraMap(extenders) val extra = buildExtraMap(extenders)
return R(code, true, message, data, reqId, extra) return R(code, true, message, data, reqId, extra)
} }
/** /**
* 创建成功响应对象 * 创建成功响应对象参数顺序不同
* *
* @param code 响应码 * 这个方法与另一个success方法功能相同但参数顺序不同
* @param message 消息 * 提供了更灵活的数据传递方式允许优先设置数据内容
* @param data 响应数据 *
* @param requestIdProvider 请求ID提供者 * @param data 响应数据默认为null
* @param extenders 扩展信息提供者列表 * @param code 响应码默认为200
* @return 成功响应对象 * @param message 消息默认为"success"
* @param requestIdProvider 请求ID提供者默认为DefaultRequestIdProvider
* @param extenders 扩展信息提供者列表默认为空列表
* @return 成功响应对象R<T>
*/ */
fun <T> success( fun <T> success(
data: T? = null, data: T? = null,
@ -142,12 +167,15 @@ data class R<T>(
/** /**
* 创建失败响应对象 * 创建失败响应对象
* *
* @param code 响应码 * 使用指定的状态码和消息创建一个失败的响应实例
* @param message 消息 * 可指定数据内容请求ID提供者以及一组扩展器以增强响应信息
* @param data 响应数据 *
* @param requestIdProvider 请求ID提供者 * @param code 响应码默认为400
* @param extenders 扩展信息提供者列表 * @param message 消息默认为"failure"
* @return 失败响应对象 * @param data 响应数据默认为null
* @param requestIdProvider 请求ID提供者默认为DefaultRequestIdProvider
* @param extenders 扩展信息提供者列表默认为空列表
* @return 失败响应对象R<T>
*/ */
fun <T> failure( fun <T> failure(
code: Int = 400, code: Int = 400,