docs: 补全 src 全部 Kotlin KDoc 与 Java Javadoc,版本升级至 5.5.1
Gitea Actions Build / Build (push) Canceled after 0s

为所有缺失文档的公开声明补充中文 KDoc/Javadoc(含 exception、json、
springboot、tuple 生成类、MediaType 枚举项及测试),仅插入注释不改代码;
gradle.properties VERSIONS 5.4.4 -> 5.5.1。
This commit is contained in:
2026-11-17 21:07:58 +08:00
parent d0887ea1f7
commit 51eb838a36
148 changed files with 16651 additions and 15 deletions
@@ -22,6 +22,11 @@
package com.mingliqiye.utils.mybatis
/**
* 类型处理器取值时的调用类型枚举。
* 标识当前是从 ResultSet 还是 CallableStatement、以及通过列索引还是列名获取数据,
* 供 [QuickBaseTypeHandler.getValue] 在取值时选择对应的 JDBC 访问方式。
*/
enum class CallType {
/**
* 通过索引访问结果集
@@ -25,4 +25,12 @@ package com.mingliqiye.utils.mybatis
import java.sql.CallableStatement
import java.sql.ResultSet
/**
* 类型处理器的值获取器,封装取值时可用的 JDBC 数据源。
* 根据 [CallType] 的不同,实际使用 [resultSet] 或 [callableStatement] 读取数据,
* 未使用的一方为 null。
*
* @property callableStatement 可调用语句对象,从存储过程输出参数取值时使用,否则为 null
* @property resultSet 结果集对象,从查询结果取值时使用,否则为 null
*/
data class QuickBaseTypeHandlerValueGetter(var callableStatement: CallableStatement?, var resultSet: ResultSet?)
@@ -38,6 +38,9 @@ import java.sql.Types.TIMESTAMP
@MappedTypes(DateTime::class)
class DateTimeTypeHandler : QuickBaseTypeHandler<DateTime>() {
/**
* 从 JDBC 数据源读取 Timestamp 并转换为 [DateTime],数据库值为 null 时返回 null。
*/
override fun getValue(
vg: QuickBaseTypeHandlerValueGetter,
ct: CallType,
@@ -57,6 +60,9 @@ class DateTimeTypeHandler : QuickBaseTypeHandler<DateTime>() {
)
}
/**
* 将 [DateTime] 以 Timestamp 形式写入 PreparedStatement,参数为 null 时写入 TIMESTAMP 类型的 NULL。
*/
override fun setValue(
ps: PreparedStatement,
index: Int,
@@ -32,9 +32,17 @@ import org.apache.ibatis.type.JdbcType
import org.apache.ibatis.type.MappedTypes
import java.sql.PreparedStatement
/**
* MySQL 的 UUID 二进制类型处理器。
* 将 [UUID] 与 MySQL BINARY(16) 列互转,写入前按 MySQL 的字节序重排([uuidToMysql]),
* 读取后再还原为标准 UUID 字节序([mysqlToUuid]),以便 UUID 在数据库中按时间有序存储。
*/
@MappedTypes(UUID::class)
class MysqlUUIDBinaryTypeHandler : QuickBaseTypeHandler<UUID>() {
/**
* 伴生对象,提供 UUID 与 MySQL 二进制字节数组之间的转换工具方法。
*/
companion object {
/**
* 将字节数组转换为UUID对象
@@ -57,6 +65,9 @@ class MysqlUUIDBinaryTypeHandler : QuickBaseTypeHandler<UUID>() {
}
}
/**
* 从 JDBC 数据源读取字节数组,按 MySQL 字节序还原为 [UUID],数据库值为 null 时返回 null。
*/
override fun getValue(
vg: QuickBaseTypeHandlerValueGetter, ct: CallType, ci: Int?, cn: String?,
): UUID? {
@@ -75,6 +86,9 @@ class MysqlUUIDBinaryTypeHandler : QuickBaseTypeHandler<UUID>() {
)
}
/**
* 将 [UUID] 转换为 MySQL 字节序的字节数组写入 PreparedStatement,参数为 null 时写入 BINARY 类型的 NULL。
*/
override fun setValue(
ps: PreparedStatement, index: Int, parameter: UUID?, jdbcType: JdbcType?,
) {
@@ -30,8 +30,16 @@ import org.apache.ibatis.type.JdbcType
import org.apache.ibatis.type.MappedTypes
import java.sql.PreparedStatement
/**
* PostgreSQL 的 UUID 类型处理器。
* 将 [UUID] 与 PostgreSQL 原生 uuid 列互转:读取时以字符串形式取出并解析为 [UUID],
* 写入时通过 setObject 传入 java.util.UUID,由驱动按 uuid 类型处理。
*/
@MappedTypes(UUID::class)
class PgsqlUUIDTypeHandler : QuickBaseTypeHandler<UUID>() {
/**
* 从 JDBC 数据源读取 UUID 字符串并解析为 [UUID],数据库值为 null 时返回 null。
*/
override fun getValue(
vg: QuickBaseTypeHandlerValueGetter, ct: CallType, ci: Int?, cn: String?,
): UUID? {
@@ -51,6 +59,9 @@ class PgsqlUUIDTypeHandler : QuickBaseTypeHandler<UUID>() {
return UUID.of(data)
}
/**
* 将 [UUID] 以 java.util.UUID 对象写入 PreparedStatement,参数为 null 时按指定 JDBC 类型(默认 JAVA_OBJECT)写入 NULL。
*/
override fun setValue(
ps: PreparedStatement, index: Int, parameter: UUID?, jdbcType: JdbcType?,
) {