style: 全项目统一 Tab 缩进并补全尾随逗号

This commit is contained in:
2026-11-07 13:54:46 +08:00
parent 7a3bc01b11
commit 5714aef444
195 changed files with 37684 additions and 37406 deletions
@@ -23,20 +23,20 @@
package com.mingliqiye.utils.http
open class BaseResponse<T>(
open val time: String,
open var message: String,
open var data: T,
open var statusCode: Int,
open val time: String,
open var message: String,
open var data: T,
open var statusCode: Int,
) {
/**
* 返回响应对象的字符串表示
*
* 重写toString方法以提供更有意义的对象表示,便于日志记录和调试。
* 显示时间、消息、数据类型和值以及状态码。
*
* @return 格式化的字符串表示
*/
override fun toString(): String =
"${javaClass.simpleName}(time=${time}, message=${message}, data=${data}, statusCode=${statusCode})"
) {
/**
* 返回响应对象的字符串表示
*
* 重写toString方法以提供更有意义的对象表示,便于日志记录和调试。
* 显示时间、消息、数据类型和值以及状态码。
*
* @return 格式化的字符串表示
*/
override fun toString(): String =
"${javaClass.simpleName}(time=${time}, message=${message}, data=${data}, statusCode=${statusCode})"
}
File diff suppressed because it is too large Load Diff
@@ -28,38 +28,38 @@ import com.baomidou.mybatisplus.extension.plugins.pagination.Page
* 分页数据类
*/
data class PageData<T>(
/**
* 当前页的数据列表
*/
val records: Collection<T> = emptyList(),
/**
* 当前页的数据列表
*/
val records: Collection<T> = emptyList(),
/**
* 总条数(总记录数)
*/
val totalCount: Long = 0,
/**
* 总条数(总记录数)
*/
val totalCount: Long = 0,
/**
* 总页数
*/
val totalPages: Long = 0,
/**
* 总页数
*/
val totalPages: Long = 0,
/**
* 每页大小
*/
val pageSize: Long = 0,
/**
* 每页大小
*/
val pageSize: Long = 0,
/**
* 当前页码(从 1 开始)
*/
val pageIndex: Long = 0,
/**
* 当前页码(从 1 开始)
*/
val pageIndex: Long = 0,
) {
companion object {
fun <T> of(page: Page<T>): PageData<T> = PageData(
records = page.records,
totalCount = page.total,
totalPages = page.pages,
pageSize = page.size,
pageIndex = page.current,
)
}
companion object {
fun <T> of(page: Page<T>): PageData<T> = PageData(
records = page.records,
totalCount = page.total,
totalPages = page.pages,
pageSize = page.size,
pageIndex = page.current,
)
}
}
@@ -26,191 +26,191 @@ import com.baomidou.mybatisplus.extension.plugins.pagination.Page
import com.mingliqiye.utils.time.DateTime
data class PagedResponse<T>(
override val time: String, // 响应时间,一旦创建不可修改
override var message: String, // 响应消息,可通过setter修改
override var data: PageData<T>, // 响应数据,可通过setter修改
override var statusCode: Int, // HTTP状态码,可通过setter修改
override val time: String, // 响应时间,一旦创建不可修改
override var message: String, // 响应消息,可通过setter修改
override var data: PageData<T>, // 响应数据,可通过setter修改
override var statusCode: Int, // HTTP状态码,可通过setter修改
) : BaseResponse<PageData<T>>(
time,
message,
data,
statusCode
time,
message,
data,
statusCode
) {
companion object {
/**
* 创建一个默认的成功响应对象
* 使用默认消息"操作成功",无数据,状态码200
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun ok() = ok("操作成功")
companion object {
/**
* 创建一个默认的成功响应对象
* 使用默认消息"操作成功",无数据,状态码200
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun ok() = ok("操作成功")
/**
* 创建一个默认的错误响应对象
* 使用默认消息"服务器错误",无数据,状态码500
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun error() = error("服务器错误")
/**
* 创建一个默认的错误响应对象
* 使用默认消息"服务器错误",无数据,状态码500
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun error() = error("服务器错误")
/**
* 创建一个成功的响应对象(仅包含消息)
*
* @param message 响应消息
* @return Response<Any> 成功的响应对象,数据为null
*/
@JvmStatic
fun ok(message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = PageData<Nothing>(), statusCode = 200
)
/**
* 创建一个成功的响应对象(仅包含消息)
*
* @param message 响应消息
* @return Response<Any> 成功的响应对象,数据为null
*/
@JvmStatic
fun ok(message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = PageData<Nothing>(), statusCode = 200
)
/**
* 创建一个错误的响应对象
*
* @param message 错误消息,默认为"服务器错误"
* @param statusCode HTTP状态码,默认为500
* @return Response<Any> 错误的响应对象
*/
fun error(message: String = "服务器错误", statusCode: Int = 500) = ok(message).withStatusCode(statusCode)
/**
* 创建一个错误的响应对象
*
* @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> 成功的响应对象,包含数据
*/
@JvmStatic
fun <T> okData(data: PageData<T>) = PagedResponse(
time = DateTime.now().format(), message = "操作成功", data = data, statusCode = 200
)
/**
* 创建一个成功的响应对象(仅包含数据)
* 使用默认消息"操作成功"
*
* @param T 响应数据的类型
* @param data 响应数据
* @return Response<T> 成功的响应对象,包含数据
*/
@JvmStatic
fun <T> okData(data: PageData<T>) = PagedResponse(
time = DateTime.now().format(), message = "操作成功", data = data, statusCode = 200
)
/**
* 从mybatisplus的page构建
*/
@JvmOverloads
fun <T> okPgae(
page: Page<T>,
time: String = DateTime.now().format(),
message: String = "操作成功",
statusCode: Int = 200,
): PagedResponse<T> {
/**
* 从mybatisplus的page构建
*/
@JvmOverloads
fun <T> okPgae(
page: Page<T>,
time: String = DateTime.now().format(),
message: String = "操作成功",
statusCode: Int = 200,
): PagedResponse<T> {
return PagedResponse(
time = time, message = message, data = PageData.of(page), statusCode = statusCode
)
}
return PagedResponse(
time = time, message = message, data = PageData.of(page), statusCode = statusCode
)
}
/**
* 创建一个成功的响应对象(包含数据和消息)
*
* @param T 响应数据的类型
* @param data 响应数据
* @param message 响应消息
* @return Response<T> 成功的响应对象,包含数据和消息
*/
@JvmStatic
fun <T> okData(data: PageData<T>, message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = data, statusCode = 200
)
/**
* 创建一个成功的响应对象(包含数据和消息)
*
* @param T 响应数据的类型
* @param data 响应数据
* @param message 响应消息
* @return Response<T> 成功的响应对象,包含数据和消息
*/
@JvmStatic
fun <T> okData(data: PageData<T>, message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = data, statusCode = 200
)
/**
* 创建一个指定状态码的响应对象(仅包含状态码)
* 使用默认消息"操作成功",无数据
*
* @param statusCode HTTP状态码
* @return Response<Any> 指定状态码的响应对象
*/
@JvmStatic
fun code(statusCode: Int) = PagedResponse(
time = DateTime.now().format(), message = "操作成功", data = PageData<Nothing>(), statusCode = statusCode
)
/**
* 创建一个指定状态码的响应对象(仅包含状态码)
* 使用默认消息"操作成功",无数据
*
* @param statusCode HTTP状态码
* @return Response<Any> 指定状态码的响应对象
*/
@JvmStatic
fun code(statusCode: Int) = PagedResponse(
time = DateTime.now().format(), message = "操作成功", data = PageData<Nothing>(), statusCode = statusCode
)
/**
* 创建一个指定状态码的响应对象(包含状态码和消息)
* 无数据
*
* @param statusCode HTTP状态码
* @param message 响应消息
* @return Response<Any> 指定状态码和消息的响应对象
*/
@JvmStatic
fun code(statusCode: Int, message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = PageData<Nothing>(), statusCode = statusCode
)
}
/**
* 创建一个指定状态码的响应对象(包含状态码和消息)
* 无数据
*
* @param statusCode HTTP状态码
* @param message 响应消息
* @return Response<Any> 指定状态码和消息的响应对象
*/
@JvmStatic
fun code(statusCode: Int, message: String) = PagedResponse(
time = DateTime.now().format(), message = message, data = PageData<Nothing>(), statusCode = statusCode
)
}
/**
* 默认构造函数,创建一个默认的成功响应对象
* 使用当前时间、默认消息"操作成功"、状态码200、无数据
*/
constructor() : this(
time = DateTime.now().format(), message = "操作成功", statusCode = 200, data = PageData()
)
/**
* 默认构造函数,创建一个默认的成功响应对象
* 使用当前时间、默认消息"操作成功"、状态码200、无数据
*/
constructor() : this(
time = DateTime.now().format(), message = "操作成功", statusCode = 200, data = PageData()
)
/**
* 设置响应数据
*
* 该方法允许修改响应数据,并返回当前对象以支持链式调用。
*
* @param data 新的响应数据
* @return Response<T> 当前响应对象(支持链式调用)
*/
fun setData(data: PageData<T>): PagedResponse<T> {
this.data = data
return this
}
/**
* 设置响应数据
*
* 该方法允许修改响应数据,并返回当前对象以支持链式调用。
*
* @param data 新的响应数据
* @return Response<T> 当前响应对象(支持链式调用)
*/
fun setData(data: PageData<T>): PagedResponse<T> {
this.data = data
return this
}
/**
* 创建一个新的Response对象,使用指定的时间
*
* 该方法用于创建具有新时间的响应对象,遵循不可变对象的设计模式。
* 如果时间相同,则返回原对象避免不必要的对象创建。
*
* @param time 新的响应时间
* @return Response<T> 新的响应对象(如果时间相同则返回原对象)
*/
fun withTime(time: String): PagedResponse<T> =
if (this.time == time) this else PagedResponse(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的时间
*
* 该方法用于创建具有新时间的响应对象,遵循不可变对象的设计模式。
* 如果时间相同,则返回原对象避免不必要的对象创建。
*
* @param time 新的响应时间
* @return Response<T> 新的响应对象(如果时间相同则返回原对象)
*/
fun withTime(time: String): PagedResponse<T> =
if (this.time == time) this else PagedResponse(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的数据
*
* 该方法允许改变响应数据的类型,创建一个新的响应对象。
* 适用于需要在保持其他字段不变的情况下更新数据类型的场景。
*
* @param D 新的数据类型
* @param data 新的响应数据
* @return Response<D> 新的响应对象,数据类型为D
*/
fun <D> withData(data: PageData<D>): PagedResponse<D> =
PagedResponse(this.time, this.message, data, this.statusCode)
/**
* 创建一个新的Response对象,使用指定的数据
*
* 该方法允许改变响应数据的类型,创建一个新的响应对象。
* 适用于需要在保持其他字段不变的情况下更新数据类型的场景。
*
* @param D 新的数据类型
* @param data 新的响应数据
* @return Response<D> 新的响应对象,数据类型为D
*/
fun <D> withData(data: PageData<D>): PagedResponse<D> =
PagedResponse(this.time, this.message, data, this.statusCode)
/**
* 创建一个新的Response对象,使用指定的消息
*
* 该方法用于创建具有新消息的响应对象,遵循不可变对象的设计模式。
* 如果消息相同,则返回原对象避免不必要的对象创建。
*
* @param message 新的响应消息
* @return Response<T> 新的响应对象(如果消息相同则返回原对象)
*/
fun withMessage(message: String): PagedResponse<T> =
if (this.message == message) this else PagedResponse(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的消息
*
* 该方法用于创建具有新消息的响应对象,遵循不可变对象的设计模式。
* 如果消息相同,则返回原对象避免不必要的对象创建。
*
* @param message 新的响应消息
* @return Response<T> 新的响应对象(如果消息相同则返回原对象)
*/
fun withMessage(message: String): PagedResponse<T> =
if (this.message == message) this else PagedResponse(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的状态码
*
* 该方法用于创建具有新状态码的响应对象,遵循不可变对象的设计模式。
* 如果状态码相同,则返回原对象避免不必要的对象创建。
*
* @param statusCode 新的状态码
* @return Response<T> 新的响应对象(如果状态码相同则返回原对象)
*/
fun withStatusCode(statusCode: Int): PagedResponse<T> =
if (this.statusCode == statusCode) this else PagedResponse(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的状态码
*
* 该方法用于创建具有新状态码的响应对象,遵循不可变对象的设计模式。
* 如果状态码相同,则返回原对象避免不必要的对象创建。
*
* @param statusCode 新的状态码
* @return Response<T> 新的响应对象(如果状态码相同则返回原对象)
*/
fun withStatusCode(statusCode: Int): PagedResponse<T> =
if (this.statusCode == statusCode) this else PagedResponse(time, message, data, statusCode)
}
@@ -38,171 +38,171 @@ import com.mingliqiye.utils.time.DateTime
* @property statusCode HTTP状态码
*/
data class Response<T>(
override val time: String, // 响应时间,一旦创建不可修改
override var message: String, // 响应消息,可通过setter修改
override var data: T?, // 响应数据,可通过setter修改
override var statusCode: Int, // HTTP状态码,可通过setter修改
override val time: String, // 响应时间,一旦创建不可修改
override var message: String, // 响应消息,可通过setter修改
override var data: T?, // 响应数据,可通过setter修改
override var statusCode: Int, // HTTP状态码,可通过setter修改
) : BaseResponse<T?>(
time,
message,
data,
statusCode,
time,
message,
data,
statusCode,
) {
companion object {
/**
* 创建一个默认的成功响应对象
* 使用默认消息"操作成功",无数据,状态码200
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun ok() = ok("操作成功")
companion object {
/**
* 创建一个默认的成功响应对象
* 使用默认消息"操作成功",无数据,状态码200
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun ok() = ok("操作成功")
/**
* 创建一个默认的错误响应对象
* 使用默认消息"服务器错误",无数据,状态码500
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun error() = error("服务器错误")
/**
* 创建一个默认的错误响应对象
* 使用默认消息"服务器错误",无数据,状态码500
*
* @return Response<Nothing> 默认的成功响应对象
*/
fun error() = error("服务器错误")
/**
* 创建一个成功的响应对象(仅包含消息)
*
* @param message 响应消息
* @return Response<Any> 成功的响应对象,数据为null
*/
@JvmStatic
fun ok(message: String) = Response(
time = DateTime.now().format(), message = message, data = null, statusCode = 200
)
/**
* 创建一个成功的响应对象(仅包含消息)
*
* @param message 响应消息
* @return Response<Any> 成功的响应对象,数据为null
*/
@JvmStatic
fun ok(message: String) = Response(
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 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> 成功的响应对象,包含数据
*/
@JvmStatic
fun <T> okData(data: T) = Response(
time = DateTime.now().format(), message = "操作成功", data = data, statusCode = 200
)
/**
* 创建一个成功的响应对象(仅包含数据)
* 使用默认消息"操作成功"
*
* @param T 响应数据的类型
* @param data 响应数据
* @return Response<T> 成功的响应对象,包含数据
*/
@JvmStatic
fun <T> okData(data: T) = Response(
time = DateTime.now().format(), message = "操作成功", data = data, statusCode = 200
)
/**
* 创建一个成功的响应对象(包含数据和消息)
*
* @param T 响应数据的类型
* @param data 响应数据
* @param message 响应消息
* @return Response<T> 成功的响应对象,包含数据和消息
*/
@JvmStatic
fun <T> okData(data: T, message: String) = Response(
time = DateTime.now().format(), message = message, data = data, statusCode = 200
)
/**
* 创建一个成功的响应对象(包含数据和消息)
*
* @param T 响应数据的类型
* @param data 响应数据
* @param message 响应消息
* @return Response<T> 成功的响应对象,包含数据和消息
*/
@JvmStatic
fun <T> okData(data: T, message: String) = Response(
time = DateTime.now().format(), message = message, data = data, statusCode = 200
)
/**
* 创建一个指定状态码的响应对象(仅包含状态码)
* 使用默认消息"操作成功",无数据
*
* @param statusCode HTTP状态码
* @return Response<Any> 指定状态码的响应对象
*/
@JvmStatic
fun code(statusCode: Int) = Response(
time = DateTime.now().format(), message = "操作成功", data = null, statusCode = statusCode
)
/**
* 创建一个指定状态码的响应对象(仅包含状态码)
* 使用默认消息"操作成功",无数据
*
* @param statusCode HTTP状态码
* @return Response<Any> 指定状态码的响应对象
*/
@JvmStatic
fun code(statusCode: Int) = Response(
time = DateTime.now().format(), message = "操作成功", data = null, statusCode = statusCode
)
/**
* 创建一个指定状态码的响应对象(包含状态码和消息)
* 无数据
*
* @param statusCode HTTP状态码
* @param message 响应消息
* @return Response<Any> 指定状态码和消息的响应对象
*/
@JvmStatic
fun code(statusCode: Int, message: String) = Response(
time = DateTime.now().format(), message = message, data = null, statusCode = statusCode
)
}
/**
* 创建一个指定状态码的响应对象(包含状态码和消息)
* 无数据
*
* @param statusCode HTTP状态码
* @param message 响应消息
* @return Response<Any> 指定状态码和消息的响应对象
*/
@JvmStatic
fun code(statusCode: Int, message: String) = Response(
time = DateTime.now().format(), message = message, data = null, statusCode = statusCode
)
}
/**
* 默认构造函数,创建一个默认的成功响应对象
* 使用当前时间、默认消息"操作成功"、状态码200、无数据
*/
constructor() : this(
time = DateTime.now().format(), message = "操作成功", statusCode = 200, data = null
)
/**
* 默认构造函数,创建一个默认的成功响应对象
* 使用当前时间、默认消息"操作成功"、状态码200、无数据
*/
constructor() : this(
time = DateTime.now().format(), message = "操作成功", statusCode = 200, data = null
)
/**
* 创建一个新的Response对象,使用指定的时间
*
* 该方法用于创建具有新时间的响应对象,遵循不可变对象的设计模式。
* 如果时间相同,则返回原对象避免不必要的对象创建。
*
* @param time 新的响应时间
* @return Response<T> 新的响应对象(如果时间相同则返回原对象)
*/
fun withTime(time: String): Response<T> = if (this.time == time) this else Response(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的时间
*
* 该方法用于创建具有新时间的响应对象,遵循不可变对象的设计模式。
* 如果时间相同,则返回原对象避免不必要的对象创建。
*
* @param time 新的响应时间
* @return 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> 新的响应对象,数据类型为D
*/
fun <D> withData(data: D): Response<D> = Response(this.time, this.message, data, this.statusCode)
/**
* 创建一个新的Response对象,使用指定的数据
*
* 该方法允许改变响应数据的类型,创建一个新的响应对象。
* 适用于需要在保持其他字段不变的情况下更新数据类型的场景。
*
* @param D 新的数据类型
* @param data 新的响应数据
* @return Response<D> 新的响应对象,数据类型为D
*/
fun <D> withData(data: D): Response<D> = Response(this.time, this.message, data, this.statusCode)
/**
* 创建一个新的Response对象,使用指定的消息
*
* 该方法用于创建具有新消息的响应对象,遵循不可变对象的设计模式。
* 如果消息相同,则返回原对象避免不必要的对象创建。
*
* @param message 新的响应消息
* @return Response<T> 新的响应对象(如果消息相同则返回原对象)
*/
fun withMessage(message: String): Response<T> =
if (this.message == message) this else Response(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的消息
*
* 该方法用于创建具有新消息的响应对象,遵循不可变对象的设计模式。
* 如果消息相同,则返回原对象避免不必要的对象创建。
*
* @param message 新的响应消息
* @return Response<T> 新的响应对象(如果消息相同则返回原对象)
*/
fun withMessage(message: String): Response<T> =
if (this.message == message) this else Response(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的状态码
*
* 该方法用于创建具有新状态码的响应对象,遵循不可变对象的设计模式。
* 如果状态码相同,则返回原对象避免不必要的对象创建。
*
* @param statusCode 新的状态码
* @return Response<T> 新的响应对象(如果状态码相同则返回原对象)
*/
fun withStatusCode(statusCode: Int): Response<T> =
if (this.statusCode == statusCode) this else Response(time, message, data, statusCode)
/**
* 创建一个新的Response对象,使用指定的状态码
*
* 该方法用于创建具有新状态码的响应对象,遵循不可变对象的设计模式。
* 如果状态码相同,则返回原对象避免不必要的对象创建。
*
* @param statusCode 新的状态码
* @return Response<T> 新的响应对象(如果状态码相同则返回原对象)
*/
fun withStatusCode(statusCode: Int): Response<T> =
if (this.statusCode == statusCode) this else Response(time, message, data, statusCode)
/**
* 返回响应对象的字符串表示
*
* 重写toString方法以提供更有意义的对象表示,便于日志记录和调试。
* 显示时间、消息、数据类型和值以及状态码。
*
* @return 格式化的字符串表示
*/
override fun toString(): String =
"Response<${data?.javaClass?.simpleName ?: "Nothing"}>(time=${time}, message=${message}, data=${data}, statusCode=${statusCode})"
/**
* 返回响应对象的字符串表示
*
* 重写toString方法以提供更有意义的对象表示,便于日志记录和调试。
* 显示时间、消息、数据类型和值以及状态码。
*
* @return 格式化的字符串表示
*/
override fun toString(): String =
"Response<${data?.javaClass?.simpleName ?: "Nothing"}>(time=${time}, message=${message}, data=${data}, statusCode=${statusCode})"
}
@@ -16,45 +16,285 @@
* ProjectName mingli-utils
* ModuleName mingli-utils.main
* CurrentFile OkHttpUtils.kt
* LastUpdate 2026-10-22 20:20:42
* LastUpdate 2026-11-07 13:44:21
* UpdateUser MingLiPro
*/
@file:JvmName("OkHttpUtils")
package com.mingliqiye.utils.http.okhttp
import com.mingliqiye.utils.http.MediaType
import com.mingliqiye.utils.http.okhttp
import com.mingliqiye.utils.json.api.JSONA
import com.mingliqiye.utils.json.api.base.JsonApi
import com.mingliqiye.utils.json.api.base.JsonApi.Companion.parse
import okhttp3.Call
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response
import okhttp3.*
import okhttp3.HttpUrl.Companion.toHttpUrl
import okhttp3.RequestBody.Companion.toRequestBody
/**
* 将 OkHttp 的 [Response] 响应体解析为指定泛型类型的对象。
*
* 会读取并关闭响应体。未显式传入 [jsonApi] 时使用 [JSONA.jsonApi]。
*
* @param T 目标对象类型,由调用方通过 reified 推断
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 解析后的对象实例
* @throws NullPointerException 未传入 [jsonApi] 且 [JSONA] 尚未注入实例时抛出
*/
inline fun <reified T> Response.json(jsonApi: JsonApi? = null): T = body.use {
if (jsonApi != null) {
return jsonApi.parse<T>(it.bytes())
} else {
JSONA.parse<T>(it.bytes())
}
(jsonApi ?: JSONA.jsonApi).parse<T>(it.bytes())
}
fun Response.text() = body.use {
String(it.bytes())
}
/**
* 读取 [Response] 响应体为字符串,并关闭响应体。
*
* 按响应 `Content-Type` 的 `charset` 解码,缺省 UTF-8;读取后响应体被关闭。
*
* @return 响应体内容字符串
*/
fun Response.text() = this.body.string()
/**
* 创建一个 [Request],通过 [calld] 配置 [Request.Builder]。
*
* @param calld 在 [Request.Builder] 上执行的配置块
* @return 构建完成的 [Request]
*/
fun newRequest(calld: Request.Builder.() -> Unit): Request =
Request.Builder().apply(calld).build()
fun newRequest(calld: Request.Builder.() -> Unit): Request {
val request = Request.Builder()
calld(request)
return request.build()
}
/**
* 使用当前 [OkHttpClient] 创建一个 [Call],请求通过 [calld] 配置。
*
* 调用返回的 [Call] 的 `execute()` 或 `enqueue()` 才会真正发起请求。
*
* @param calld 在 [Request.Builder] 上执行的配置块
* @return 未执行的 [Call]
*/
fun OkHttpClient.newCall(calld: Request.Builder.() -> Unit): Call {
return this.newCall(newRequest(calld))
return this.newCall(newRequest(calld))
}
/**
* 使用当前 [OkHttpClient] 同步执行一次请求,请求通过 [calld] 配置。
*
* 注意:在 Android 主线程调用会抛出 `NetworkOnMainThreadException`。
*
* @param calld 在 [Request.Builder] 上执行的配置块
* @return 同步执行得到的 [Response]
* @throws java.io.IOException 网络或 I/O 失败时抛出
*/
fun OkHttpClient.newExecute(calld: Request.Builder.() -> Unit): Response {
return this.newCall(newRequest(calld)).execute()
return this.newCall(newRequest(calld)).execute()
}
/**
* 在 [Request.Builder] 上设置 URL,并通过 [calld] 配置查询参数。
*
* 示例:
* ```
* Request.Builder().url("https://example.com/api") {
* addQueryParameter("page", "1")
* }
* ```
*
* @param url 基础 URL 字符串
* @param calld 可选的 [HttpUrl.Builder] 配置块(如添加查询参数);为 `null` 时直接使用 [url]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.url(
url: String,
calld: (HttpUrl.Builder.() -> Unit)? = null,
): Request.Builder {
return if (calld != null) {
this.url(url.toHttpUrl().newBuilder().apply { calld() }.build())
} else {
this.url(url.toHttpUrl())
}
}
/**
* 在 [Request.Builder] 上设置请求方法和字节数组请求体。
*
* @param method 请求方法
* @param body 请求体字节数组
* @param mediaType 可选的媒体类型;为 `null` 时不设置 Content-Type
* @param offset 起始偏移量,默认 0
* @param length 读取长度,默认从 [offset] 到 [body] 末尾
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.methodBody(
method: Method,
body: ByteArray,
mediaType: MediaType? = null,
offset: Int = 0,
length: Int = body.size - offset,
): Request.Builder {
require(offset >= 0 && length >= 0 && offset + length <= body.size) {
"offset/length 越界: offset=$offset, length=$length, size=${body.size}"
}
return method(method.name, body.toRequestBody(mediaType?.okhttp(), offset, length))
}
/**
* 在 [Request.Builder] 上设置请求方法,并将对象序列化为 JSON 作为请求体。
*
* @param method 请求方法
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.methodJsonBody(
method: Method,
body: Any,
jsonApi: JsonApi? = null,
): Request.Builder = methodBody(
method,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 GET 方法,并将对象序列化为 JSON 作为请求体。
*
* 注意:GET 请求携带请求体在 HTTP 语义中不常见,部分服务端可能忽略或拒绝。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.getJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.GET,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 POST 方法,并将对象序列化为 JSON 作为请求体。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.postJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.POST,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 PUT 方法,并将对象序列化为 JSON 作为请求体。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.putJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.PUT,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 DELETE 方法,并将对象序列化为 JSON 作为请求体。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.deleteJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.DELETE,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 HEAD 方法,并将对象序列化为 JSON 作为请求体。
*
* 注意:HEAD 请求通常不应携带请求体,部分服务端可能忽略或拒绝。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.headJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.HEAD,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 OPTIONS 方法,并将对象序列化为 JSON 作为请求体。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.optionsJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.OPTIONS,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* 在 [Request.Builder] 上设置 QUERY 方法,并将对象序列化为 JSON 作为请求体。
*
* QUERY 是 HTTP 扩展方法,需服务端支持。
*
* @param body 待序列化的对象
* @param jsonApi 可选的 [JsonApi] 实例;为 `null` 时使用 [JSONA.jsonApi]
* @return 当前 [Request.Builder],便于链式调用
*/
fun Request.Builder.queryJsonBody(
body: Any,
jsonApi: JsonApi? = null,
) = methodBody(
Method.QUERY,
(jsonApi ?: JSONA.jsonApi).formatBytes(body),
MediaType.APPLICATION_JSON,
)
/**
* HTTP 请求方法枚举,供 [Request.Builder.methodBody] 等扩展使用。
*/
enum class Method {
/** GET 方法。 */
GET,
/** POST 方法。 */
POST,
/** PUT 方法。 */
PUT,
/** DELETE 方法。 */
DELETE,
/** HEAD 方法。 */
HEAD,
/** OPTIONS 方法。 */
OPTIONS,
/** QUERY 方法(HTTP 扩展方法,需服务端支持)。 */
QUERY,
}