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
@@ -26,11 +26,20 @@ import org.slf4j.Logger
import org.slf4j.Marker
import org.slf4j.helpers.MessageFormatter
/**
* 简易 SLF4J Logger 实现,将各级别日志直接输出到标准输出流。
* 所有日志级别始终启用,消息格式遵循 SLF4J 的 {} 占位符风格。
*
* @param name 日志器名称,输出时作为标识显示
*/
class MingLiLogger(private val name: String) : Logger {
override fun getName(): String {
return name
}
/**
* 始终返回 true,TRACE 级别日志始终启用。
*/
override fun isTraceEnabled(): Boolean {
return true
}
@@ -67,6 +76,9 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 始终返回 true,忽略 marker 参数。
*/
override fun isTraceEnabled(marker: Marker?): Boolean {
return true
}
@@ -91,6 +103,9 @@ class MingLiLogger(private val name: String) : Logger {
trace(msg, t)
}
/**
* 始终返回 true,DEBUG 级别日志始终启用。
*/
override fun isDebugEnabled(): Boolean {
return true
}
@@ -127,6 +142,9 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 始终返回 true,忽略 marker 参数。
*/
override fun isDebugEnabled(marker: Marker?): Boolean {
return true
}
@@ -151,6 +169,9 @@ class MingLiLogger(private val name: String) : Logger {
debug(msg, t)
}
/**
* 始终返回 true,INFO 级别日志始终启用。
*/
override fun isInfoEnabled(): Boolean {
return true
}
@@ -187,6 +208,9 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 始终返回 true,忽略 marker 参数。
*/
override fun isInfoEnabled(marker: Marker?): Boolean {
return true
}
@@ -211,6 +235,9 @@ class MingLiLogger(private val name: String) : Logger {
info(msg, t)
}
/**
* 始终返回 true,WARN 级别日志始终启用。
*/
override fun isWarnEnabled(): Boolean {
return true
}
@@ -247,6 +274,9 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 始终返回 true,忽略 marker 参数。
*/
override fun isWarnEnabled(marker: Marker?): Boolean {
return true
}
@@ -271,6 +301,9 @@ class MingLiLogger(private val name: String) : Logger {
warn(msg, t)
}
/**
* 始终返回 true,ERROR 级别日志始终启用。
*/
override fun isErrorEnabled(): Boolean {
return true
}
@@ -300,12 +333,18 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 输出 ERROR 级别日志,仅输出消息文本,忽略异常参数。
*/
override fun error(msg: String?, t: Throwable?) {
msg?.let {
toPrintln(it, MingLiLoggerLevel.ERROR)
}
}
/**
* 始终返回 true,忽略 marker 参数。
*/
override fun isErrorEnabled(marker: Marker?): Boolean {
return true
}
@@ -330,6 +369,12 @@ class MingLiLogger(private val name: String) : Logger {
error(msg, t)
}
/**
* 按指定日志级别格式化并输出日志消息。
*
* @param message 日志消息内容
* @param level 日志级别
*/
fun toPrintln(message: String, level: MingLiLoggerLevel) {
when (level) {
MingLiLoggerLevel.TRACE -> wirteToSteam("[TRACE] [$name] $message\n")
@@ -340,6 +385,11 @@ class MingLiLogger(private val name: String) : Logger {
}
}
/**
* 将字符串以字节形式写入标准输出流。
*
* @param string 要输出的字符串
*/
fun wirteToSteam(string: String) {
System.out.write(string.toByteArray())
}
@@ -27,8 +27,15 @@ import org.slf4j.LoggerFactory
import java.lang.reflect.Method
import java.util.*
/**
* 日志器工厂,优先使用 SLF4J 实现(或 mingli-logger 的 Loggers)获取日志器,
* 在没有可用 SLF4J 实现时回退到内置的 MingLiLogger。
*/
class MingLiLoggerFactory {
/**
* 伴生对象,提供获取日志器的静态方法。
*/
companion object {
private var nameMethod: Method? = null
@@ -48,6 +55,12 @@ class MingLiLoggerFactory {
}
/**
* 根据名称获取日志器。
*
* @param name 日志器名称
* @return 对应的 Logger 实例
*/
@JvmStatic
fun getLogger(name: String): Logger {
@@ -60,6 +73,12 @@ class MingLiLoggerFactory {
} else mingLiLoggerFactory.getLogger(name)
}
/**
* 根据类对象获取日志器,日志器名称为类的全限定名。
*
* @param clazz 用于命名日志器的类对象
* @return 对应的 Logger 实例
*/
@JvmStatic
fun getLogger(clazz: Class<*>): Logger {
return if (mingLiLoggerFactory.checkSLF4JImplementation()) {
@@ -71,6 +90,12 @@ class MingLiLoggerFactory {
} else mingLiLoggerFactory.getLogger(clazz)
}
/**
* 通过 reified 类型参数获取日志器,日志器名称为类型 T 的全限定名。
*
* @param T 用于命名日志器的类型
* @return 对应的 Logger 实例
*/
inline fun <reified T> getLogger() = getLogger(T::class.java)
}
@@ -22,10 +22,32 @@
package com.mingliqiye.utils.logger
/**
* 日志级别枚举,定义 MingLiLogger 支持的五个日志级别。
*/
enum class MingLiLoggerLevel {
/**
* 跟踪级别,最详细的调试信息
*/
TRACE,
/**
* 调试级别
*/
DEBUG,
/**
* 信息级别
*/
INFO,
/**
* 警告级别
*/
WARN,
/**
* 错误级别
*/
ERROR
}