docs: 补全 src 全部 Kotlin KDoc 与 Java Javadoc,版本升级至 5.5.1
Gitea Actions Build / Build (push) Canceled after 0s
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:
@@ -34,22 +34,48 @@ import tools.jackson.databind.node.JsonNodeType
|
||||
import tools.jackson.databind.node.ObjectNode
|
||||
import java.lang.reflect.Type
|
||||
|
||||
/**
|
||||
* 基于Jackson3的JSON处理实现类,提供JSON字符串解析、格式化、合并、节点操作等功能。
|
||||
*
|
||||
* 节点路径操作([getNodeValue]、[updateNodeValue])使用JSON Pointer风格路径(如"/user/name")。
|
||||
* ObjectMapper支持直接持有,也支持通过get/set回调间接访问外部实例。
|
||||
*/
|
||||
class Jackson3JsonApi : JsonApi {
|
||||
|
||||
/**
|
||||
* ObjectMapper的获取回调,默认返回内部持有的实例
|
||||
*/
|
||||
var get: () -> ObjectMapper = { _prObjectMapper!! }
|
||||
/**
|
||||
* ObjectMapper的设置回调,默认写入内部持有的实例
|
||||
*/
|
||||
var set: (ObjectMapper) -> Unit = { _prObjectMapper = it }
|
||||
|
||||
private var _prObjectMapper: ObjectMapper? = null
|
||||
|
||||
|
||||
/**
|
||||
* 当前使用的ObjectMapper实例,读写均通过[get]/[set]回调转发
|
||||
*/
|
||||
var objectMapper: ObjectMapper
|
||||
get() = get()
|
||||
private set(value) = set(value)
|
||||
|
||||
/**
|
||||
* 使用指定的ObjectMapper构造实例
|
||||
*
|
||||
* @param objectMapper 自定义的ObjectMapper实例
|
||||
*/
|
||||
constructor(objectMapper: ObjectMapper) {
|
||||
_prObjectMapper = objectMapper
|
||||
}
|
||||
|
||||
/**
|
||||
* 使用获取/设置回调构造实例,ObjectMapper由外部管理
|
||||
*
|
||||
* @param get ObjectMapper的获取回调
|
||||
* @param set ObjectMapper的设置回调
|
||||
*/
|
||||
constructor(
|
||||
get: () -> ObjectMapper,
|
||||
set: (ObjectMapper) -> Unit,
|
||||
@@ -58,6 +84,9 @@ class Jackson3JsonApi : JsonApi {
|
||||
this.set = set
|
||||
}
|
||||
|
||||
/**
|
||||
* 使用默认的ObjectMapper构造实例
|
||||
*/
|
||||
constructor() {
|
||||
_prObjectMapper = ObjectMapper()
|
||||
}
|
||||
@@ -105,6 +134,9 @@ class Jackson3JsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 合并多个JSON对象字符串;无参数时返回"{}",遇到非对象JSON时抛出JsonException
|
||||
*/
|
||||
override fun merge(vararg jsons: String): String {
|
||||
try {
|
||||
if (jsons.isEmpty()) return "{}"
|
||||
@@ -126,6 +158,9 @@ class Jackson3JsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取指定路径的节点值,路径为JSON Pointer风格(如"/user/name"),节点缺失或为null时返回null
|
||||
*/
|
||||
override fun getNodeValue(json: String, path: String): String? {
|
||||
try {
|
||||
val rootNode = objectMapper.readTree(json)
|
||||
@@ -141,6 +176,9 @@ class Jackson3JsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 更新指定路径的节点值,路径为JSON Pointer风格(如"/user/name"),空路径时替换整个根节点
|
||||
*/
|
||||
override fun updateNodeValue(json: String, path: String, newValue: Any): String {
|
||||
try {
|
||||
val rootNode = objectMapper.readTree(json)
|
||||
@@ -212,6 +250,9 @@ class Jackson3JsonApi : JsonApi {
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 将JSON字符串解析为JsonItem对象,解析失败时包装为JsonException抛出
|
||||
*/
|
||||
override fun parseJsonItem(json: String): JsonItem {
|
||||
try {
|
||||
return getJsonItem(objectMapper.readTree(json))
|
||||
@@ -222,8 +263,21 @@ class Jackson3JsonApi : JsonApi {
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 基于Jackson3的JsonItem标记实现类,通过伴生对象工厂方法创建具体的JsonItem
|
||||
*/
|
||||
class JackSon3JsonItem : JsonItem {
|
||||
/**
|
||||
* 伴生对象,提供JsonNode到JsonItem的工厂方法
|
||||
*/
|
||||
companion object {
|
||||
/**
|
||||
* 根据JsonNode的节点类型创建对应的JsonItem实例
|
||||
*
|
||||
* @param node Jackson3的JsonNode节点
|
||||
* @return 与节点类型对应的JsonItem实例
|
||||
* @throws IllegalStateException 当节点类型未知时抛出
|
||||
*/
|
||||
fun getJsonItem(node: JsonNode): JsonItem {
|
||||
return when (node.nodeType) {
|
||||
JsonNodeType.OBJECT -> JackSon3JsonObject(node)
|
||||
@@ -238,11 +292,31 @@ class JackSon3JsonItem : JsonItem {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 基于Jackson3节点的JSON数字类型
|
||||
*
|
||||
* @param node 数字类型的JsonNode节点
|
||||
*/
|
||||
class JackSon3JsonNumber(node: JsonNode) : JsonNumber(node.asString())
|
||||
/**
|
||||
* 基于Jackson3节点的JSON布尔类型
|
||||
*
|
||||
* @param node 布尔类型的JsonNode节点
|
||||
*/
|
||||
class JackSon3JsonBoolean(node: JsonNode) : JsonBoolean(node.asBoolean())
|
||||
/**
|
||||
* 基于Jackson3节点的JSON字符串类型
|
||||
*
|
||||
* @param node 字符串类型的JsonNode节点
|
||||
*/
|
||||
class JackSon3JsonString(node: JsonNode) : JsonString(node.asString())
|
||||
|
||||
|
||||
/**
|
||||
* 基于Jackson3节点的JSON数组类型
|
||||
*
|
||||
* @property node 数组类型的JsonNode节点
|
||||
*/
|
||||
class JackSon3JsonArray(val node: JsonNode) : JsonArray() {
|
||||
override fun getIndex(index: Int): JsonItem {
|
||||
return JackSon3JsonItem.getJsonItem(node.get(index))
|
||||
@@ -264,6 +338,11 @@ class JackSon3JsonArray(val node: JsonNode) : JsonArray() {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 基于Jackson3节点的JSON对象类型
|
||||
*
|
||||
* @property node 对象类型的JsonNode节点
|
||||
*/
|
||||
class JackSon3JsonObject(val node: JsonNode) : JsonObject() {
|
||||
override fun getField(name: String): JsonItem {
|
||||
return JackSon3JsonItem.getJsonItem(node.get(name))
|
||||
|
||||
@@ -49,6 +49,11 @@ class JacksonJsonApi : JsonApi {
|
||||
this.objectMapper = ObjectMapper()
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取内部使用的ObjectMapper实例
|
||||
*
|
||||
* @return 当前的ObjectMapper实例
|
||||
*/
|
||||
fun getObjectMapper() = objectMapper
|
||||
|
||||
/**
|
||||
@@ -113,6 +118,13 @@ class JacksonJsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON字符串,非ASCII字符以Unicode转义形式输出
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @return 格式化后的JSON字符串
|
||||
* @throws JsonException 当格式化失败时抛出异常
|
||||
*/
|
||||
fun formatUnicode(obj: Any): String {
|
||||
return try {
|
||||
objectMapper.writer().with(JsonGenerator.Feature.ESCAPE_NON_ASCII).writeValueAsString(obj)
|
||||
@@ -137,6 +149,13 @@ class JacksonJsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化(带缩进)的JSON字符串,非ASCII字符以Unicode转义形式输出
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @return 美化后的JSON字符串
|
||||
* @throws JsonException 当格式化失败时抛出异常
|
||||
*/
|
||||
fun formatPrettyUnicode(obj: Any): String {
|
||||
return try {
|
||||
objectMapper.writerWithDefaultPrettyPrinter().with(JsonGenerator.Feature.ESCAPE_NON_ASCII)
|
||||
@@ -287,6 +306,9 @@ class JacksonJsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 将JSON字符串解析为JsonItem对象,解析失败时包装为JsonException抛出
|
||||
*/
|
||||
override fun parseJsonItem(json: String): JsonItem {
|
||||
try {
|
||||
return getJsonItem(objectMapper.readTree(json))
|
||||
@@ -296,8 +318,21 @@ class JacksonJsonApi : JsonApi {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 基于Jackson2的JsonItem标记实现类,通过伴生对象工厂方法创建具体的JsonItem
|
||||
*/
|
||||
class JackSonJsonItem : JsonItem {
|
||||
/**
|
||||
* 伴生对象,提供JsonNode到JsonItem的工厂方法
|
||||
*/
|
||||
companion object {
|
||||
/**
|
||||
* 根据JsonNode的节点类型创建对应的JsonItem实例
|
||||
*
|
||||
* @param node Jackson2的JsonNode节点
|
||||
* @return 与节点类型对应的JsonItem实例
|
||||
* @throws IllegalStateException 当节点类型未知时抛出
|
||||
*/
|
||||
fun getJsonItem(node: JsonNode): JsonItem {
|
||||
return when (node.nodeType) {
|
||||
JsonNodeType.OBJECT -> JackSonJsonObject(node)
|
||||
@@ -312,11 +347,31 @@ class JackSonJsonItem : JsonItem {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 基于Jackson2节点的JSON数字类型
|
||||
*
|
||||
* @param node 数字类型的JsonNode节点
|
||||
*/
|
||||
class JackSonJsonNumber(node: JsonNode) : JsonNumber(node.asText())
|
||||
/**
|
||||
* 基于Jackson2节点的JSON布尔类型
|
||||
*
|
||||
* @param node 布尔类型的JsonNode节点
|
||||
*/
|
||||
class JackSonJsonBoolean(node: JsonNode) : JsonBoolean(node.asBoolean())
|
||||
/**
|
||||
* 基于Jackson2节点的JSON字符串类型
|
||||
*
|
||||
* @param node 字符串类型的JsonNode节点
|
||||
*/
|
||||
class JackSonJsonString(node: JsonNode) : JsonString(node.asText())
|
||||
|
||||
|
||||
/**
|
||||
* 基于Jackson2节点的JSON数组类型
|
||||
*
|
||||
* @property node 数组类型的JsonNode节点
|
||||
*/
|
||||
class JackSonJsonArray(val node: JsonNode) : JsonArray() {
|
||||
override fun getIndex(index: Int): JsonItem {
|
||||
return getJsonItem(node.get(index))
|
||||
@@ -338,6 +393,11 @@ class JackSonJsonArray(val node: JsonNode) : JsonArray() {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 基于Jackson2节点的JSON对象类型
|
||||
*
|
||||
* @property node 对象类型的JsonNode节点
|
||||
*/
|
||||
class JackSonJsonObject(val node: JsonNode) : JsonObject() {
|
||||
override fun getField(name: String): JsonItem {
|
||||
return getJsonItem(node.get(name))
|
||||
|
||||
@@ -38,6 +38,9 @@ import kotlin.io.path.readBytes
|
||||
*/
|
||||
interface JsonApi {
|
||||
|
||||
/**
|
||||
* 伴生对象,提供基于 reified 泛型参数的便捷解析与转换扩展函数
|
||||
*/
|
||||
companion object {
|
||||
/**
|
||||
* 将JSON字符串解析为指定泛型类型对象
|
||||
@@ -342,46 +345,106 @@ interface JsonApi {
|
||||
*/
|
||||
fun formatPretty(obj: Any): String
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化格式的JSON字节数组
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @return 格式化后的美化JSON字节数组
|
||||
*/
|
||||
fun formatPrettyBytes(obj: Any): ByteArray {
|
||||
return formatPretty(obj)!!.toByteArray()
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化JSON并写入指定路径的文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件路径
|
||||
*/
|
||||
fun formatPretty(obj: Any, file: String) {
|
||||
formatPretty(obj, Paths.get(file))
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化JSON并写入指定路径的文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件路径对象
|
||||
*/
|
||||
fun formatPretty(obj: Any, file: Path) {
|
||||
formatPretty(obj, file.toFile())
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化JSON并写入指定文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件对象
|
||||
*/
|
||||
fun formatPretty(obj: Any, file: File) {
|
||||
FileOutputStream(file).use { fos ->
|
||||
formatPretty(obj, fos)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为美化JSON并写入输出流
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param stream 目标输出流
|
||||
*/
|
||||
fun formatPretty(obj: Any, stream: OutputStream) {
|
||||
stream.write(formatPrettyBytes(obj))
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON字节数组
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @return 格式化后的JSON字节数组
|
||||
*/
|
||||
fun formatBytes(obj: Any): ByteArray {
|
||||
return format(obj).toByteArray()
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON并写入指定路径的文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件路径
|
||||
*/
|
||||
fun format(obj: Any, file: String) {
|
||||
format(obj, Paths.get(file))
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON并写入指定路径的文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件路径对象
|
||||
*/
|
||||
fun format(obj: Any, file: Path) {
|
||||
format(obj, file.toFile())
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON并写入指定文件
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param file 目标文件对象
|
||||
*/
|
||||
fun format(obj: Any, file: File) {
|
||||
FileOutputStream(file).use { fos ->
|
||||
format(obj, fos)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 将对象格式化为JSON并写入输出流
|
||||
*
|
||||
* @param obj 待格式化的对象
|
||||
* @param stream 目标输出流
|
||||
*/
|
||||
fun format(obj: Any, stream: OutputStream) {
|
||||
stream.write(formatPrettyBytes(obj))
|
||||
}
|
||||
|
||||
@@ -34,6 +34,9 @@ import java.util.*
|
||||
*/
|
||||
abstract class JsonTypeReference<T> : Comparable<JsonTypeReference<T>> {
|
||||
|
||||
/**
|
||||
* 当前引用的类型信息,子类可覆写以自定义类型
|
||||
*/
|
||||
open var type: Type = Any::class.java
|
||||
|
||||
/**
|
||||
@@ -68,6 +71,12 @@ abstract class JsonTypeReference<T> : Comparable<JsonTypeReference<T>> {
|
||||
* @return 类型引用实例
|
||||
*/
|
||||
companion object {
|
||||
/**
|
||||
* 根据 reified 泛型参数创建类型引用
|
||||
*
|
||||
* @param <T> 目标类型
|
||||
* @return 类型引用实例
|
||||
*/
|
||||
inline fun <reified T> of(): JsonTypeReference<T> {
|
||||
return object : JsonTypeReference<T>() {}
|
||||
}
|
||||
|
||||
@@ -27,6 +27,12 @@ import java.lang.reflect.ParameterizedType
|
||||
import java.lang.reflect.Type
|
||||
import java.lang.reflect.WildcardType
|
||||
|
||||
/**
|
||||
* 参数化类型的简单实现,用于在运行时构造并描述带泛型参数的类型
|
||||
*
|
||||
* @property rawClass 原始类型(如 List::class.java)
|
||||
* @param paramType 泛型参数类型列表
|
||||
*/
|
||||
class TypeReference(
|
||||
val rawClass: Type,
|
||||
vararg paramType: Type,
|
||||
@@ -40,12 +46,24 @@ class TypeReference(
|
||||
override fun getOwnerType(): Type? = null
|
||||
|
||||
|
||||
/**
|
||||
* 返回"原始类型<参数1,参数2>"形式的类型描述字符串
|
||||
*/
|
||||
override fun toString(): String = "${getRawString(rawClass)}<${
|
||||
",".join(typeArguments) { getRawString(it) }
|
||||
}>"
|
||||
|
||||
/**
|
||||
* 伴生对象,提供类型描述与TypeReference的工厂方法
|
||||
*/
|
||||
companion object {
|
||||
|
||||
/**
|
||||
* 获取类型的完整描述字符串,支持通配符与参数化类型
|
||||
*
|
||||
* @param type 类型对象
|
||||
* @return 类型的描述字符串
|
||||
*/
|
||||
fun getRawString(type: Type): String {
|
||||
return when (type) {
|
||||
is Class<*> -> type.name
|
||||
@@ -73,10 +91,23 @@ class TypeReference(
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据 reified 泛型参数创建TypeReference
|
||||
*
|
||||
* @param <T> 目标类型
|
||||
* @return TypeReference实例
|
||||
*/
|
||||
inline fun <reified T> of(): TypeReference {
|
||||
return of((object : JsonTypeReference<T>() {}).type)
|
||||
}
|
||||
|
||||
/**
|
||||
* 将任意Type转换为TypeReference
|
||||
*
|
||||
* @param type 类型对象,支持Class、ParameterizedType和WildcardType
|
||||
* @return TypeReference实例
|
||||
* @throws IllegalStateException 当类型无法识别时抛出
|
||||
*/
|
||||
fun of(type: Type): TypeReference {
|
||||
return when (type) {
|
||||
is Class<*> -> TypeReference(type)
|
||||
|
||||
@@ -33,7 +33,16 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonWriter
|
||||
import com.mingliqiye.utils.time.DateTime
|
||||
import com.mingliqiye.utils.time.Formatter
|
||||
|
||||
/**
|
||||
* [DateTime] 的 JSON 字符串转换器。
|
||||
*
|
||||
* 根据字段上的 [DateTimeJsonFormat] 注解选择格式化器,
|
||||
* 在日期时间对象与 JSON 字符串之间进行双向转换。
|
||||
*/
|
||||
class DateTimeJsonConverter : BaseJsonConverter<DateTime> {
|
||||
/**
|
||||
* 按 [DateTimeJsonFormat] 注解指定的格式将日期时间写为 JSON 字符串,null 时写入 null
|
||||
*/
|
||||
@Throws(Exception::class)
|
||||
override fun convert(
|
||||
obj: DateTime?,
|
||||
@@ -56,6 +65,11 @@ class DateTimeJsonConverter : BaseJsonConverter<DateTime> {
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 按 [DateTimeJsonFormat] 注解指定的格式从 JSON 字符串解析日期时间
|
||||
*
|
||||
* @throws JsonParseException 当节点不是字符串类型时抛出
|
||||
*/
|
||||
override fun deConvert(jsonReader: BaseJsonReader, annotationGetter: AnnotationGetter): DateTime? {
|
||||
val dateTimeJsonFormat: DateTimeJsonFormat? = annotationGetter.getAnnotation<DateTimeJsonFormat>()
|
||||
if (jsonReader.isNull) return null
|
||||
|
||||
@@ -44,6 +44,9 @@ import com.mingliqiye.utils.network.NetworkEndpoint
|
||||
* @see NetworkEndpoint
|
||||
*/
|
||||
class NetworkEndpointJsonConverter : BaseJsonConverter<NetworkEndpoint> {
|
||||
/**
|
||||
* 将网络端点写为 `host:port` 形式的 JSON 字符串,null 时写入 null
|
||||
*/
|
||||
override fun convert(
|
||||
obj: NetworkEndpoint?,
|
||||
jsonWriter: BaseJsonWriter,
|
||||
@@ -52,6 +55,11 @@ class NetworkEndpointJsonConverter : BaseJsonConverter<NetworkEndpoint> {
|
||||
if (obj == null) jsonWriter.setNull() else jsonWriter.setString(obj.toHostPortString())
|
||||
}
|
||||
|
||||
/**
|
||||
* 从 `host:port` 形式的 JSON 字符串还原网络端点
|
||||
*
|
||||
* @throws JsonParseException 当节点不是字符串类型时抛出
|
||||
*/
|
||||
override fun deConvert(
|
||||
jsonReader: BaseJsonReader,
|
||||
annotationGetter: AnnotationGetter,
|
||||
|
||||
@@ -34,8 +34,17 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonWriter
|
||||
import com.mingliqiye.utils.uuid.UUID
|
||||
import com.mingliqiye.utils.uuid.UUIDFormatType
|
||||
|
||||
/**
|
||||
* [UUID] 的 JSON 字符串转换器。
|
||||
*
|
||||
* 根据字段上的 [UUIDJsonFormat] 注解选择进制与格式,
|
||||
* 在 UUID 对象与 JSON 字符串之间进行双向转换。
|
||||
*/
|
||||
class UUIDJsonConverter : BaseJsonConverter<UUID> {
|
||||
|
||||
/**
|
||||
* 按 [UUIDJsonFormat] 注解指定的进制与格式将 UUID 写为 JSON 字符串,null 时写入 null
|
||||
*/
|
||||
override fun convert(
|
||||
obj: UUID?,
|
||||
jsonWriter: BaseJsonWriter,
|
||||
@@ -60,6 +69,11 @@ class UUIDJsonConverter : BaseJsonConverter<UUID> {
|
||||
jsonWriter.setString(uuid)
|
||||
}
|
||||
|
||||
/**
|
||||
* 按 [UUIDJsonFormat] 注解指定的进制从 JSON 字符串解析 UUID
|
||||
*
|
||||
* @throws JsonParseException 当节点不是字符串类型时抛出
|
||||
*/
|
||||
override fun deConvert(
|
||||
jsonReader: BaseJsonReader,
|
||||
annotationGetter: AnnotationGetter,
|
||||
|
||||
@@ -22,6 +22,15 @@
|
||||
|
||||
package com.mingliqiye.utils.json.converters.base
|
||||
|
||||
/**
|
||||
* 注解获取接口,用于在自定义序列化/反序列化时读取字段上的注解
|
||||
*/
|
||||
interface AnnotationGetter {
|
||||
/**
|
||||
* 获取指定类型的注解
|
||||
*
|
||||
* @param clazz 注解的Class类型
|
||||
* @return 注解实例,不存在时返回null(默认实现始终返回null)
|
||||
*/
|
||||
fun <T : Annotation> getAnnotation(clazz: Class<T>): T? = null
|
||||
}
|
||||
|
||||
@@ -34,15 +34,42 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonWriter
|
||||
*/
|
||||
interface BaseJsonConverter<T> {
|
||||
|
||||
/**
|
||||
* 序列化:将对象转换并写入 JSON
|
||||
*
|
||||
* @param obj 待写入的对象,可能为null
|
||||
* @param jsonWriter JSON写入器
|
||||
* @param annotationGetter 注解获取器,用于读取字段上的格式注解
|
||||
* @throws Exception 当写入失败时抛出
|
||||
*/
|
||||
@Throws(Exception::class)
|
||||
fun convert(obj: T?, jsonWriter: BaseJsonWriter, annotationGetter: AnnotationGetter)
|
||||
|
||||
/**
|
||||
* 反序列化:从 JSON 读取并还原对象
|
||||
*
|
||||
* @param jsonReader JSON读取器
|
||||
* @param annotationGetter 注解获取器,用于读取字段上的格式注解
|
||||
* @return 还原后的对象,JSON为null时返回null
|
||||
* @throws Exception 当读取失败时抛出
|
||||
*/
|
||||
@Throws(Exception::class)
|
||||
fun deConvert(jsonReader: BaseJsonReader, annotationGetter: AnnotationGetter): T?
|
||||
|
||||
/**
|
||||
* 获取本转换器处理的目标类型引用
|
||||
*
|
||||
* @return 目标类型的JsonTypeReference
|
||||
* @throws Exception 当获取类型失败时抛出
|
||||
*/
|
||||
@Throws(Exception::class)
|
||||
fun getType(): JsonTypeReference<T>
|
||||
|
||||
/**
|
||||
* 获取本转换器处理的目标类型的原始Class
|
||||
*
|
||||
* @return 目标类型的Class对象
|
||||
*/
|
||||
@Throws(Exception::class)
|
||||
fun getClazz() = getType().getRawType()
|
||||
}
|
||||
|
||||
@@ -29,16 +29,32 @@ import tools.jackson.databind.DeserializationContext
|
||||
import tools.jackson.databind.ValueDeserializer
|
||||
|
||||
|
||||
/**
|
||||
* Jackson3 反序列化适配器,将 [BaseJsonConverter] 包装为 Jackson3 的 [ValueDeserializer]。
|
||||
*
|
||||
* @property property 当前属性信息,用于读取字段注解,可为null
|
||||
* @property jsonConverter 实际执行反序列化逻辑的转换器
|
||||
*/
|
||||
class JackJson3Deserializer<T>(
|
||||
val property: BeanProperty? = null,
|
||||
val jsonConverter: BaseJsonConverter<T>,
|
||||
) : ValueDeserializer<T>() {
|
||||
|
||||
/**
|
||||
* 注解获取器,从当前属性信息中读取字段注解
|
||||
*/
|
||||
val annotationGetter =
|
||||
object : AnnotationGetter {
|
||||
override fun <T : Annotation> getAnnotation(clazz: Class<T>): T? = property?.getAnnotation(clazz)
|
||||
}
|
||||
|
||||
/**
|
||||
* 反序列化方法:将 JSON 树交给转换器还原为目标对象。
|
||||
*
|
||||
* @param p JSON 解析器。
|
||||
* @param ctxt 反序列化上下文,可选参数。
|
||||
* @return 还原后的对象,可能为null。
|
||||
*/
|
||||
override fun deserialize(
|
||||
p: JsonParser,
|
||||
ctxt: DeserializationContext?,
|
||||
|
||||
@@ -29,20 +29,43 @@ import tools.jackson.databind.SerializationContext
|
||||
import tools.jackson.databind.ValueSerializer
|
||||
|
||||
|
||||
/**
|
||||
* Jackson3 序列化适配器,将 [BaseJsonConverter] 包装为 Jackson3 的 [ValueSerializer]。
|
||||
*
|
||||
* @property property 当前属性信息,用于读取字段注解,可为null
|
||||
* @property jsonConverter 实际执行序列化逻辑的转换器
|
||||
*/
|
||||
class JackJson3Serializer<T>(
|
||||
val property: BeanProperty? = null,
|
||||
val jsonConverter: BaseJsonConverter<T>,
|
||||
) : ValueSerializer<T>() {
|
||||
|
||||
/**
|
||||
* 注解获取器,从当前属性信息中读取字段注解
|
||||
*/
|
||||
val annotationGetter =
|
||||
object : AnnotationGetter {
|
||||
override fun <T : Annotation> getAnnotation(clazz: Class<T>): T? = property?.getAnnotation(clazz)
|
||||
}
|
||||
|
||||
/**
|
||||
* 序列化方法:将源对象交给转换器写入 JSON。
|
||||
*
|
||||
* @param value 源对象。
|
||||
* @param gen JSON 生成器,用于写入 JSON 数据。
|
||||
* @param ctxt 序列化上下文。
|
||||
*/
|
||||
override fun serialize(value: T, gen: JsonGenerator, ctxt: SerializationContext) {
|
||||
jsonConverter.convert(value, JackSon3JsonWriter(gen, ctxt), annotationGetter)
|
||||
}
|
||||
|
||||
/**
|
||||
* 上下文感知方法:设置当前属性信息。
|
||||
*
|
||||
* @param ctxt 序列化上下文,可选参数。
|
||||
* @param property 当前属性信息。
|
||||
* @return 携带属性信息的新序列化器实例。
|
||||
*/
|
||||
override fun createContextual(ctxt: SerializationContext?, property: BeanProperty?): ValueSerializer<*> {
|
||||
return JackJson3Serializer(property, jsonConverter)
|
||||
}
|
||||
|
||||
@@ -29,17 +29,33 @@ import com.fasterxml.jackson.databind.JsonDeserializer
|
||||
import com.fasterxml.jackson.databind.deser.ContextualDeserializer
|
||||
import com.mingliqiye.utils.json.reader.JackSonJsonReader
|
||||
|
||||
/**
|
||||
* Jackson2 反序列化适配器,将 [BaseJsonConverter] 包装为 Jackson2 的 [JsonDeserializer]。
|
||||
*
|
||||
* @property property 当前属性信息,用于读取字段注解,可为null
|
||||
* @property jsonConverter 实际执行反序列化逻辑的转换器
|
||||
*/
|
||||
class JackJsonDeserializer<T>(
|
||||
val property: BeanProperty? = null,
|
||||
val jsonConverter: BaseJsonConverter<T>,
|
||||
) : JsonDeserializer<T>(), ContextualDeserializer {
|
||||
|
||||
|
||||
/**
|
||||
* 注解获取器,从当前属性信息中读取字段注解
|
||||
*/
|
||||
val annotationGetter =
|
||||
object : AnnotationGetter {
|
||||
override fun <T : Annotation> getAnnotation(clazz: Class<T>): T? = property?.getAnnotation(clazz)
|
||||
}
|
||||
|
||||
/**
|
||||
* 反序列化方法:将 JSON 树交给转换器还原为目标对象。
|
||||
*
|
||||
* @param p JSON 解析器。
|
||||
* @param ctxt 反序列化上下文,可选参数。
|
||||
* @return 还原后的对象,可能为null。
|
||||
*/
|
||||
override fun deserialize(
|
||||
p: JsonParser,
|
||||
ctxt: DeserializationContext?,
|
||||
@@ -47,6 +63,13 @@ class JackJsonDeserializer<T>(
|
||||
return jsonConverter.deConvert(JackSonJsonReader(p.readValueAsTree()), annotationGetter)
|
||||
}
|
||||
|
||||
/**
|
||||
* 上下文感知方法:设置当前属性信息。
|
||||
*
|
||||
* @param ctxt 反序列化上下文,可选参数。
|
||||
* @param property 当前属性信息。
|
||||
* @return 携带属性信息的新反序列化器实例。
|
||||
*/
|
||||
override fun createContextual(
|
||||
ctxt: DeserializationContext?,
|
||||
property: BeanProperty?,
|
||||
|
||||
@@ -29,11 +29,20 @@ import com.fasterxml.jackson.databind.SerializerProvider
|
||||
import com.fasterxml.jackson.databind.ser.ContextualSerializer
|
||||
import com.mingliqiye.utils.json.witer.JackSonJsonWriter
|
||||
|
||||
/**
|
||||
* Jackson2 序列化适配器,将 [BaseJsonConverter] 包装为 Jackson2 的 [JsonSerializer]。
|
||||
*
|
||||
* @property property 当前属性信息,用于读取字段注解,可为null
|
||||
* @property jsonConverter 实际执行序列化逻辑的转换器
|
||||
*/
|
||||
class JackJsonSerializer<T>(
|
||||
val property: BeanProperty?,
|
||||
val jsonConverter: BaseJsonConverter<T>,
|
||||
) : JsonSerializer<T>(), ContextualSerializer {
|
||||
|
||||
/**
|
||||
* 注解获取器,从当前属性信息中读取字段注解
|
||||
*/
|
||||
val annotationGetter = object : AnnotationGetter {
|
||||
override fun <T : Annotation> getAnnotation(clazz: Class<T>): T? = property?.getAnnotation(clazz)
|
||||
}
|
||||
|
||||
@@ -32,21 +32,43 @@ import tools.jackson.core.JsonGenerator as JackSon3JsonGenerator
|
||||
import tools.jackson.databind.module.SimpleModule as JackSon3SimpleModule
|
||||
|
||||
|
||||
/**
|
||||
* 将转换器包装为 Jackson2 的 SimpleModule,注册对应的序列化器与反序列化器。
|
||||
*
|
||||
* @return 注册了当前转换器的 Jackson2 模块
|
||||
*/
|
||||
fun <T> BaseJsonConverter<T>.getJacksonModule(): JackSon2SimpleModule =
|
||||
JackSon2SimpleModule("${getClazz().simpleName}Module")
|
||||
.addSerializer(getClazz(), JackJsonSerializer(null, this))
|
||||
.addDeserializer(getClazz(), JackJsonDeserializer(null, this))
|
||||
|
||||
/**
|
||||
* 将转换器包装为 Jackson3 的 SimpleModule,注册对应的序列化器与反序列化器。
|
||||
*
|
||||
* @return 注册了当前转换器的 Jackson3 模块
|
||||
*/
|
||||
fun <T> BaseJsonConverter<T>.getJackson3Module(): JackSon3SimpleModule =
|
||||
JackSon3SimpleModule("${getClazz().simpleName}Module")
|
||||
.addSerializer(getClazz(), JackJson3Serializer(null, this))
|
||||
.addDeserializer(getClazz(), JackJson3Deserializer(null, this))
|
||||
|
||||
|
||||
/**
|
||||
* 根据 reified 泛型参数获取指定类型的注解。
|
||||
*
|
||||
* @param T 注解类型
|
||||
* @return 注解实例,不存在时返回null
|
||||
*/
|
||||
inline fun <reified T : Annotation> AnnotationGetter.getAnnotation(): T? =
|
||||
getAnnotation(T::class.java)
|
||||
|
||||
|
||||
/**
|
||||
* 按数值的实际类型写入 JSON 数字(Jackson3),支持常见数值类型。
|
||||
*
|
||||
* @param value 待写入的数值
|
||||
* @return 当前 JsonGenerator 实例,便于链式调用
|
||||
*/
|
||||
fun JackSon3JsonGenerator.writeNumber(value: Number): JackSon3JsonGenerator {
|
||||
when (value) {
|
||||
is Long -> this.writeNumber(value)
|
||||
@@ -61,6 +83,12 @@ fun JackSon3JsonGenerator.writeNumber(value: Number): JackSon3JsonGenerator {
|
||||
return this
|
||||
}
|
||||
|
||||
/**
|
||||
* 按数值的实际类型写入 JSON 数字(Jackson2),支持常见数值类型。
|
||||
*
|
||||
* @param value 待写入的数值
|
||||
* @return 当前 JsonGenerator 实例,便于链式调用
|
||||
*/
|
||||
fun JackSon2JsonGenerator.writeNumber(value: Number): JackSon2JsonGenerator {
|
||||
when (value) {
|
||||
is Long -> this.writeNumber(value)
|
||||
|
||||
@@ -25,6 +25,11 @@ package com.mingliqiye.utils.json.judgment
|
||||
import com.mingliqiye.utils.json.judgment.base.BaseJsonJudgment
|
||||
import tools.jackson.databind.JsonNode
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonNode 的类型判断实现,各判定属性直接委托给节点自身
|
||||
*
|
||||
* @param treeNode 待判断的 Jackson3 JsonNode 节点
|
||||
*/
|
||||
open class JackSon3ReaderJudgment(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonJudgment {
|
||||
|
||||
@@ -25,6 +25,11 @@ package com.mingliqiye.utils.json.judgment
|
||||
import com.fasterxml.jackson.databind.JsonNode
|
||||
import com.mingliqiye.utils.json.judgment.base.BaseJsonJudgment
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonNode 的类型判断实现,各判定属性直接委托给节点自身
|
||||
*
|
||||
* @param treeNode 待判断的 Jackson2 JsonNode 节点
|
||||
*/
|
||||
open class JackSonReaderJudgment(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonJudgment {
|
||||
|
||||
@@ -22,20 +22,30 @@
|
||||
|
||||
package com.mingliqiye.utils.json.judgment.base
|
||||
|
||||
/**
|
||||
* JSON 节点类型判断接口,提供当前节点的类型判定属性,默认实现均返回 false
|
||||
*/
|
||||
interface BaseJsonJudgment {
|
||||
/** 当前节点是否为 JSON 对象 */
|
||||
val isObject: Boolean
|
||||
get() = false
|
||||
/** 当前节点是否为 JSON 数组 */
|
||||
val isArray: Boolean
|
||||
get() = false
|
||||
/** 当前节点是否为字符串 */
|
||||
val isString: Boolean
|
||||
get() = false
|
||||
/** 当前节点是否为数字 */
|
||||
val isNumber: Boolean
|
||||
get() = false
|
||||
/** 当前节点是否为布尔值 */
|
||||
val isBoolean: Boolean
|
||||
get() = false
|
||||
|
||||
/** 当前节点是否为 null */
|
||||
val isNull: Boolean
|
||||
get() = false
|
||||
/** 当前节点是否不为 null */
|
||||
val isNotNull: Boolean
|
||||
get() = !isNull
|
||||
}
|
||||
|
||||
@@ -29,6 +29,11 @@ import tools.jackson.databind.JsonNode
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonNode 的 JSON 数组读取器实现,按索引读取各类型值
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson3 JsonNode 数组节点
|
||||
*/
|
||||
class JackSon3JsonArrayReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonArrayReader, JackSon3ReaderJudgment(treeNode) {
|
||||
|
||||
@@ -29,6 +29,11 @@ import tools.jackson.databind.JsonNode
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonNode 的 JSON 对象读取器实现,按字段名读取各类型值
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson3 JsonNode 对象节点
|
||||
*/
|
||||
class JackSon3JsonObjectReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonObjectReader, JackSon3ReaderJudgment(treeNode) {
|
||||
|
||||
@@ -30,6 +30,11 @@ import tools.jackson.databind.JsonNode
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonNode 的 JSON 读取器实现,将节点值读取为各种类型
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson3 JsonNode 节点
|
||||
*/
|
||||
class JackSon3JsonReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonReader, JackSon3ReaderJudgment(treeNode) {
|
||||
|
||||
@@ -29,6 +29,11 @@ import com.mingliqiye.utils.json.reader.base.BaseJsonObjectReader
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonNode 的 JSON 数组读取器实现,按索引读取各类型值
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson2 JsonNode 数组节点
|
||||
*/
|
||||
class JackSonJsonArrayReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonArrayReader, JackSonReaderJudgment(treeNode) {
|
||||
|
||||
@@ -29,6 +29,11 @@ import com.mingliqiye.utils.json.reader.base.BaseJsonObjectReader
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonNode 的 JSON 对象读取器实现,按字段名读取各类型值
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson2 JsonNode 对象节点
|
||||
*/
|
||||
class JackSonJsonObjectReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonObjectReader, JackSonReaderJudgment(treeNode) {
|
||||
|
||||
@@ -30,6 +30,11 @@ import com.mingliqiye.utils.json.reader.base.BaseJsonReader
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonNode 的 JSON 读取器实现,将节点值读取为各种类型
|
||||
*
|
||||
* @param treeNode 待读取的 Jackson2 JsonNode 节点
|
||||
*/
|
||||
class JackSonJsonReader(
|
||||
private val treeNode: JsonNode,
|
||||
) : BaseJsonReader, JackSonReaderJudgment(treeNode) {
|
||||
|
||||
@@ -26,53 +26,142 @@ import com.mingliqiye.utils.exception.JsonParserException
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* JSON 数组读取器接口,按索引读取数组中的各类型值。
|
||||
*
|
||||
* 直接读取当前节点的 getXxx 方法默认抛出 [JsonParserException],应使用 getIndexXxx 系列方法。
|
||||
*/
|
||||
interface BaseJsonArrayReader : BaseJsonReader {
|
||||
/** 数组读取器不支持直接读取为对象,调用时抛出 [JsonParserException] */
|
||||
override fun getObject(): BaseJsonObjectReader =
|
||||
throw JsonParserException("not supported getObject on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为数组,调用时抛出 [JsonParserException] */
|
||||
override fun getArray(): BaseJsonArrayReader =
|
||||
throw JsonParserException("not supported getArray on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为字符串,调用时抛出 [JsonParserException] */
|
||||
override fun getString(): String =
|
||||
throw JsonParserException("not supported getString on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为布尔值,调用时抛出 [JsonParserException] */
|
||||
override fun getBoolean(): Boolean =
|
||||
throw JsonParserException("not supported getBoolean on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Byte,调用时抛出 [JsonParserException] */
|
||||
override fun getByte(): Byte =
|
||||
throw JsonParserException("not supported getByte on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Short,调用时抛出 [JsonParserException] */
|
||||
override fun getShort(): Short =
|
||||
throw JsonParserException("not supported getShort on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Int,调用时抛出 [JsonParserException] */
|
||||
override fun getInt(): Int =
|
||||
throw JsonParserException("not supported getInt on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Long,调用时抛出 [JsonParserException] */
|
||||
override fun getLong(): Long =
|
||||
throw JsonParserException("not supported getLong on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Float,调用时抛出 [JsonParserException] */
|
||||
override fun getFloat(): Float =
|
||||
throw JsonParserException("not supported getFloat on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 Double,调用时抛出 [JsonParserException] */
|
||||
override fun getDouble(): Double =
|
||||
throw JsonParserException("not supported getDouble on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 BigInteger,调用时抛出 [JsonParserException] */
|
||||
override fun getBigInteger(): BigInteger =
|
||||
throw JsonParserException("not supported getBigInteger on BaseJsonArrayReader")
|
||||
|
||||
/** 数组读取器不支持直接读取为 BigDecimal,调用时抛出 [JsonParserException] */
|
||||
override fun getBigDecimal(): BigDecimal =
|
||||
throw JsonParserException("not supported getBigDecimal on BaseJsonArrayReader")
|
||||
|
||||
/**
|
||||
* 读取指定索引的对象元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素对应的 JSON 对象读取器
|
||||
*/
|
||||
fun getIndexObject(key: Int): BaseJsonObjectReader
|
||||
/**
|
||||
* 读取指定索引的数组元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素对应的 JSON 数组读取器
|
||||
*/
|
||||
fun getIndexArray(key: Int): BaseJsonArrayReader
|
||||
/**
|
||||
* 读取指定索引的字符串元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的字符串值
|
||||
*/
|
||||
fun getIndexString(key: Int): String
|
||||
/**
|
||||
* 读取指定索引的布尔元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的布尔值
|
||||
*/
|
||||
fun getIndexBoolean(key: Int): Boolean
|
||||
/**
|
||||
* 读取指定索引的 Byte 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Byte 数值
|
||||
*/
|
||||
fun getIndexByte(key: Int): Byte
|
||||
/**
|
||||
* 读取指定索引的 Short 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Short 数值
|
||||
*/
|
||||
fun getIndexShort(key: Int): Short
|
||||
/**
|
||||
* 读取指定索引的 Int 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Int 数值
|
||||
*/
|
||||
fun getIndexInt(key: Int): Int
|
||||
/**
|
||||
* 读取指定索引的 Long 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Long 数值
|
||||
*/
|
||||
fun getIndexLong(key: Int): Long
|
||||
/**
|
||||
* 读取指定索引的 Float 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Float 数值
|
||||
*/
|
||||
fun getIndexFloat(key: Int): Float
|
||||
/**
|
||||
* 读取指定索引的 Double 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 Double 数值
|
||||
*/
|
||||
fun getIndexDouble(key: Int): Double
|
||||
/**
|
||||
* 读取指定索引的 BigInteger 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 BigInteger 数值
|
||||
*/
|
||||
fun getIndexBigInteger(key: Int): BigInteger
|
||||
/**
|
||||
* 读取指定索引的 BigDecimal 数值元素
|
||||
*
|
||||
* @param key 数组索引
|
||||
* @return 元素的 BigDecimal 数值
|
||||
*/
|
||||
fun getIndexBigDecimal(key: Int): BigDecimal
|
||||
}
|
||||
|
||||
@@ -26,57 +26,146 @@ import com.mingliqiye.utils.exception.JsonParserException
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* JSON 对象读取器接口,按字段名读取对象中的各类型值。
|
||||
*
|
||||
* 直接读取当前节点的 getXxx 方法默认抛出 [JsonParserException],应使用 getFieldXxx 系列方法。
|
||||
*/
|
||||
interface BaseJsonObjectReader : BaseJsonReader {
|
||||
override val isObject: Boolean
|
||||
get() = true
|
||||
|
||||
|
||||
/** 对象读取器不支持直接读取为对象,调用时抛出 [JsonParserException] */
|
||||
override fun getObject(): BaseJsonObjectReader =
|
||||
throw JsonParserException("not supported getObject on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为数组,调用时抛出 [JsonParserException] */
|
||||
override fun getArray(): BaseJsonArrayReader =
|
||||
throw JsonParserException("not supported getArray on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为字符串,调用时抛出 [JsonParserException] */
|
||||
override fun getString(): String =
|
||||
throw JsonParserException("not supported getString on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为布尔值,调用时抛出 [JsonParserException] */
|
||||
override fun getBoolean(): Boolean =
|
||||
throw JsonParserException("not supported getBoolean on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Byte,调用时抛出 [JsonParserException] */
|
||||
override fun getByte(): Byte =
|
||||
throw JsonParserException("not supported getByte on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Short,调用时抛出 [JsonParserException] */
|
||||
override fun getShort(): Short =
|
||||
throw JsonParserException("not supported getShort on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Int,调用时抛出 [JsonParserException] */
|
||||
override fun getInt(): Int =
|
||||
throw JsonParserException("not supported getInt on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Long,调用时抛出 [JsonParserException] */
|
||||
override fun getLong(): Long =
|
||||
throw JsonParserException("not supported getLong on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Float,调用时抛出 [JsonParserException] */
|
||||
override fun getFloat(): Float =
|
||||
throw JsonParserException("not supported getFloat on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 Double,调用时抛出 [JsonParserException] */
|
||||
override fun getDouble(): Double =
|
||||
throw JsonParserException("not supported getDouble on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 BigInteger,调用时抛出 [JsonParserException] */
|
||||
override fun getBigInteger(): BigInteger =
|
||||
throw JsonParserException("not supported getBigInteger on BaseJsonObjectReader")
|
||||
|
||||
/** 对象读取器不支持直接读取为 BigDecimal,调用时抛出 [JsonParserException] */
|
||||
override fun getBigDecimal(): BigDecimal =
|
||||
throw JsonParserException("not supported getBigDecimal on BaseJsonObjectReader")
|
||||
|
||||
/**
|
||||
* 读取指定字段的对象值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段对应的 JSON 对象读取器
|
||||
*/
|
||||
fun getFieldObject(key: String): BaseJsonObjectReader
|
||||
/**
|
||||
* 读取指定字段的数组值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段对应的 JSON 数组读取器
|
||||
*/
|
||||
fun getFieldArray(key: String): BaseJsonArrayReader
|
||||
/**
|
||||
* 读取指定字段的字符串值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的字符串值
|
||||
*/
|
||||
fun getFieldString(key: String): String
|
||||
/**
|
||||
* 读取指定字段的布尔值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的布尔值
|
||||
*/
|
||||
fun getFieldBoolean(key: String): Boolean
|
||||
/**
|
||||
* 读取指定字段的 Byte 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Byte 数值
|
||||
*/
|
||||
fun getFieldByte(key: String): Byte
|
||||
/**
|
||||
* 读取指定字段的 Short 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Short 数值
|
||||
*/
|
||||
fun getFieldShort(key: String): Short
|
||||
/**
|
||||
* 读取指定字段的 Int 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Int 数值
|
||||
*/
|
||||
fun getFieldInt(key: String): Int
|
||||
/**
|
||||
* 读取指定字段的 Long 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Long 数值
|
||||
*/
|
||||
fun getFieldLong(key: String): Long
|
||||
/**
|
||||
* 读取指定字段的 Float 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Float 数值
|
||||
*/
|
||||
fun getFieldFloat(key: String): Float
|
||||
/**
|
||||
* 读取指定字段的 Double 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 Double 数值
|
||||
*/
|
||||
fun getFieldDouble(key: String): Double
|
||||
/**
|
||||
* 读取指定字段的 BigInteger 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 BigInteger 数值
|
||||
*/
|
||||
fun getFieldBigInteger(key: String): BigInteger
|
||||
/**
|
||||
* 读取指定字段的 BigDecimal 数值
|
||||
*
|
||||
* @param key 字段名
|
||||
* @return 字段的 BigDecimal 数值
|
||||
*/
|
||||
fun getFieldBigDecimal(key: String): BigDecimal
|
||||
}
|
||||
|
||||
@@ -26,18 +26,81 @@ import com.mingliqiye.utils.json.judgment.base.BaseJsonJudgment
|
||||
import java.math.BigDecimal
|
||||
import java.math.BigInteger
|
||||
|
||||
/**
|
||||
* JSON 读取器基础接口,继承类型判断能力,定义将当前节点读取为各种类型值的方法
|
||||
*/
|
||||
interface BaseJsonReader : BaseJsonJudgment {
|
||||
/**
|
||||
* 将当前节点作为对象读取器返回
|
||||
*
|
||||
* @return JSON 对象读取器
|
||||
*/
|
||||
fun getObject(): BaseJsonObjectReader
|
||||
/**
|
||||
* 将当前节点作为数组读取器返回
|
||||
*
|
||||
* @return JSON 数组读取器
|
||||
*/
|
||||
fun getArray(): BaseJsonArrayReader
|
||||
/**
|
||||
* 读取当前节点的字符串值
|
||||
*
|
||||
* @return 字符串值
|
||||
*/
|
||||
fun getString(): String
|
||||
/**
|
||||
* 读取当前节点的布尔值
|
||||
*
|
||||
* @return 布尔值
|
||||
*/
|
||||
fun getBoolean(): Boolean
|
||||
/**
|
||||
* 读取当前节点的 Byte 数值
|
||||
*
|
||||
* @return Byte 数值
|
||||
*/
|
||||
fun getByte(): Byte
|
||||
/**
|
||||
* 读取当前节点的 Short 数值
|
||||
*
|
||||
* @return Short 数值
|
||||
*/
|
||||
fun getShort(): Short
|
||||
/**
|
||||
* 读取当前节点的 Int 数值
|
||||
*
|
||||
* @return Int 数值
|
||||
*/
|
||||
fun getInt(): Int
|
||||
/**
|
||||
* 读取当前节点的 Long 数值
|
||||
*
|
||||
* @return Long 数值
|
||||
*/
|
||||
fun getLong(): Long
|
||||
/**
|
||||
* 读取当前节点的 Float 数值
|
||||
*
|
||||
* @return Float 数值
|
||||
*/
|
||||
fun getFloat(): Float
|
||||
/**
|
||||
* 读取当前节点的 Double 数值
|
||||
*
|
||||
* @return Double 数值
|
||||
*/
|
||||
fun getDouble(): Double
|
||||
/**
|
||||
* 读取当前节点的 BigInteger 数值
|
||||
*
|
||||
* @return BigInteger 数值
|
||||
*/
|
||||
fun getBigInteger(): BigInteger
|
||||
/**
|
||||
* 读取当前节点的 BigDecimal 数值
|
||||
*
|
||||
* @return BigDecimal 数值
|
||||
*/
|
||||
fun getBigDecimal(): BigDecimal
|
||||
|
||||
}
|
||||
|
||||
@@ -28,6 +28,12 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonObjectWriter
|
||||
import tools.jackson.core.JsonGenerator
|
||||
import tools.jackson.databind.SerializationContext
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonGenerator 的 JSON 数组写入器实现,向数组追加各类型元素
|
||||
*
|
||||
* @param jsonGenerator Jackson3 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文
|
||||
*/
|
||||
class JackSon3ArrayWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializationContext,
|
||||
|
||||
@@ -29,6 +29,12 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonWriter
|
||||
import tools.jackson.core.JsonGenerator
|
||||
import tools.jackson.databind.SerializationContext
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonGenerator 的 JSON 写入器实现,对象/数组写入时自动补全起止标记
|
||||
*
|
||||
* @param jsonGenerator Jackson3 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文
|
||||
*/
|
||||
class JackSon3JsonWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializationContext,
|
||||
|
||||
@@ -28,11 +28,23 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonObjectWriter
|
||||
import tools.jackson.core.JsonGenerator
|
||||
import tools.jackson.databind.SerializationContext
|
||||
|
||||
/**
|
||||
* 基于 Jackson3 JsonGenerator 的 JSON 对象写入器实现,按字段名追加各类型值
|
||||
*
|
||||
* @param jsonGenerator Jackson3 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文
|
||||
*/
|
||||
class JackSon3ObjectWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializationContext,
|
||||
) : BaseJsonObjectWriter {
|
||||
|
||||
/**
|
||||
* 写入字段名
|
||||
*
|
||||
* @param name 字段名
|
||||
* @return 当前 JsonGenerator 实例,便于链式调用
|
||||
*/
|
||||
fun writeName(name: String): JsonGenerator = jsonGenerator.writeName(name)
|
||||
|
||||
override fun addNull(name: String): BaseJsonObjectWriter {
|
||||
|
||||
@@ -28,6 +28,12 @@ import com.mingliqiye.utils.json.converters.base.writeNumber
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonArrayWriter
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonObjectWriter
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonGenerator 的 JSON 数组写入器实现,向数组追加各类型元素
|
||||
*
|
||||
* @param jsonGenerator Jackson2 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文,可为null
|
||||
*/
|
||||
class JackSonArrayWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializerProvider?,
|
||||
|
||||
@@ -29,6 +29,12 @@ import com.mingliqiye.utils.json.witer.base.BaseJsonArrayWriter
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonObjectWriter
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonWriter
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonGenerator 的 JSON 写入器实现,对象/数组写入时自动补全起止标记
|
||||
*
|
||||
* @param jsonGenerator Jackson2 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文,可为null
|
||||
*/
|
||||
class JackSonJsonWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializerProvider?,
|
||||
|
||||
@@ -28,6 +28,12 @@ import com.mingliqiye.utils.json.converters.base.writeNumber
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonArrayWriter
|
||||
import com.mingliqiye.utils.json.witer.base.BaseJsonObjectWriter
|
||||
|
||||
/**
|
||||
* 基于 Jackson2 JsonGenerator 的 JSON 对象写入器实现,按字段名追加各类型值
|
||||
*
|
||||
* @param jsonGenerator Jackson2 的 JSON 生成器
|
||||
* @param serializationContext 序列化上下文,可为null
|
||||
*/
|
||||
class JackSonObjectWriter(
|
||||
private val jsonGenerator: JsonGenerator,
|
||||
private val serializationContext: SerializerProvider?,
|
||||
|
||||
@@ -24,35 +24,99 @@ package com.mingliqiye.utils.json.witer.base
|
||||
|
||||
import com.mingliqiye.utils.exception.JsonFormatException
|
||||
|
||||
/**
|
||||
* JSON 数组写入器接口,向数组中追加各类型元素,支持链式调用。
|
||||
*
|
||||
* 直接设置当前节点的 setXxx 方法默认抛出 [JsonFormatException],应使用 addXxx 系列方法。
|
||||
*/
|
||||
interface BaseJsonArrayWriter : BaseJsonWriter {
|
||||
|
||||
|
||||
/** 数组写入器不支持直接设置为对象,调用时抛出 [JsonFormatException] */
|
||||
override fun setObject(objCall: (BaseJsonObjectWriter) -> BaseJsonObjectWriter) =
|
||||
throw JsonFormatException("setObject is not supported on BaseJsonArrayWriter")
|
||||
|
||||
/** 数组写入器不支持直接设置为数组,调用时抛出 [JsonFormatException] */
|
||||
override fun setArray(arrayCall: (BaseJsonArrayWriter) -> BaseJsonArrayWriter) =
|
||||
throw JsonFormatException("setArray is not supported on BaseJsonArrayWriter")
|
||||
|
||||
/** 数组写入器不支持直接设置为字符串,调用时抛出 [JsonFormatException] */
|
||||
override fun setString(string: String) =
|
||||
throw JsonFormatException("setString is not supported on BaseJsonArrayWriter")
|
||||
|
||||
/** 数组写入器不支持直接设置为数值,调用时抛出 [JsonFormatException] */
|
||||
override fun setNumber(number: Number) =
|
||||
throw JsonFormatException("setNumber is not supported on BaseJsonArrayWriter")
|
||||
|
||||
/** 数组写入器不支持直接设置为布尔值,调用时抛出 [JsonFormatException] */
|
||||
override fun setBoolean(boolean: Boolean) =
|
||||
throw JsonFormatException("setBoolean is not supported on BaseJsonArrayWriter")
|
||||
|
||||
/** 数组写入器不支持直接设置为 null,调用时抛出 [JsonFormatException] */
|
||||
override fun setNull() = throw JsonFormatException("setNull is not supported on BaseJsonArrayWriter")
|
||||
override val isArray
|
||||
get() = true
|
||||
|
||||
/**
|
||||
* 追加 null 元素
|
||||
*
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addNull(): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加字符串元素
|
||||
*
|
||||
* @param value 字符串值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addString(value: String): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加数值元素
|
||||
*
|
||||
* @param value 数值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addNumber(value: Number): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加布尔元素
|
||||
*
|
||||
* @param value 布尔值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addBoolean(value: Boolean): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加对象元素,通过回调填充子对象
|
||||
*
|
||||
* @param value 子对象写入回调
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addObject(value: (BaseJsonObjectWriter) -> Unit): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加数组元素,通过回调填充子数组
|
||||
*
|
||||
* @param value 子数组写入回调
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun addArray(value: (BaseJsonArrayWriter) -> Unit): BaseJsonArrayWriter
|
||||
/**
|
||||
* 追加字符串元素,[addString] 的简写
|
||||
*
|
||||
* @param value 字符串值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun add(value: String): BaseJsonArrayWriter = addString(value)
|
||||
/**
|
||||
* 追加数值元素,[addNumber] 的简写
|
||||
*
|
||||
* @param value 数值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun add(value: Number): BaseJsonArrayWriter = addNumber(value)
|
||||
/**
|
||||
* 追加布尔元素,[addBoolean] 的简写
|
||||
*
|
||||
* @param value 布尔值
|
||||
* @return 当前数组写入器,便于链式调用
|
||||
*/
|
||||
fun add(value: Boolean): BaseJsonArrayWriter = addBoolean(value)
|
||||
}
|
||||
|
||||
@@ -24,36 +24,109 @@ package com.mingliqiye.utils.json.witer.base
|
||||
|
||||
import com.mingliqiye.utils.exception.JsonFormatException
|
||||
|
||||
/**
|
||||
* JSON 对象写入器接口,按字段名向对象中追加各类型值,支持链式调用。
|
||||
*
|
||||
* 直接设置当前节点的 setXxx 方法默认抛出 [JsonFormatException],应使用 addXxx 系列方法。
|
||||
*/
|
||||
interface BaseJsonObjectWriter : BaseJsonWriter {
|
||||
override val isObject: Boolean
|
||||
get() = true
|
||||
|
||||
/** 对象写入器不支持直接设置为对象,调用时抛出 [JsonFormatException] */
|
||||
override fun setObject(objCall: (BaseJsonObjectWriter) -> BaseJsonObjectWriter) =
|
||||
throw JsonFormatException("setObject is not supported on BaseJsonObjectWriter")
|
||||
|
||||
/** 对象写入器不支持直接设置为数组,调用时抛出 [JsonFormatException] */
|
||||
override fun setArray(arrayCall: (BaseJsonArrayWriter) -> BaseJsonArrayWriter) =
|
||||
throw JsonFormatException("setArray is not supported on BaseJsonObjectWriter")
|
||||
|
||||
/** 对象写入器不支持直接设置为字符串,调用时抛出 [JsonFormatException] */
|
||||
override fun setString(string: String) =
|
||||
throw JsonFormatException("setString is not supported on BaseJsonObjectWriter")
|
||||
|
||||
/** 对象写入器不支持直接设置为数值,调用时抛出 [JsonFormatException] */
|
||||
override fun setNumber(number: Number) =
|
||||
throw JsonFormatException("setNumber is not supported on BaseJsonObjectWriter")
|
||||
|
||||
/** 对象写入器不支持直接设置为布尔值,调用时抛出 [JsonFormatException] */
|
||||
override fun setBoolean(boolean: Boolean) =
|
||||
throw JsonFormatException("setBoolean is not supported on BaseJsonObjectWriter")
|
||||
|
||||
/** 对象写入器不支持直接设置为 null,调用时抛出 [JsonFormatException] */
|
||||
override fun setNull() = throw JsonFormatException("setNull is not supported on BaseJsonObjectWriter")
|
||||
/**
|
||||
* 追加值为 null 的字段
|
||||
*
|
||||
* @param name 字段名
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addNull(name: String): BaseJsonObjectWriter
|
||||
|
||||
/**
|
||||
* 追加字符串字段
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 字符串值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addString(name: String, value: String): BaseJsonObjectWriter
|
||||
/**
|
||||
* 追加数值字段
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 数值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addNumber(name: String, value: Number): BaseJsonObjectWriter
|
||||
/**
|
||||
* 追加布尔字段
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 布尔值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addBoolean(name: String, value: Boolean): BaseJsonObjectWriter
|
||||
/**
|
||||
* 追加对象字段,通过回调填充子对象
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param valueCaller 子对象写入回调
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addObject(name: String, valueCaller: (BaseJsonObjectWriter) -> Unit): BaseJsonObjectWriter
|
||||
|
||||
/**
|
||||
* 追加数组字段,通过回调填充数组元素
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param valueCaller 数组写入回调
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun addArray(name: String, valueCaller: (BaseJsonArrayWriter) -> Unit): BaseJsonObjectWriter
|
||||
/**
|
||||
* 追加字符串字段,[addString] 的简写
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 字符串值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun add(name: String, value: String): BaseJsonObjectWriter = addString(name, value)
|
||||
/**
|
||||
* 追加数值字段,[addNumber] 的简写
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 数值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun add(name: String, value: Number): BaseJsonObjectWriter = addNumber(name, value)
|
||||
/**
|
||||
* 追加布尔字段,[addBoolean] 的简写
|
||||
*
|
||||
* @param name 字段名
|
||||
* @param value 布尔值
|
||||
* @return 当前对象写入器,便于链式调用
|
||||
*/
|
||||
fun add(name: String, value: Boolean): BaseJsonObjectWriter = addBoolean(name, value)
|
||||
|
||||
}
|
||||
|
||||
@@ -25,11 +25,42 @@ package com.mingliqiye.utils.json.witer.base
|
||||
import com.mingliqiye.utils.json.judgment.BaseJsonJudgment
|
||||
|
||||
|
||||
/**
|
||||
* JSON 写入器基础接口,继承类型判断能力,定义将当前节点写为各种类型值的方法
|
||||
*/
|
||||
interface BaseJsonWriter : BaseJsonJudgment {
|
||||
/**
|
||||
* 写入一个 JSON 对象,通过回调填充对象字段
|
||||
*
|
||||
* @param objCall 对象写入回调,接收对象写入器并返回它
|
||||
*/
|
||||
fun setObject(objCall: (BaseJsonObjectWriter) -> BaseJsonObjectWriter)
|
||||
/**
|
||||
* 写入一个 JSON 数组,通过回调填充数组元素
|
||||
*
|
||||
* @param arrayCall 数组写入回调,接收数组写入器并返回它
|
||||
*/
|
||||
fun setArray(arrayCall: (BaseJsonArrayWriter) -> BaseJsonArrayWriter)
|
||||
/**
|
||||
* 写入字符串值
|
||||
*
|
||||
* @param string 待写入的字符串
|
||||
*/
|
||||
fun setString(string: String)
|
||||
/**
|
||||
* 写入数值
|
||||
*
|
||||
* @param number 待写入的数值
|
||||
*/
|
||||
fun setNumber(number: Number)
|
||||
/**
|
||||
* 写入布尔值
|
||||
*
|
||||
* @param boolean 待写入的布尔值
|
||||
*/
|
||||
fun setBoolean(boolean: Boolean)
|
||||
/**
|
||||
* 写入 null 值
|
||||
*/
|
||||
fun setNull()
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user