This commit is contained in:
2026-03-12 10:34:42 +08:00
parent bc8927db26
commit 454cd53553
17 changed files with 245 additions and 167 deletions
@@ -16,61 +16,77 @@
* ProjectName mingli-utils
* ModuleName mingli-utils.main
* CurrentFile Response.kt
* LastUpdate 2026-02-07 22:18:42
* LastUpdate 2026-03-12 10:33:32
* UpdateUser MingLiPro
*/
package com.mingliqiye.utils.http
import com.mingliqiye.utils.annotation.DateTimeJsonFormat
import com.mingliqiye.utils.json.converters.DateTimeJsonConverter
import com.mingliqiye.utils.json.converters.base.AnnotationGetter
import com.mingliqiye.utils.time.DateTime
/**
* HTTP响应数据类
* 封装了时间、消息、数据和状态码等响应信息
*
* 该类用于统一API响应的格式,支持链式调用和不可变对象的创建。
* 提供了多种工厂方法用于创建不同类型的响应对象。
*
* @param T 响应数据的类型
* @property time 响应时间
* @property time 响应时间(格式化的字符串)
* @property message 响应消息
* @property data 响应数据
* @property statusCode 状态码
* @property data 响应数据,可能为空
* @property statusCode HTTP状态码
*/
data class Response<T>(
private var time: DateTime,
private var message: String,
private var data: T?,
private var statusCode: Int,
private val time: String, // 响应时间,一旦创建不可修改
private var message: String, // 响应消息,可通过setter修改
private var data: T?, // 响应数据,可通过setter修改
private var statusCode: Int, // HTTP状态码,可通过setter修改
) {
private var timeFormat: DateTimeJsonFormat = DateTimeJsonFormat()
companion object {
/**
* 创建一个默认的成功响应对象
* 使用默认消息"操作成功",无数据,状态码200
*
* @return Response<Any> 默认的成功响应对象
*/
fun ok() = ok("操作成功")
/**
* 创建一个成功的响应对象(仅包含消息)
*
* @param message 响应消息
* @return Response<Any> 成功的响应对象
* @return Response<Any> 成功的响应对象,数据为null
*/
@JvmStatic
fun ok(message: String) = Response(
time = DateTime.now(),
time = DateTime.now().format(),
message = message,
data = null,
statusCode = 200
)
/**
* 创建一个错误的响应对象
*
* @param message 错误消息,默认为"服务器错误"
* @param statusCode HTTP状态码,默认为500
* @return Response<Any> 错误的响应对象
*/
fun error(message: String = "服务器错误", statusCode: Int = 500) = ok(message).withStatusCode(statusCode)
/**
* 创建一个成功的响应对象(仅包含数据)
* 使用默认消息"操作成功"
*
* @param T 响应数据的类型
* @param data 响应数据
* @return Response<T> 成功的响应对象
* @return Response<T> 成功的响应对象,包含数据
*/
@JvmStatic
fun <T> okData(data: T) = Response(
time = DateTime.now(),
time = DateTime.now().format(),
message = "操作成功",
data = data,
statusCode = 200
@@ -82,26 +98,26 @@ data class Response<T>(
* @param T 响应数据的类型
* @param data 响应数据
* @param message 响应消息
* @return Response<T> 成功的响应对象
* @return Response<T> 成功的响应对象,包含数据和消息
*/
@JvmStatic
fun <T> okData(data: T, message: String) = Response(
time = DateTime.now(),
time = DateTime.now().format(),
message = message,
data = data,
statusCode = 200
)
/**
* 创建一个指定状态码的响应对象(仅包含状态码)
* 使用默认消息"操作成功",无数据
*
* @param statusCode 状态码
* @param statusCode HTTP状态码
* @return Response<Any> 指定状态码的响应对象
*/
@JvmStatic
fun code(statusCode: Int) = Response(
time = DateTime.now(),
time = DateTime.now().format(),
message = "操作成功",
data = null,
statusCode = statusCode
@@ -109,14 +125,15 @@ data class Response<T>(
/**
* 创建一个指定状态码的响应对象(包含状态码和消息)
* 无数据
*
* @param statusCode 状态码
* @param statusCode HTTP状态码
* @param message 响应消息
* @return Response<Any> 指定状态码的响应对象
* @return Response<Any> 指定状态码和消息的响应对象
*/
@JvmStatic
fun code(statusCode: Int, message: String) = Response(
time = DateTime.now(),
time = DateTime.now().format(),
message = message,
data = null,
statusCode = statusCode
@@ -125,45 +142,36 @@ data class Response<T>(
/**
* 默认构造函数,创建一个默认的成功响应对象
* 使用当前时间、默认消息"操作成功"、状态码200、无数据
*/
constructor() : this(
time = DateTime.now(), message = "操作成功", statusCode = 200, data = null
time = DateTime.now().format(),
message = "操作成功",
statusCode = 200,
data = null
)
/**
* 获取格式化后的时间字符串。
*
* @return 格式化后的时间字符串,使用 [DateTimeJsonConverter] 和 [timeFormat] 注解进行转换。
* @return 格式化后的时间字符串
*/
fun getTime(): String =
DateTimeJsonConverter.getJsonConverter().convert(time, AnnotationGetter.oneGetter(timeFormat))!!
/**
* 设置时间字段的值。
*
* @param dateTime 格式化后的时间字符串,将被反序列化为内部时间对象。
* @return 返回当前对象实例,支持链式调用。
*/
fun setTime(dateTime: String): Response<T> {
// 使用 DateTimeJsonConverter 将输入的字符串反序列化为时间对象,并更新内部 time 字段
time = DateTimeJsonConverter.getJsonConverter().deConvert(dateTime, AnnotationGetter.oneGetter(timeFormat))!!
return this
}
fun getTime(): String = time
/**
* 获取响应消息
*
* @return String 响应消息
* @return String 当前响应消息
*/
fun getMessage(): String = message
/**
* 设置响应消息
*
* @param message 响应消息
* @return Response<T> 当前响应对象(用于链式调用)
* 该方法允许修改响应消息,并返回当前对象以支持链式调用。
*
* @param message 新的响应消息
* @return Response<T> 当前响应对象(支持链式调用)
*/
fun setMessage(message: String): Response<T> {
this.message = message
@@ -173,6 +181,8 @@ data class Response<T>(
/**
* 获取响应数据
*
* 返回的响应数据可能为null,调用前应进行空值检查。
*
* @return T? 响应数据,可能为空
*/
fun getData(): T? = data
@@ -180,10 +190,10 @@ data class Response<T>(
/**
* 获取非空数据对象
*
* 此方法强制解包data属性,如果data为null则会抛出NullPointerException异常
* 该方法强制解包data属性,如果data为null则会抛出NullPointerException异常。
* 适用于确定data不为null的场景,避免重复的空值检查。
*
* @param T 泛型类型参数,表示返回的数据类型
* @return 返回非空的数据对象,类型为T
* @return T 非空的数据对象
* @throws NullPointerException 当data属性为null时抛出此异常
*/
@Throws(NullPointerException::class)
@@ -191,14 +201,13 @@ data class Response<T>(
return data ?: throw NullPointerException("at Response.notNullData() because data is null")
}
/**
* 设置响应数据
*
* @param D 数据类型
* @param data 响应数据
* @return Response<D> 当前响应对象(用于链式调用)
* 该方法允许修改响应数据,并返回当前对象以支持链式调用。
*
* @param data 新的响应数据
* @return Response<T> 当前响应对象(支持链式调用)
*/
fun setData(data: T): Response<T> {
this.data = data
@@ -208,18 +217,24 @@ data class Response<T>(
/**
* 创建一个新的Response对象,使用指定的时间
*
* 该方法用于创建具有新时间的响应对象,遵循不可变对象的设计模式。
* 如果时间相同,则返回原对象避免不必要的对象创建。
*
* @param time 新的响应时间
* @return Response<T> 新的响应对象
* @return Response<T> 新的响应对象(如果时间相同则返回原对象)
*/
fun withTime(time: DateTime): Response<T> =
fun withTime(time: String): Response<T> =
if (this.time == time) this else Response(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的数据
*
* 该方法允许改变响应数据的类型,创建一个新的响应对象。
* 适用于需要在保持其他字段不变的情况下更新数据类型的场景。
*
* @param D 新的数据类型
* @param data 新的响应数据
* @return Response<D> 新的响应对象
* @return Response<D> 新的响应对象,数据类型为D
*/
fun <D> withData(data: D): Response<D> =
Response(this.time, this.message, data, this.statusCode)
@@ -227,8 +242,11 @@ data class Response<T>(
/**
* 创建一个新的Response对象,使用指定的消息
*
* 该方法用于创建具有新消息的响应对象,遵循不可变对象的设计模式。
* 如果消息相同,则返回原对象避免不必要的对象创建。
*
* @param message 新的响应消息
* @return Response<T> 新的响应对象
* @return Response<T> 新的响应对象(如果消息相同则返回原对象)
*/
fun withMessage(message: String): Response<T> =
if (this.message == message) this else Response(time, message, data, statusCode)
@@ -236,8 +254,11 @@ data class Response<T>(
/**
* 创建一个新的Response对象,使用指定的状态码
*
* 该方法用于创建具有新状态码的响应对象,遵循不可变对象的设计模式。
* 如果状态码相同,则返回原对象避免不必要的对象创建。
*
* @param statusCode 新的状态码
* @return Response<T> 新的响应对象
* @return Response<T> 新的响应对象(如果状态码相同则返回原对象)
*/
fun withStatusCode(statusCode: Int): Response<T> =
if (this.statusCode == statusCode) this else Response(time, message, data, statusCode)
@@ -245,30 +266,30 @@ data class Response<T>(
/**
* 获取状态码
*
* @return Int 状态码
* @return Int 当前HTTP状态码
*/
fun getStatusCode(): Int = statusCode
/**
* 设置状态码
*
* @param statusCode 状态码
* @return Response<T> 当前响应对象(用于链式调用)
* 该方法允许修改状态码,并返回当前对象以支持链式调用。
*
* @param statusCode 新的HTTP状态码
* @return Response<T> 当前响应对象(支持链式调用)
*/
fun setStatusCode(statusCode: Int): Response<T> {
this.statusCode = statusCode
return this
}
fun writeTimeFormat(timeFormat: DateTimeJsonFormat): Response<T> {
this.timeFormat = timeFormat
return this
}
fun readTimeFormat(): DateTimeJsonFormat = timeFormat
/**
* 返回响应对象的字符串表示
*
* 重写toString方法以提供更有意义的对象表示,便于日志记录和调试。
* 显示时间、消息、数据类型和值以及状态码。
*
* @return 格式化的字符串表示
*/
override fun toString(): String =
"Response(time=${getTime()}, message=${getMessage()}, data:[${data?.javaClass?.simpleName}]=${getData()}, statusCode=${getStatusCode()})"