如何使用 Moshi 实现混合固定与动态字段的 JSON 反序列化-java教程-PHP中文网

如何使用 Moshi 实现混合固定与动态字段的 JSON 反序列化

本文详解如何在 Moshi 中为含固定字段（如 attributes）和任意额外字段的 JSON 设计自定义适配器，将动态属性统一捕获到 Map 中，弥补 Moshi 缺乏 @JsonAnySetter 的限制。

本文详解如何在 moshi 中为含固定字段（如 `attributes`）和任意额外字段的 json 设计自定义适配器，将动态属性统一捕获到 `map` 中，弥补 moshi 缺乏 `@jsonanysetter` 的限制。

Moshi 本身不提供类似 Jackson 的 @JsonAnySetter 注解，但可通过编写手动 JSON 读写适配器（Custom Adapter） 精确控制反序列化逻辑，完美支持“部分结构化 + 部分动态”的混合 JSON 场景。核心思路是：在 @FromJson 方法中遍历 JSON 对象的每个键值对，显式识别已知字段（如 "attributes"），其余键值对则动态注入 Map<string any></string>。

以下是一个健壮、类型安全且可双向序列化的完整实现：

Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式，用于飞书日历导入导出及数据集成。

下载

✅ 定义数据类（保持简洁，无需特殊注解）

@JsonClass(generateAdapter = true)
data class Body(
  val records: List<record>
)

@JsonClass(generateAdapter = true)
data class Record(
  val attributes: Attributes,
  val recordBody: Map<string any>
)

@JsonClass(generateAdapter = true)
data class Attributes(
  val type: String,
  val url: String
)</string></record>

✅ 编写自定义 `Record` 适配器（关键！）

object RecordAdapter {
  private val options = JsonReader.Options.of("attributes")

  @FromJson
  fun fromJson(
    reader: JsonReader,
    attributesAdapter: JsonAdapter<attributes>
  ): Record {
    reader.beginObject()
    var attributes: Attributes? = null
    val recordBody = mutableMapOf<string any>()

    while (reader.hasNext()) {
      when (reader.selectName(options)) {
        0 -> { // 匹配 "attributes"
          if (attributes != null) throw JsonDataException("Duplicate 'attributes' field")
          attributes = attributesAdapter.fromJson(reader) ?: throw JsonDataException("'attributes' cannot be null")
        }
        -1 -> { // 未匹配任何已知名 → 动态字段
          val key = reader.nextName()
          val value = reader.readJsonValue() ?: throw JsonDataException("Unexpected null value for key '$key'")
          recordBody[key] = value
        }
        else -> throw AssertionError("Unexpected option index")
      }
    }
    reader.endObject()

    return Record(attributes!!, recordBody)
  }

  @ToJson
  fun toJson(
    writer: JsonWriter,
    value: Record,
    attributesAdapter: JsonAdapter<attributes>,
    dynamicAdapter: JsonAdapter<any>
  ) {
    writer.beginObject()
    writer.name("attributes")
    attributesAdapter.toJson(writer, value.attributes)
    value.recordBody.entries.forEach { (key, v) ->
      writer.name(key)
      dynamicAdapter.toJson(writer, v)
    }
    writer.endObject()
  }
}</any></attributes></string></attributes>

✅ 注册并使用适配器

val moshi = Moshi.Builder()
  .add(RecordAdapter) // 注册自定义适配器
  .build()

val bodyAdapter = moshi.adapter(Body::class.java)

// 示例 JSON（含固定 attributes + 动态 Id/Name/...）
val json = """{
  "records": [{
    "attributes": {"type": "Account", "url": "/services/data/v58.0/sobjects/Account/001..."},
    "Id": "001...",
    "Name": "Acme Corp",
    "Industry": "Technology",
    "AnnualRevenue": 150000000
  }]
}"""

val body = bodyAdapter.fromJson(json)
println(body.records.first().recordBody["Name"]) // 输出: Acme Corp
println(bodyAdapter.toJson(body)) // 正确还原原始结构

⚠️ 注意事项与最佳实践

readJsonValue() 是关键：它能递归解析任意嵌套的 JSON 值（对象、数组、字符串、数字、布尔、null），确保 Map<string any></string> 中的值类型与原始 JSON 一致。
selectName() 提升性能与健壮性：相比 nextName() + 字符串匹配，selectName() 使用预编译的选项列表，避免拼写错误且更高效；返回 -1 表示未命中，即动态字段。
双向支持需显式传入适配器：@ToJson 方法签名中必须声明 JsonAdapter<any></any>（Moshi 内置支持），否则无法序列化 Any 类型值。
空值与重复字段校验：示例中加入了 attributes 重复检测和非空校验，生产环境建议增强异常信息以利调试。
泛型适配器扩展性：若需复用该模式于其他类，可将 Record 抽象为泛型模板，或封装为 DynamicFieldAdapter<t></t> 工具类。